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

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

대규상위 조직에서는 도움이 필요할 때 연락할 대상이나 위치에 대한 정보를 가지고 있는 것이 유용합니다. GitLab /help 페이지에 이 정보를 사용자 정의하여 표시할 수 있습니다.

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

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

  1. 왼쪽 사이드바에서 맨 아래에서 관리 영역을 선택합니다.
  2. 설정 > 기본 설정을 선택합니다.
  3. 도움말 페이지를 확장합니다.
  4. 도움말 페이지에 표시할 추가 텍스트란에 /help에 표시할 정보를 입력합니다.
  5. 변경 사항 저장을 선택합니다.

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

note
기본적으로 /help은 인증되지 않은 사용자에게 표시됩니다. 하지만, 공개 가시성 수준 이 제한된 경우, /help은 인증된 사용자에게만 표시됩니다.

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

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

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

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

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

  1. 왼쪽 사이드바에서 맨 아래에서 관리 영역을 선택합니다.
  2. 설정 > 기본 설정을 선택합니다.
  3. 도움말 페이지를 확장합니다.
  4. 도움말 페이지에서 마케팅 관련 항목 숨기기 확인란을 선택합니다.
  5. 변경 사항 저장을 선택합니다.

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

사용자가:

  • 도움말 > 지원을 선택합니다.
  • 도움말 페이지에서 웹 사이트에서 도움말 보기를 선택합니다.

할 때 사용자를 이동시킬 사용자 정의 URL을 지정할 수 있습니다.

  1. 왼쪽 사이드바에서 맨 아래에서 관리 영역을 선택합니다.
  2. 설정 > 기본 설정을 선택합니다.
  3. 도움말 페이지를 확장합니다.
  4. 지원 페이지 URL 필드에 URL을 입력합니다.
  5. 변경 사항 저장을 선택합니다.

/help 페이지 리디렉션

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

  1. 왼쪽 사이드바에서 맨 아래에서 관리 영역을 선택합니다.
  2. 설정 > 기본 설정을 선택합니다.
  3. 도움말 페이지를 확장합니다.
  4. 문서 페이지 URL 필드에 URL을 입력합니다.
  5. 변경 사항 저장을 선택합니다.

문서 페이지 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.