高级贡献
本页面假设您了解如何贡献新内容以及审查其他人的工作,并准备好学习更多贡献方式。您需要使用 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 起草的功能文档。
- 合并与发布版本相关的拉取请求,并维护发布版本的功能分支。
- 指导其他希望学习如何在未来担任此角色的 SIG Docs 贡献者。这被称为“影子”。
- 在发布版本工件时发布与发布版本相关的文档更改。
协调发布版本通常需要 3-4 个月的承诺,并且职责在 SIG Docs 批准者之间轮换。
担任新贡献者大使
SIG Docs 批准者可以担任新贡献者大使。
新贡献者大使欢迎 SIG-Docs 的新贡献者,向新贡献者推荐 PR,并指导新贡献者完成他们的前几个 PR 提交。
新贡献者大使的职责包括:
- 监控 #sig-docs Slack 频道,解答新贡献者提出的问题。
- 与 PR 管理员合作,为新贡献者确定适合新手的问题。
- 指导新贡献者完成他们对文档仓库的前几个 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 社区直接或通过延迟共识的批准。
- 承诺每周至少投入 5 个小时(通常更多)到该角色,至少持续 6 个月
职责
联合主席的角色是服务:联合主席培养贡献者能力、处理流程和策略、安排和运行会议、安排 PR 管理员、在 Kubernetes 社区中倡导文档、确保文档在 Kubernetes 发布周期中取得成功,并使 SIG Docs 专注于有效的优先事项。
职责包括:
- 通过优秀的文档保持 SIG Docs 专注于最大限度地提高开发人员的满意度
- 以身作则社区行为准则,并让 SIG 成员对其负责
- 通过更新贡献指南来学习并制定 SIG 的最佳实践
- 安排和运行 SIG 会议:每周状态更新、季度回顾/计划会议以及其他需要的会议
- 在 KubeCon 活动和其他会议上安排和运行文档冲刺
- 与 CNCF 及其白金合作伙伴(包括 Google、Oracle、Azure、IBM 和华为)一起招募和倡导 SIG Docs
- 保持 SIG 顺利运行
高效地运行会议
为了安排和运行有效的会议,这些指南展示了做什么、怎么做以及为什么。
坚持社区行为准则:
- 使用尊重和包容的语言进行尊重和包容的讨论。
设定明确的议程:
- 设定明确的议题
- 提前发布议程
对于每周会议,将前一周的记录复制粘贴到记录的“以往会议”部分
合作编写准确的记录:
- 记录会议的讨论
- 考虑委派记录员的角色
清晰准确地分配行动项目:
- 记录行动项目、负责人员和预计完成日期
根据需要进行主持:
- 如果讨论偏离议程,将参与者重新集中到当前主题上
- 为不同的讨论风格留出空间,同时保持讨论的重点并尊重大家的时间
尊重大家的时间:
准时开始和结束会议。
有效地使用 Zoom:
- 熟悉Kubernetes 的 Zoom 指南
- 登录时输入主持人密钥以声明主持人角色
在 Zoom 上录制会议
当您准备好开始录制时,单击“录制到云端”。
当您准备好停止录制时,单击“停止”。
视频会自动上传到 YouTube。