高级贡献

本页面假定您了解如何贡献新内容评审他人的工作,并且准备好学习更多贡献方式。其中一些任务需要使用 Git 命令行客户端及其他工具。

提出改进建议

SIG Docs 成员可以提出改进建议。

在您为 Kubernetes 文档贡献了一段时间后,可能会对改进风格指南内容指南、用于构建文档的工具链、网站风格、评审和合入拉取请求的流程或文档的其他方面产生想法。为了最大程度地提高透明度,此类提案需要在 SIG Docs 会议或 kubernetes-sig-docs 邮件列表上进行讨论。此外,在提出全面修改之前,了解现有工作方式以及过去做出决策的原因也会有所帮助。获取有关文档当前工作方式的问题答案的最快方法是在 kubernetes.slack.com 上的 #sig-docs Slack 频道中提问。

讨论完成后,如果 SIG 就期望的结果达成一致,您可以按照最合适的方式对提议的更改进行工作。例如,更新风格指南或网站功能可能需要开启拉取请求,而与文档测试相关的更改可能需要与 sig-testing 合作。

协调 Kubernetes 发布版本的文档

SIG Docs 批准者可以协调 Kubernetes 发布版本的文档。

每个 Kubernetes 发布版本由参与 sig-release 特殊兴趣小组 (SIG) 的团队进行协调。特定发布版本的发布团队成员还包括一名总体发布负责人,以及来自 sig-testing 和其他 SIG 的代表。要了解有关 Kubernetes 发布流程的更多信息,请参阅 https://github.com/kubernetes/sig-release

特定发布版本的 SIG Docs 代表负责协调以下任务:

  • 监视特性跟踪电子表格,关注对文档有影响的新特性或变更特性。如果某个特性的文档在发布时未准备就绪,则该特性可能不允许进入发布版本。
  • 定期参加 sig-release 会议,并汇报发布版本文档的状态。
  • 评审和校对负责实现该特性的 SIG 起草的特性文档。
  • 合并与发布版本相关的拉取请求,并维护发布版本的 Git 特性分支。
  • 指导其他希望将来学习如何担任此角色的 SIG Docs 贡献者。这被称为“影子学习 (shadowing)”。
  • 在发布工件发布时,同步发布与该发布版本相关的文档变更。

协调发布版本通常需要投入 3-4 个月的时间,此职责在 SIG Docs 批准者之间轮换。

担任新贡献者大使

SIG Docs 批准者可以担任新贡献者大使。

新贡献者大使欢迎新贡献者加入 SIG-Docs,为新贡献者推荐 PR,并指导新贡献者完成前几次 PR 提交。

新贡献者大使的职责包括:

  • 监视 #sig-docs Slack 频道中来自新贡献者的问题。
  • 与 PR 管理者合作,为新贡献者识别容易上手的入门级 Issue
  • 指导新贡献者完成他们向 docs 库提交的前几个 PR。
  • 帮助新贡献者创建他们成为 Kubernetes 成员所需的更复杂的 PR。
  • 在贡献者成为 Kubernetes 成员的道路上为其提供担保
  • 每月主持会议,为新贡献者提供帮助和指导。

当前的新贡献者大使会在每次 SIG-Docs 会议上以及 Kubernetes #sig-docs 频道中宣布。

SIG Docs 评审者可以担保新贡献者。

新贡献者成功向一个或多个 Kubernetes 仓库提交 5 个具有实质性内容的拉取请求后,即可申请加入 Kubernetes 组织成为成员。贡献者的成员申请需要由两位已经是评审者的担保人支持。

新的文档贡献者可以在 Kubernetes Slack 实例上的 #sig-docs 频道或在 SIG Docs 邮件列表中询问以请求担保人。如果您对申请人的工作感到满意,可以自愿担保他们。当他们提交成员申请时,请回复申请并附带 "+1",同时详细说明您认为申请人适合加入 Kubernetes 组织的原因。

担任 SIG 联合主席

SIG Docs 成员可以担任一届 SIG Docs 的联合主席。

前提条件

Kubernetes 成员必须满足以下要求才能成为联合主席:

  • 了解 SIG Docs 工作流程和工具:Git、Hugo、本地化、博客子项目。
  • 了解其他 Kubernetes SIG 和仓库如何影响 SIG Docs 工作流程,包括:k/org 中的团队k/community 中的流程k/test-infra 中的插件,以及SIG Architecture 的作用。此外,了解Kubernetes 文档发布流程是如何运作的。
  • 经 SIG Docs 社区直接批准或通过惰性一致性(lazy consensus)批准。
  • 每周至少投入 5 小时(通常更多)用于此角色,至少持续 6 个月。

职责

联合主席的角色是服务性的:联合主席负责培养贡献者能力,处理流程和政策,安排和主持会议,安排 PR 管理者,在 Kubernetes 社区中为文档发声,确保文档在 Kubernetes 发布周期中取得成功,并使 SIG Docs 专注于有效优先事项。

职责包括:

  • 通过优秀的文档使 SIG Docs 专注于最大化开发人员的幸福感。
  • 践行社区行为准则,并要求 SIG 成员遵守。
  • 通过更新贡献指南,学习并为 SIG 设定最佳实践。
  • 安排和主持 SIG 会议:每周状态更新、季度回顾/规划会议以及其他需要的会议。
  • 在 KubeCon 活动及其他会议中安排和举办文档冲刺活动。
  • 为 SIG Docs 在 CNCF 及其白金合作伙伴(包括 Google、Oracle、Azure、IBM 和华为)中进行招聘和宣传。
  • 保持 SIG 平稳运行。

如何高效召开会议

这些指南说明了如何安排和高效召开会议,包括做什么、怎么做以及为什么。

维护社区行为准则:

  • 以尊重和包容的语言进行尊重和包容的讨论。

设定清晰的议程:

  • 设定清晰的主题议程。
  • 提前发布议程。

对于每周会议,将前一周的会议记录复制粘贴到当前会议记录的“过往会议 (Past meetings)”部分。

协作记录准确的会议纪要:

  • 记录会议讨论内容。
  • 考虑将记录员的角色委派给他人。

清晰准确地分配行动项:

  • 记录行动项、负责人员以及预期的完成日期。

必要时进行主持:

  • 如果讨论偏离议程,将参与者重新引导回当前主题。
  • 在保持讨论聚焦和尊重大家时间的同时,为不同的讨论风格留出空间。

尊重大家的时间:

按时开始和结束会议。

高效使用 Zoom:

Claiming the host role in Zoom

在 Zoom 上录制会议

准备开始录制时,点击“录制到云端 (Record to Cloud)”。

准备停止录制时,点击“停止 (Stop)”。

视频会自动上传到 YouTube。

SIG 联合主席离任(荣休)

参见:k/community/sig-docs/offboarding.md

最后修改于 2023 年 1 月 9 日 下午 11:42 PST:Jim Angel 荣休 (5b44de3dd1)