도움말 페이지 메시지 사용자 정의

Tier: Free, Premium, Ultimate Offering: Self-managed

대규모 조직에서는 도움을 받을 수 있는 연락처나 장소에 대한 정보가 유용합니다. 이 정보를 GitLab /help 페이지에 사용자 정의하고 표시할 수 있습니다.

도움말 페이지에 도움 메시지 추가

GitLab /help 페이지 상단에 표시되는 도움 메시지를 추가할 수 있습니다 (예:
https://gitlab.com/help):

  1. 왼쪽 사이드바 하단에서 Admin을 선택합니다.
  2. Settings > Preferences를 선택합니다.
  3. Help page를 확장합니다.
  4. Additional text to show on the Help page에서 /help에 표시할 정보를 입력합니다.
  5. Save changes를 선택합니다.

이제 /help에서 메시지를 볼 수 있습니다.

note
기본적으로 /help는 인증되지 않은 사용자에게 표시됩니다. 그러나
Public 가시성 수준이 제한되면, /help는 인증된 사용자만 볼 수 있습니다.

로그인 페이지에 도움 메시지 추가

  • 로그인 페이지에 표시될 추가 텍스트는 GitLab 17.0에서 deprecated되었습니다.

로그인 페이지에 도움 메시지를 추가하려면,
로그인 및 등록 페이지를 사용자 정의하세요.

도움말 페이지에서 마케팅 관련 항목 숨기기

GitLab 마케팅 관련 항목이 가끔 도움말 페이지에 표시됩니다. 이러한 항목을 숨기려면:

  1. 왼쪽 사이드바 하단에서 Admin을 선택합니다.
  2. Settings > Preferences를 선택합니다.
  3. Help page를 확장합니다.
  4. Hide marketing-related entries from the Help page 체크박스를 선택합니다.
  5. Save changes를 선택합니다.

사용자 정의 지원 페이지 URL 설정

사용자가 다음을 선택할 때 리디렉션될 사용자 정의 URL을 지정할 수 있습니다:

  • Help > Support 선택 시.
  • 도움말 페이지에서 See our website for help 선택 시.
  1. 왼쪽 사이드바 하단에서 Admin을 선택합니다.
  2. Settings > Preferences를 선택합니다.
  3. Help page를 확장합니다.
  4. Support page URL 필드에 URL을 입력합니다.
  5. Save changes를 선택합니다.

/help 페이지 리디렉션

모든 /help 링크를 필요한 요구 사항을 충족하는 대상으로 리디렉션할 수 있습니다.

  1. 왼쪽 사이드바 하단에서 Admin을 선택합니다.
  2. Settings > Preferences를 선택합니다.
  3. Help page를 확장합니다.
  4. Documentation pages URL 필드에 URL을 입력합니다.
  5. Save changes를 선택합니다.

Documentation pages URL 필드가 비어 있으면, GitLab 인스턴스는 GitLab의 doc 디렉토리에서 가져온 기본 버전의 문서를 표시합니다.

대상 요구 사항

/help를 리디렉션할 때 GitLab은:

  • 요청을 지정된 URL로 리디렉션합니다.
  • URL에 ee 및 버전 번호를 포함하는 문서 경로를 추가합니다.
  • URL에 .html을 추가하고, 필요에 따라 .md를 제거합니다.

예를 들어, URL이 https://docs.gitlab.com으로 설정되면,
/help/administration/settings/help_page.md에 대한 요청은 다음으로 리디렉션됩니다:
https://docs.gitlab.com/${VERSION}/ee/administration/settings/help_page.html.