参与 SIG Docs

SIG Docs 是 Kubernetes 项目中的众多特别兴趣小组之一，专注于编写、更新和维护整个 Kubernetes 的文档。有关 SIG 的更多信息，请参阅社区 GitHub 存储库中的 SIG Docs。

SIG Docs 欢迎所有贡献者的内容和审查。任何人都可以发起拉取请求 (PR)，也欢迎任何人针对内容提交问题或评论正在进行的拉取请求。

您还可以成为成员、审查人或审批人。这些角色需要更大的权限，并承担批准和提交更改的某些责任。有关 Kubernetes 社区中成员资格如何运作的更多信息，请参阅社区成员资格。

本文档的其余部分概述了这些角色在 SIG Docs 中运作的一些独特方式，SIG Docs 负责维护 Kubernetes 最面向公众的方面之一——Kubernetes 网站和文档。

SIG Docs 主席

每个 SIG（包括 SIG Docs）都会选择一名或多名 SIG 成员担任主席。他们是 SIG Docs 与 Kubernetes 组织其他部门之间的联络点。他们需要全面了解 Kubernetes 项目的结构以及 SIG Docs 在其中的运作方式。有关主席的当前列表，请参阅领导层。

SIG Docs 中的自动化依赖于两种不同的机制：GitHub 团队和 OWNERS 文件。

GitHub 上有两类 SIG Docs 团队

每个团队都可以在 GitHub 评论中使用其 @name 来引用，以便与该组中的每个人进行沟通。

有时，Prow 和 GitHub 团队会重叠，但并不完全匹配。为了分配问题、拉取请求以及支持 PR 审批，自动化使用 OWNERS 文件中的信息。

Kubernetes 项目使用名为 prow 的自动化工具来处理与 GitHub 问题和拉取请求相关的自动化。 Kubernetes 网站存储库使用两个prow 插件

这两个插件使用 kubernetes/website GitHub 存储库顶层的OWNERS和OWNERS_ALIASES文件来控制 prow 在存储库中的工作方式。

OWNERS 文件包含 SIG Docs 审查人和审批人的列表。OWNERS 文件也可以存在于子目录中，并且可以覆盖谁可以充当该子目录及其后代文件中文件的审查人或审批人。有关 OWNERS 文件的更多信息，请参阅OWNERS。

此外，单个 Markdown 文件可以在其前言中列出审查人和审批人，方法是列出各个 GitHub 用户名或 GitHub 组。

OWNERS 文件和 Markdown 文件前言的组合决定了 PR 所有者从自动化系统获得的有关应该向谁寻求其 PR 的技术和编辑审查的建议。

当拉取请求合并到用于发布内容的分支时，该内容将发布到https://kubernetes.ac.cn。为了确保我们发布的内容质量高，我们将合并拉取请求的权限限制为 SIG Docs 审批人。以下是它的工作原理。

当拉取请求同时具有 lgtm 和 approve 标签、没有 hold 标签并且所有测试都通过时，该拉取请求将自动合并。
Kubernetes 组织成员和 SIG Docs 审批人可以通过添加评论来阻止自动合并给定的拉取请求（通过添加 /hold 评论或拒绝提供 /lgtm 评论）。
任何 Kubernetes 成员都可以通过添加 /lgtm 评论来添加 lgtm 标签。
只有 SIG Docs 审批人可以通过添加 /approve 评论来合并拉取请求。一些审批人还会执行其他特定角色，例如PR 管理员或SIG Docs 主席。

有关为 Kubernetes 文档做贡献的更多信息，请参阅