도움말 및 로그인 페이지 메시지 사용자 정의

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

대규모 기관에서는 도움을 요청할 대상이나 방법에 대한 정보를 가지고 있는 것이 유용합니다. GitLab /help 페이지 및 GitLab 로그인 페이지에 이 정보를 사용자 정의하여 표시할 수 있습니다.

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

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

  1. 왼쪽 사이드바에서 가장 아래쪽에 있는 관리 영역(Admin Area)을 선택합니다.
  2. 설정(Preferences) > 기본 설정(Settings)을 선택합니다.
  3. 로그인 및 도움말 페이지(Sign-in and Help page)를 확장합니다.
  4. 도움말 페이지에 표시할 추가 텍스트(Additional text to show on the Help page)에서 /help에 표시할 정보를 입력합니다.
  5. 변경 사항 저장(Save changes)을 선택합니다.

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

note
기본적으로 /help은 인증되지 않은 사용자에게 보입니다. 그러나 공개(퍼블릭) 가시성 수준이 제한되면 /help은 인증된 사용자에게만 보입니다.

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

GitLab 로그인 페이지에 표시되는 도움말 메시지를 추가할 수 있습니다. 이 메시지는 로그인 페이지에 나타납니다:

  1. 왼쪽 사이드바에서 가장 아래쪽에 있는 관리 영역(Admin Area)을 선택합니다.
  2. 설정(Preferences) > 기본 설정(Settings)을 선택합니다.
  3. 로그인 및 도움말 페이지(Sign-in and Help page)를 확장합니다.
  4. 로그인 페이지에 표시할 추가 텍스트(Additional text to show on the sign-in page)에서 표시할 정보를 입력합니다.
  5. 변경 사항 저장(Save changes)을 선택합니다.

이제 로그인 페이지에서 메시지를 확인할 수 있습니다.

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

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

  1. 왼쪽 사이드바에서 가장 아래쪽에 있는 관리 영역(Admin Area)을 선택합니다.
  2. 설정(Preferences) > 기본 설정(Settings)을 선택합니다.
  3. 로그인 및 도움말 페이지(Sign-in and Help page)를 확장합니다.
  4. 도움말 페이지에서 마케팅 관련 항목 숨기기(Hide marketing-related entries from the Help page) 확인란을 선택합니다.
  5. 변경 사항 저장(Save changes)을 선택합니다.

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

사용자가 다음을 진행할 때 사용자 정의 URL을 지정할 수 있습니다:

  • 도움말 > 지원(사용자 지원) 선택.
  • 도움말 페이지의 웹사이트에서 도움을 찾아보세요(See our website for help) 선택.
  1. 왼쪽 사이드바에서 가장 아래쪽에 있는 관리 영역(Admin Area)을 선택합니다.
  2. 설정(Preferences) > 기본 설정(Settings)을 선택합니다.
  3. 로그인 및 도움말 페이지(Sign-in and Help page)를 확장합니다.
  4. 지원 페이지 URL(Support page URL) 필드에 URL을 입력합니다.
  5. 변경 사항 저장(Save changes)을 선택합니다.

/help 페이지 리디렉션

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

  1. 왼쪽 사이드바에서 가장 아래쪽에 있는 관리 영역(Admin Area)을 선택합니다.
  2. 설정(Preferences) > 기본 설정(Settings)을 선택합니다.
  3. 로그인 및 도움말 페이지(Sign-in and Help page)를 확장합니다.
  4. Documentation pages URL 필드에 URL을 입력합니다.
  5. 변경 사항 저장(Save changes)을 선택합니다.

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

대상 요구 사항

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

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

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