SIG Docs 是 Kubernetes 项目中的特别兴趣小组 (SIG) 之一,专注于编写、更新和维护 Kubernetes 的整体文档。有关该 SIG 的更多信息,请参阅 社区 GitHub 仓库中的 SIG Docs 页面。
SIG Docs 欢迎所有贡献者提供内容并参与评审。任何人都可以提交拉取请求 (PR),也欢迎大家针对内容提交议题 (issue) 或对进行中的拉取请求发表评论。
你还可以成为成员 (member)、评审者 (reviewer) 或批准者 (approver)。这些角色需要更高的访问权限,并承担批准和提交更改的特定职责。有关 Kubernetes 社区成员资格运作方式的更多信息,请参阅 社区成员资格 (community-membership)。
本文件的其余部分概述了这些角色在 SIG Docs 中的一些独特运作方式,SIG Docs 负责维护 Kubernetes 最面向公众的资产之一——Kubernetes 网站和文档。
每个 SIG(包括 SIG Docs)都会推选出一名或多名 SIG 成员担任主席。他们是 SIG Docs 与 Kubernetes 组织其他部分之间的联络点。他们需要对整个 Kubernetes 项目的结构以及 SIG Docs 在其中的运作方式有深入的了解。请参阅 领导层 (Leadership) 获取当前主席列表。
SIG Docs 的自动化依赖于两种不同的机制:GitHub 团队和 OWNERS 文件。
GitHub 上有两类 SIG Docs 团队
@sig-docs-{language}-owners 是批准者和负责人@sig-docs-{language}-reviews 是评审者每个人都可以在 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 文件可以在其 front-matter 中列出评审者和批准者,既可以列出个人 GitHub 用户名,也可以列出 GitHub 组名。
OWNERS 文件和 Markdown 文件中 front-matter 的组合决定了 PR 所有者从自动化系统处获得的关于向谁寻求技术和编辑审查的建议。
当拉取请求合并到用于发布内容的分支时,该内容会发布到 https://kubernetes.ac.cn。为了确保发布内容的高质量,我们限制仅由 SIG Docs 批准者合并拉取请求。运作方式如下。
lgtm 和 approve 标签,没有 hold 标签,并且所有测试都通过时,该拉取请求会自动合并。/hold 评论或不提交 /lgtm 评论)。/lgtm 评论来添加 lgtm 标签。/approve 评论来合并拉取请求。一些批准者还担任其他特定角色,例如 PR 管理员 (PR Wrangler) 或 SIG Docs 主席。要了解更多关于参与 SIG Docs 的信息,请参阅
有关为 Kubernetes 文档做出贡献的更多信息,请参阅