参与 SIG Docs

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

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

你也可以成为成员、审阅者或审批者。这些角色需要更高的访问权限，并承担批准和提交更改的特定职责。有关 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 评论中可以使用其 @名称 来引用每个团队，以便与该组中的所有人沟通。

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

Kubernetes 项目使用一个名为 prow 的自动化工具，用于处理与 GitHub issue 和拉取请求相关的自动化。此Kubernetes 网站仓库使用两个prow 插件：

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

OWNERS 文件包含 SIG Docs 审阅者和审批者列表。OWNERS 文件也可以存在于子目录中，并可以覆盖在该子目录及其后代目录中谁可以作为文件的审阅者或审批者。有关 OWNERS 文件的一般信息，请参阅OWNERS。

此外，单个 Markdown 文件可以在其 Front-matter 中列出审阅者和审批者，可以通过列出单个 GitHub 用户名或 GitHub 组来实现。

OWNERS 文件和 Markdown 文件中 Front-matter 的结合决定了自动化系统会向 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 文档的更多信息，请参阅：