高级贡献
本页面假设您了解如何贡献新内容以及审查他人的工作,并已准备好了解有关更多贡献方式的知识。您需要使用 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 架构的角色。此外,了解Kubernetes 文档发布流程的工作原理。
- 获得 SIG Docs 社区直接或通过惰性共识批准。
- 至少每周承诺 5 个小时(通常更多)的时间担任此角色,至少 6 个月。
职责
联席主席的角色是服务:联席主席建立贡献者能力,处理流程和政策,安排和主持会议,安排 PR 管理员,在 Kubernetes 社区中倡导文档,确保文档在 Kubernetes 发布周期中取得成功,并让 SIG Docs 专注于有效的优先级。
职责包括
- 让 SIG Docs 专注于通过优秀的文档最大程度地提高开发人员的满意度
- 成为社区行为准则的典范,并让 SIG 成员对其负责
- 通过更新贡献指南,了解和设置 SIG 的最佳实践
- 安排和主持 SIG 会议:每周状态更新、每季度回顾/计划会议,以及其他需要进行的会议
- 在 KubeCon 活动和其他会议上安排和主持文档冲刺
- 招募并代表 SIG Docs 向CNCF及其白金合作伙伴进行宣传,包括 Google、Oracle、Azure、IBM 和华为
- 确保 SIG 顺利运行
主持有效的会议
为了安排和主持有效的会议,以下指南介绍了该怎么做、如何做以及为什么要做。
维护社区行为准则:
- 使用尊重的、包容的语言,进行尊重、包容的讨论。
设定明确的议程:
- 设定明确的主题议程
- 提前发布议程
对于每周会议,请将上一周的笔记复制粘贴到笔记的“过去会议”部分
协作编写准确的笔记:
- 记录会议讨论
- 考虑委托记录员的角色
清晰准确地分配行动项目:
- 记录行动项目、分配给谁以及预期的完成日期
根据需要进行调节:
- 如果讨论偏离议程,请将参与者重新集中到当前主题
- 为不同的讨论风格腾出空间,同时保持讨论的重点并尊重人们的时间
尊重人们的时间:
准时开始和结束会议。
有效使用 Zoom:
- 熟悉Kubernetes 的 Zoom 指南
- 通过输入主持人密钥,在登录时申请主持人角色
在 Zoom 上录制会议
准备好开始录制时,单击“录制到云”。
准备好停止录制时,单击“停止”。
视频会自动上传到 YouTube。