如何更新极狐GitLab 文档

任何人都可以为极狐GitLab 文档做出贡献！您可以在以下情况下创建文档合并请求：

  • 您在现有文档中发现错误或其他改进空间。
  • 您希望翻译尚未翻译的文档，可以帮助极狐GitLab 用户或管理员完成他们的工作。

如何更新文档

如果您不是极狐GitLab 团队成员，或者没有相关仓库的开发人员角色，要更新极狐GitLab 文档：

  1. 访问极狐GitLab 仓库。
  2. 在右上角，选择 派生，制作仓库的副本。
  3. 在您的派生项目中，通过转至 \jh\doc 目录找到文档页面。
  4. 如果您了解 Git，请进行更改并打开合并请求。 如果没有，请按照以下步骤操作：
    1. 在右上角，选择 编辑，进行更改，然后 保存。
    2. 从左侧菜单中，选择 合并请求。
    3. 对于源分支，选择您的派生项目和分支。如果您没有创建分支，请选择 main-jh。 对于目标分支，选择极狐GitLab 仓库的 main-jh 分支。
    4. 对于提交消息，不要以句点结尾。
    5. 选择 提交更改，合并请求开放。
    6. 选择 文档 模板。在描述中，写下更改的简短摘要和相关议题的链接（如果有）。

如果您在页面上工作时需要帮助，请查看翻译前必读。

寻求帮助

如果您有以下情况，请向 Technical Writer 团队寻求帮助：

  • 需要帮助选择正确的文档位置。
  • 想要讨论翻译想法。
  • 需要其它帮助。

如果需要紧急帮助，请直接在议题或合并请求中指派 Technical Writer。如果需要非紧急帮助，请在议题或合并请求中 ping Technical Writer。

审核和合并

任何对相关项目具有维护者角色的人都可以合并文档更改。维护者必须努力确保内容：

  • 清晰且足够容易让目标受众访问并理解。
  • 符合相关规范和指南

该过程涉及以下步骤：

  • 第一审核人。由代码审核人或其他合适的同事进行审核，以确保准确性、清晰度和完整性。对于没有实质性内容更改的小修复，可以跳过此步骤。
  • Technical Writer（可选）。如果在合并合并请求前未完成审核，则必须安排在合并后。 仅在需要紧急合并时才安排合并后审核。请求一个：
    • 合并前审核，将 MR 指派给 Technical Writer。
    • 合并后审核，查看合并后审核文档。
  • 维护者。对于合并请求，维护者：
    • 可以随时要求上述任何审核。
    • 在 Technical Writer 审核之前或之后进行审核。

合并后审核

如果在合并之前没有指派给 Technical Writer 进行审核，则必须由开发人员或维护人员在合并后立即安排审核。为此，使用 Doc Review 描述模板 创建一个议题，并链接引入了文档更改的且已合并的合并请求。

请记住：

  • 在极狐GitLab，我们像对待代码一样对待文档。与代码一样，必须审核文档以确保质量。
  • 如果尽快合并同一 MR 的代码很重要，您可以请求合并后由 Technical Writer 审核文档。在这种情况下，原始 MR 的作者可以在后续 MR 中解决 Technical Writer 提供的反馈。
  • Technical Writer 还可以帮助决定，是否可以在没有审核的情况下合并文档，审核将在合并后不久进行。