ヘルプページのメッセージをカスタマイズします

大規模な組織では、誰に連絡を取るべきか、またはどこにヘルプを求めるべきかについての情報があると便利です。この情報は、GitLab /helpページでカスタマイズして表示できます。

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

ヘルプメッセージを追加できます。これは、GitLab /helpページの上部に表示されます（例: https://gitlab.com/help）:

1. 左側のサイドバーの下部で、管理者を選択します。
2. 設定 > 設定を選択します。
3. ヘルプページを展開します。
4. ヘルプページに表示する追加テキストに、/helpに表示する情報を入力します。
5. 変更を保存を選択します。

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

サインインページにヘルプメッセージを追加します

サインインページにヘルプメッセージを追加するには、サインインページと登録ページをカスタマイズします。

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

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

1. 左側のサイドバーの下部で、管理者を選択します。
2. 設定 > 設定を選択します。
3. ヘルプページを展開します。
4. ヘルプページからマーケティング関連のエントリを非表示にするチェックボックスを選択します。
5. 変更を保存を選択します。

カスタムサポートページURLを設定する

ユーザーが次の操作を行うときにリダイレクトされるカスタムURLを指定できます:

• ヘルプ > サポートを選択します。
• ヘルプページでヘルプが必要な場合はGitLabウェブサイトを参照してくださいを選択します。

1. 左側のサイドバーの下部で、管理者を選択します。
2. 設定 > 設定を選択します。
3. ヘルプページを展開します。
4. サポートページURLフィールドに、URLを入力します。
5. 変更を保存を選択します。

/helpページをリダイレクトする

すべての/helpリンクを、必要な要件を満たす宛先にリダイレクトできます。

1. 左側のサイドバーの下部で、管理者を選択します。
2. 設定 > 設定を選択します。
3. ヘルプページを展開します。
4. ドキュメントページのURLフィールドに、URLを入力します。
5. 変更を保存を選択します。

ドキュメントページのURLフィールドが空の場合、GitLabインスタンスには、GitLabのdocディレクトリからリクエストされたドキュメントの基本バージョンが表示されます。

リダイレクト先の要件

/helpをリダイレクトする場合、GitLab:

• 指定されたURLを、リダイレクトのベースURLとして使用します。
• 次の方法で完全なURLを構築します:
  • バージョン番号（${VERSION}）を追加します。
  • ドキュメントパスを追加します。
  • すべての.mdファイルGo言語拡張子を削除します。

たとえば、URLがhttps://docs.gitlab.comに設定されている場合、/help/administration/settings/help_page.mdのリクエストはhttps://docs.gitlab.com/${VERSION}/administration/settings/help_pageにリダイレクトされます。