Help us learn about your current experience with the documentation. Take the survey.

自定义帮助页面消息

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

对于大型组织而言，提供联系人或寻求帮助的途径信息会非常有用。您可以在 GitLab 的 /help 页面上自定义并显示这些信息。

向帮助页面添加帮助消息

您可以添加一条帮助消息，该消息将显示在 GitLab /help 页面的顶部（例如 https://gitlab.com/help）：

  1. 在左侧边栏的底部，选择 管理员。
  2. 选择 Settings > Preferences。
  3. 展开 Help page。
  4. 在 Additional text to show on the Help page 字段中，输入您希望在 /help 上显示的信息。
  5. 选择 Save changes。

现在，您可以在 /help 页面上看到该消息。

默认情况下，/help 页面对所有未登录用户可见。但是，如果限制了 Public 可见性级别，那么 /help 页面将仅对已登录用户可见。

向登录页面添加帮助消息

要向登录页面添加帮助消息，请自定义您的登录和注册页面。

从帮助页面隐藏营销相关条目

GitLab 的营销相关条目偶尔会显示在帮助页面上。要隐藏这些条目：

  1. 在左侧边栏的底部，选择 管理员。
  2. 选择 Settings > Preferences。
  3. 展开 Help page。
  4. 勾选 Hide marketing-related entries from the Help page 复选框。
  5. 选择 Save changes。

设置自定义支持页面 URL

您可以指定一个自定义 URL，当用户执行以下操作时，系统会将其重定向到该 URL：

  • 选择 Help > Support。
  • 在帮助页面上选择 See our website for help。
  1. 在左侧边栏的底部，选择 管理员。
  2. 选择 Settings > Preferences。
  3. 展开 Help page。
  4. 在 Support page URL 字段中，输入 URL。
  5. 选择 Save changes。

重定向 /help 页面

您可以将所有 /help 链接重定向到满足必要要求的目标地址。

  1. 在左侧边栏的底部，选择 管理员。
  2. 选择 Settings > Preferences。
  3. 展开 Help page。
  4. 在 Documentation pages URL 字段中，输入 URL。
  5. 选择 Save changes。

如果 Documentation pages URL 字段为空，GitLab 实例将显示一个基础版本的文档，该文档源自 GitLab 的 doc 目录。

目标地址要求

当重定向 /help 时，GitLab 会：

  • 将指定的 URL 用作重定向的基础 URL。
  • 通过以下方式构建完整的 URL：
    • 添加版本号 (${VERSION})。
    • 添加文档路径。
    • 移除所有 .md 文件扩展名。

例如，如果 URL 设置为 https://docs.gitlab.com，那么对 /help/administration/settings/help_page.md 的请求将被重定向到： https://docs.gitlab.com/${VERSION}/administration/settings/help_page。