文档网站架构

docs-gitlab-com 项目托管了用于生成 GitLab 文档网站的代码库，并部署到 https://docs.gitlab.com。它使用 Hugo 静态网站生成器。

更多信息，请参阅 文档网站架构 页面。

源文件

文档源文件与产品代码位于同一个代码库中。

文档相关的问题和合并请求都属于各自的代码库，并都带有 Documentation 标签。

发布

GitLab、GitLab Runner、GitLab Operator、Omnibus GitLab 和 Charts 的文档都发布到 https://docs.gitlab.com。

相同的文档也包含在应用程序中。要查看产品内帮助，请访问 URL 并在末尾添加 /help。 仅包含当前版本和版本的帮助信息。

其他版本的文档可在 https://docs.gitlab.com/archives/ 获取。

更新旧版本

如果需要为已发布的 GitLab 版本添加或编辑文档，请遵循 补丁发布运行手册。

其他代码库中的文档

如果您在 主要代码库 之外的代码库中拥有代码和文档，您应该将文档与代码保存在该代码库中。

然后您可以使用以下方法之一：

• 推荐。将代码库添加到产品列表 中，这些产品发布在 https://docs.gitlab.com。文档页面的源文件保留在外部代码库中，但生成的页面会在 https://docs.gitlab.com 上被索引和搜索。
• 推荐。在 https://docs.gitlab.com 的全局导航中添加一个条目， 直接链接到该外部代码库中的文档。文档页面不会在 https://docs.gitlab.com 上被索引或搜索。
• 在 gitlab 代码库中为产品创建一个着陆页，并将着陆页添加到全局导航中， 但将其余文档保留在外部代码库中。着陆页会在 https://docs.gitlab.com 上被索引和搜索，但其余文档不会。 例如，VS Code 的 GitLab Workflow 扩展。 我们不鼓励使用包含链接列表的页面， 因此只有在推荐选项不可行时才使用此选项。

其他语言的文档

GitLab 文档的翻译通过半自主流程完成。 英文文件 是权威源文件，翻译文件位于 doc-locale 或类似目录下的语言特定子目录中。例如，日语翻译位于 /doc-locale/ja-jp/。

doc/development 或类似目录下的开发文档不会被翻译。

您只需贡献英文源文件即可。翻译文件由自动化工具更新。

月度发布流程（版本）

文档网站支持版本，每个月我们都会将最新版本添加到列表中。 更多信息，请阅读 月度发布流程。

Danger Bot

GitLab 使用 Danger 来自动化代码审查流程。 当 /doc 中的文档文件在合并请求中被修改时， Danger Bot 会自动添加与文档相关的指导评论。 此自动化配置在 Dangerfile 中。

请求文档调查横幅

为了触及更广泛的受众，您可以请求 一个调查横幅。

任何时候只能存在一个横幅。优先级根据谁先请求横幅来决定。

要请求调查横幅：

1. 在 docs-gitlab-com 项目中打开一个问题， 并使用"调查横幅请求"模板。
2. 在问题描述中填写详细信息。
3. 创建问题，技术写作团队的人员会处理您的请求。
4. 当您不再需要横幅时，@ 提名给该问题的人员并要求他们移除它。