高级贡献

本页面假设您已了解如何为新内容做贡献以及评审他人工作,并已准备好学习更多贡献方式。您需要使用 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 贡献者,让他们了解未来如何承担此角色。这被称为“影子”。
  • 在发布相关文档更改时,在发布构件发布后将其一同发布。

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

担任新贡献者大使

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

新贡献者大使欢迎新贡献者加入 SIG-Docs,为新贡献者推荐 PR,并指导新贡献者完成他们的第一个 PR 提交。

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

  • 监控 #sig-docs Slack 频道,解答新贡献者的问题。
  • 与 PR 协调员合作,为新贡献者识别“好开始”议题
  • 指导新贡献者完成他们向 docs 仓库提交的第一个 PR。
  • 帮助新贡献者创建更复杂的 PR,以成为 Kubernetes 成员。
  • 赞助贡献者,帮助他们成为 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 社区批准,可以直接批准或通过懒惰共识。
  • 每周至少投入 5 小时(通常更多)到该角色,任期至少 6 个月。

职责

联合主席的角色是服务性的:联合主席要培养贡献者能力,处理流程和政策,安排和运行会议,安排 PR 协调员,在 Kubernetes 社区中倡导文档工作,确保文档在 Kubernetes 版本周期中取得成功,并使 SIG Docs 专注于有效的优先级。

职责包括:

  • 保持 SIG Docs 专注于通过出色的文档来最大化开发者满意度。
  • 以身作则遵守社区行为准则,并让 SIG 成员对其负责。
  • 通过更新贡献指南来学习并制定 SIG 的最佳实践。
  • 安排和运行 SIG 会议:每周状态更新、季度回顾/规划会议以及根据需要召开的其他会议。
  • 在 KubeCon 和其他会议上安排和运行文档冲刺活动。
  • CNCF及其顶级合作伙伴(包括 Google、Oracle、Azure、IBM 和华为)招募并代表 SIG Docs 发声。
  • 确保 SIG 顺利运行。

运行有效的会议

要安排和运行有效的会议,以下指南将展示如何做、怎么做以及为什么这么做。

遵守社区行为准则:

  • 进行尊重、包容的讨论,使用尊重、包容的语言。

设定清晰的议程:

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

对于每周会议,将上一周的会议记录复制粘贴到笔记的“过往会议”部分。

协作进行准确的会议记录。:

  • 记录会议的讨论内容。
  • 考虑委托记录员的角色。

清晰准确地分配行动项。:

  • 记录行动项、分配给谁以及预期的完成日期。

视情况进行主持。:

  • 如果讨论偏离了议程,将参与者重新聚焦到当前议题上。
  • 为不同的讨论风格留出空间,同时保持讨论的焦点并尊重大家的时间。

尊重大家的时间。:

准时开始和结束会议。

有效使用 Zoom。:

Claiming the host role in Zoom

在 Zoom 上录制会议。

当您准备好开始录制时,点击“录制到云端”。

当您准备好停止录制时,点击“停止”。

视频会自动上传到 YouTube。

SIG 联合主席的卸任 (名誉)

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

最后修改于 2023 年 1 月 9 日太平洋标准时间上午 11:42:Jim Angel 成为名誉成员 (5b44de3dd1)