这篇文章已超过一年。较旧的文章可能包含过时的内容。请检查页面中的信息自发布以来是否仍然正确。

聚焦 SIG 文档

由 Purneswar Prasad 撰写 | 2022 年 8 月 2 日星期二

介绍

官方文档是任何开源项目的首选资源。对于 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.io 上 Kubernetes 项目文档的特别兴趣小组，它生成 Kubernetes API、kubeadm 和 kubectl 的参考指南，并维护官方网站的基础设施和分析。其工作范围还包括文档发布、文档翻译、改进和向现有文档添加新功能、推送和审查官方 Kubernetes 博客的内容，并与每个发布周期的发布团队合作审查文档和博客。

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

博客：此子项目重点介绍新的或已正式发布的 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 网站更新。这也帮助新贡献者了解弃用情况，以便如果出现任何 good-first-issue，他们可以参与进来。一个专门的 Slack 频道被用来沟通会议更新、征集反馈或就未解决的问题和 PR 寻求帮助。1.24 版本发布后，每周会议也持续了一个月，用于审查相关问题并解决它们。特别感谢 Celeste Horgan，她在整个弃用过程中持续推动了这一讨论。

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

Kubernetes 是一个庞大的项目，对于许多人来说，刚开始时可能会感到望而却步，难以找到入门之处。任何开源项目都由其文档质量来定义，SIG Docs 旨在成为一个热情、乐于助人的地方，帮助新贡献者入门。加入 SIG Docs 的好处是既可以参与项目文档工作，也可以通过阅读文档学习。他们还可以带来自己的新视角来创建和改进文档。长期来看，如果他们坚持在 SIG Docs 工作，他们可以逐步晋升为维护者。这将有助于使像 Kubernetes 这样的大型项目更容易理解和导航。

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

参与文档贡献没有任何先决条件。但确实有一份很棒的贡献文档指南，我们始终保持其最新和相关，强烈建议新贡献者阅读并随时参考。此外，在社区 Slack 频道 #sig-docs 中有很多有用的置顶和书签。在 kubernetes/website 仓库中标记为 good-first-issue 的 GitHub 问题是创建您的第一个 PR 的好地方。现在，SIG Docs 每月在第一个星期二都会举办新贡献者见面会，由新贡献者大使角色的首任者 Arsh Sharma 主持。这使得新贡献者更容易在 SIG 内部找到联系点。

DM 和 RL：过去几个月里，本地化子项目的正式化是 SIG Docs 的一大成就，这得益于来自不同国家的贡献者们付出的巨大努力。之前，本地化工作缺乏流程，重点是构建一个框架，过去几个月起草了一份 KEP，以便将本地化正式化为一个子项目，计划在第三季度末完成。

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

NV：在每个发布周期中，SIG Docs 都需要在很短的时间内审查发布文档和重点介绍发布更新的功能博客。这对文档和博客审阅者来说总是巨大的工作量。

未来 SIG Docs 有什么令人兴奋的新进展想让社区知道吗？

SIG Docs 正在期待制定路线图，建立稳定的贡献者渠道来推动文档改进，并简化社区参与问题分类和 PR 审查的流程。为了建立这样的贡献者和审查者基础，正在设立一个导师计划，帮助现有贡献者成为审查者。这绝对是一个值得关注的领域！

总结

SIG Docs 在 KubeCon + CloudNativeCon 北美 2021 期间举办了一场深度探讨，介绍了他们很棒的 SIG。他们非常欢迎新人，并且是许多希望为项目贡献的新人进入 Kubernetes 的起点。参加 SIG 的会议，了解最新的研究成果、他们来年的计划，以及如何作为贡献者参与上游 Docs 团队！