本文发表于一年多前。旧文章可能包含过时内容。请检查页面中的信息自发布以来是否已变得不正确。

聚焦 SIG Docs

作者：Purneswar Prasad |

引言

官方文档是任何开源项目的首选资源。对于 Kubernetes 来说，它是一个不断发展的特殊兴趣小组（SIG），人们不断努力使项目细节更容易被新的贡献者和用户理解。SIG Docs 在 kubernetes.io 上发布官方文档，其中包括但不限于核心 API、核心架构细节以及 Kubernetes 版本随附的 CLI 工具的文档。

为了更多地了解 SIG Docs 的工作及其在塑造社区方面的未来，我总结了与联合主席 Divya Mohan (DM)、Rey Lejano (RL) 和 Natali Vlatko (NV) 的对话，他们介绍了 SIG 的目标以及贡献者可以如何提供帮助。

对话摘要

您能简单介绍一下 SIG Docs 的职责吗？

SIG Docs 是 Kubernetes 项目在 kubernetes.io 上的文档特殊兴趣小组，负责生成 Kubernetes API、kubeadm 和 kubectl 的参考指南，并维护官方网站的基础设施和分析。他们的工作范围还包括文档发布、文档翻译、改进和向现有文档添加新功能、推动和审查官方 Kubernetes 博客的内容，以及与每个发布周期的发布团队合作，审查文档和博客。

文档下有两个子项目：博客和本地化。社区是如何从中受益的，这些团队是否有您想重点介绍的有趣贡献？

博客：这个子项目重点介绍新的或已毕业的 Kubernetes 增强功能、社区报告、SIG 更新或任何与 Kubernetes 社区相关的新闻，例如思想领导力、教程和项目更新，例如 Dockershim 的移除和 PodSecurityPolicy 的移除，后者将在 1.25 版本中推出。Tim Bannister 是 SIG Docs 的技术负责人之一，他做出了出色的工作，是推动贡献到文档和博客的主要力量。

本地化：通过这个子项目，Kubernetes 社区在用户和贡献者之间实现了更大的包容性和多样性。这也帮助该项目在几年前获得了更多贡献者，尤其是学生。主要的亮点和新兴的本地化是印地语和孟加拉语。印地语本地化的工作目前由印度的学生牵头。

除此之外，还有另外两个子项目：参考文档和网站，该网站使用 Hugo 构建，是一个重要的所有权领域。

最近，关于最新 1.24 版本中移除 dockershim 的消息在 Kubernetes 生态系统和业界引起了广泛关注。SIG Docs 如何帮助该项目确保最终用户之间的平稳过渡？

记录 Dockershim 的移除是一项艰巨的任务，需要修改现有文档并与各个利益相关者沟通弃用工作。这需要社区的共同努力，因此在 1.24 版本发布之前，SIG Docs 与文档和通信部门、发布团队的发布负责人以及 CNCF 合作，共同宣传。每周会议和 GitHub 项目板被建立起来，以跟踪进展、审查问题、批准 PR 并保持 Kubernetes 网站的更新。这也有助于新贡献者了解弃用情况，以便如果有任何“良好开端问题”出现，他们可以参与进来。一个专门的 Slack 频道用于沟通会议更新、征求反馈或寻求对未解决问题和 PR 的帮助。每周会议在 1.24 版本发布后也持续了一个月，以审查相关问题并进行修复。非常感谢 Celeste Horgan，她在整个弃用过程中保持了这次对话的持续进行。

为什么新的和现有的贡献者应该考虑加入这个 SIG？

Kubernetes 是一个庞大的项目，对于很多人来说，一开始可能会感到不知所措，不知道从何开始。任何开源项目都由其文档质量定义，SIG Docs 旨在成为新贡献者入职的友好、有帮助的地方。人们可以获得使用项目文档的额外好处，并通过阅读文档来学习。他们还可以带来自己新的视角来创建和改进文档。长远来看，如果他们坚持 SIG Docs，他们可以晋升为维护者。这将有助于使 Kubernetes 这样一个大型项目更容易解析和导航。

您如何帮助新贡献者入门？加入有什么先决条件吗？

对文档的贡献没有先决条件。但肯定有一个很棒的《文档贡献指南》，它始终保持更新和相关，鼓励新贡献者阅读并随身携带。此外，在社区 Slack 频道 #sig-docs 中有很多有用的置顶和书签。kubernetes/website 仓库中带有 good-first-issue 标签的 GitHub issue 是创建您的第一个 PR 的好地方。现在，SIG Docs 每月第一个星期二都会举办一次新贡献者见面会，由首位新贡献者大使 Arsh Sharma 主持。这有助于为 SIG 内的新贡献者提供更便捷的联系点。

DM & RL：在过去几个月里，本地化子项目的正式化是 SIG Docs 的一个巨大胜利，这得益于来自不同国家的贡献者所做的出色工作。早期的本地化工作没有一个流线型的流程，重点是通过在过去几个月里起草一个 KEP 来为本地化提供一个结构，使其正式化为一个子项目，计划在第三季度末推出。

DM：另一个取得巨大成功的领域是新贡献者大使的角色，这有助于为新贡献者加入项目提供一个更容易接触到的联系点。

NV：在每个发布周期中，SIG Docs 都必须在短时间内审查发布文档和突出发布更新的功能博客。这对文档和博客审阅者来说始终是一项巨大的努力。

对于 SIG Docs 的未来，有什么令人兴奋的事情想让社区知道吗？

SIG Docs 正在期待制定路线图，建立一个稳定的团队，能够推动文档改进，并简化社区在问题分类和 PR 审查方面的参与。为了建立这样一个贡献者和审查者基础，正在建立一个指导计划，以帮助当前的贡献者成为审查者。这绝对是一个值得关注的领域！

总结

SIG Docs 在 2021 年北美 KubeCon + CloudNativeCon 期间举办了一场深度探讨，介绍了他们出色的 SIG。他们非常热情，是许多希望为 Kubernetes 项目做出贡献的新手的起点。加入 SIG 会议，了解最新的研究成果、他们未来一年的计划，以及如何作为贡献者加入上游文档团队！