为 GitLab 文档做贡献

GitLab 文档是配置、使用和排查 GitLab 问题信息的唯一真实来源（SSoT）。 欢迎所有人参与 GitLab 文档的贡献。

以下说明适用于社区贡献者。

更新文档

先决条件：

• 申请访问 GitLab 社区 fork。 社区 fork 是主 GitLab 仓库的共享副本。 当您提出申请时，会被要求回答几个问题。请告知您有兴趣为 GitLab 文档做贡献。

要更新文档：

1. 在 GitLab 社区 fork 中，转到 /doc 目录。
2. 找到您要更新的文档页面。如果您不确定页面位置， 请查看 https://docs.gitlab.com 上该页面的 URL。 路径会列在那里。
3. 在右上角，选择 编辑 > 编辑单个文件。
4. 进行您的更新。
5. 完成后，在提交信息文本框中输入提交信息。 使用 3-5 个单词，首字母大写，不要以句号结尾。
6. 选择提交更改。
7. 会打开一个新的合并请求。
8. 在新建合并请求页面，选择文档模板并选择应用模板。
9. 在描述中，简要总结更改内容，如果有相关问题，请链接到该问题。
10. 选择创建合并请求。

创建合并请求后，请注意查看来自 GitLab Bot 的消息。该消息包含在您准备好进行审查时需要做什么的说明。

可以做什么工作

您不需要问题来更新文档，但如果您正在寻找可以处理的开放性问题， 查看专门为新贡献者整理的文档问题列表。

当您找到想要处理的问题时：

• 如果问题已分配给某人，请选择其他问题。

• 如果问题未分配，请添加评论并请求处理该问题。对于黑客松，使用 @docs-hackathon。否则使用 @gl-docsteam。例如：

  @docs-hackathon 我想要处理这个问题

您可以尝试安装并运行 Vale linting 工具 并修复产生的问题。

已翻译的文档

为了让 GitLab 文档在全球范围内更易于使用，我们计划将产品文档 翻译成其他语言并发布。

文件结构 和初始翻译已经创建，但此项目尚未完成。

在翻译文档正式公开发布后，我们将分享如何帮助我们改进翻译的详细信息。 但在这项工作进行期间，我们无法接受对任何产品文档翻译的贡献。

此外，只有本地化团队成员可以更改本地化相关文件。

寻求帮助

如果您需要以下帮助，请向技术写作团队寻求帮助：

• 需要帮助选择文档的正确位置。
• 想讨论文档想法或大纲。
• 想请求其他任何帮助。

要找到可以帮助您的人：

1. 找到相关 DevOps 阶段组 的技术文档作者。
2. 选择以下任一方式：
   • 如果需要紧急帮助，直接在问题或合并请求中分配技术文档作者。
   • 如果需要非紧急帮助，在问题或合并请求中提及技术文档作者。

如果您是 GitLab Slack 工作区的成员，可以在 #docs 频道请求帮助。

从自己的 fork 编辑文档

如果您已经有自己的 GitLab 仓库 fork，可以使用它， 而不是使用 GitLab 社区 fork。

1. 在 https://docs.gitlab.com 上，滚动到您要编辑的页面底部。
2. 选择查看页面源。
3. 在右上角，选择编辑 > 编辑单个文件。
4. 进行您的更新。
5. 完成后，在提交信息文本框中输入提交信息。 使用 3-5 个单词，首字母大写，不要以句号结尾。
6. 选择提交更改。
7. 记下您的分支名称，然后选择提交更改。

更改已添加到您的 fork 仓库中，位于上一步记下的名称的分支中。

现在，创建一个合并请求。这个合并请求是将您的分支更改 合并到 GitLab master 分支的方式。

1. 在左侧边栏，选择代码 > 合并请求。
2. 选择新建合并请求。
3. 对于源分支，选择您的 fork 和分支。
4. 对于目标分支，选择 GitLab 仓库 的 master 分支。
5. 选择比较分支并继续。会打开一个新的合并请求。
6. 在新建合并请求页面，选择文档模板并选择应用模板。
7. 在描述中，简要总结更改内容，如果有相关问题，请链接到该问题。
8. 选择创建合并请求。

创建合并请求后，请注意查看来自 GitLab Bot 的消息。该消息包含在您准备好进行审查时需要做什么的说明。