ヘルプとサインインページのメッセージのカスタマイズ

大きな組織では、誰に連絡すればいいか、どこにヘルプを求めればいいかという情報があると便利です。GitLab/help ページやGitLabサインインページでは、これらの情報をカスタマイズして表示することができます。

ヘルプページにヘルプメッセージを追加

GitLab/help ページの一番上に表示されるヘルプメッセージを追加することができます（例えば、https://gitlab.com/help ）：

  1. 左のサイドバーで、Search を選択するか、次のページに進んでください。
  2. Admin Areaを選択します。
  3. 設定] > [環境設定]を選択します。
  4. サインインとヘルプページを展開します。
  5. ヘルプページに表示する追加テキスト] に、/help に表示する情報を入力します。
  6. 変更を保存を選択します。

/help にメッセージが表示されます。

note
デフォルトでは、/help 認証されていないユーザーにも表示さ /helpれます。ただし、/help 公開レベルが制限されて /helpいる場合は、認証されたユーザーにのみ表示されます。

サインインページへのヘルプメッセージの追加

GitLab サインインページに表示されるヘルプメッセージを追加することができます。メッセージはサインインページに表示されます：

  1. 左のサイドバーで、Search を選択するか、次のページに進んでください。
  2. Admin Areaを選択します。
  3. 設定] > [環境設定]を選択します。
  4. サインインとヘルプページを展開します。
  5. サインインページに表示する追加テキスト]に、サインインページに表示する情報を入力します。
  6. 変更を保存を選択します。

サインインページにメッセージが表示されます。

ヘルプページからマーケティング関連のエントリを非表示にします。

GitLabマーケティング関連のエントリがヘルプページに表示されることがあります。これらのエントリーを非表示にするには

  1. 左のサイドバーで、Search を選択するか、次のページに進んでください。
  2. Admin Areaを選択します。
  3. 設定] > [環境設定]を選択します。
  4. サインインとヘルプページを展開します。
  5. ヘルプページからマーケティング関連のエントリを隠す] チェックボックスを選択します。
  6. 変更を保存を選択します。

カスタムサポートページURLの設定

ユーザーがサポートページにアクセスする際のカスタムURLを指定できます：

  • ヘルプ]ドロップダウンリストから[サポート]を選択します。
  • ヘルプページで「ヘルプは当社ウェブサイトを参照」を選択します。
  1. 左のサイドバーで、Search を選択するか、次のページに進んでください。
  2. Admin Areaを選択します。
  3. 設定] > [環境設定]を選択します。
  4. サインインとヘルプページを展開します。
  5. サポートページの URL] フィールドに URL を入力します。
  6. 変更を保存を選択します。

/help ページをリダイレクトします。

全ての/help リンクを、必要な要件を満たすリンク先にリダイレクトすることができます。

  1. 左のサイドバーで、Search を選択するか、次のページに進んでください。
  2. Admin Areaを選択します。
  3. 設定] > [環境設定]を選択します。
  4. サインインとヘルプページを展開します。
  5. Documentation pages URL] フィールドに URL を入力します。
  6. 変更を保存を選択します。

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.