高级贡献
本页面假设您了解如何贡献新内容和审查他人的工作,并准备好学习更多贡献方式。您需要使用 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 管理员合作,为新贡献者确定良好的入门问题。
- 指导新贡献者完成他们对文档仓库的前几个 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。