为极狐GitLab 文档做贡献 - GitLab

极狐GitLab 文档是配置、使用和排查极狐GitLab 问题的唯一可信来源（SSoT）。欢迎每个人为极狐GitLab 文档做出贡献。

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

更新文档#

前提条件：

开始你的贡献者入门以获取社区复刻的访问权限。社区复刻是主极狐GitLab 仓库的共享副本。当你发起请求时，会被要求回答几个问题。请让他们知道你有兴趣为极狐GitLab 文档做出贡献。

要更新文档：

在极狐GitLab 社区复刻中，转到 /doc 目录。
找到你想更新的文档页面。如果你不确定页面在哪里，可以查看 https://gitlab.cn/docs 上页面的 URL。路径会列在那里。

或者，如果你已经在想更新的文档页面上，滚动到底部，在页脚中选择 查看页面源代码。此链接会直接带你到源文件。
在右上角，选择编辑 > 编辑单个文件。
进行你的更新。
完成后，在 提交信息 文本框中输入提交信息。使用 3-5 个词，第一个词首字母大写，并且不要以句点结束短语。
选择 提交更改。
一个新的合并请求会打开。
在 新建合并请求 页面上，选择文档模板并选择 应用模板。
在描述中，简要总结更改内容，并链接到相关议题（如果有的话）。
选择 创建合并请求。

创建合并请求后，留意来自 GitLab Bot 的消息。这条消息包含了准备好接受审查时该做什么的说明。

你不需要一个议题来更新文档。你可以尝试安装并运行 Vale linting 工具，并修复发现的问题。

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

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

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

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

如果你遇到以下情况，可以向技术文档工程师团队寻求帮助：

要找到能帮助你的人：

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

如果你已经有自己的极狐GitLab 仓库复刻，可以使用它，而不必使用极狐GitLab 社区复刻。

这些更改会被添加到你的复刻仓库中，位于最后一步记下的分支里。

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