聚焦 SIG 文档

简介

官方文档是任何开源项目的首选资源。对于 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 官方博客推送和审查内容，以及与每个周期的发布团队合作，以审查文档和博客。

Docs 下有两个子项目：博客和本地化。社区从中受益了吗？您想强调这些团队的一些有趣贡献吗？

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

本地化：通过这个子项目，Kubernetes 社区已经能够在用户和贡献者中实现更大的包容性和多样性。这也有助于项目获得更多贡献者，特别是学生，自几年前以来。主要的亮点和即将到来的本地化是印地语和孟加拉语。目前，印度学生正在带头进行印地语本地化工作。

除此之外，还有另外两个子项目：reference-docs 和 website，后者是用 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 这样的大型项目更容易解析和导航。

您如何帮助新的贡献者入门？加入是否有任何先决条件？

开始为 Docs 做贡献没有任何先决条件。但是，肯定有一份很棒的“文档贡献指南”，它始终保持最新和相关性，并敦促新贡献者阅读并随身携带。此外，社区 Slack 频道 #sig-docs 中有很多有用的置顶和书签。kubernetes/website 存储库中带有“新手友好”标签的 GitHub 问题是创建您的第一个 PR 的好地方。现在，SIG Docs 每月第一个星期二都会举办一次新的贡献者见面会，并由新的贡献者大使角色的第一位担任者 Arsh Sharma 参加。这有助于在 SIG 内为新贡献者建立一个更容易访问的联系点。

您对 SIG 的哪些成就感到非常自豪？

DM & RL：鉴于来自不同国家的贡献者所做的所有伟大工作，最近几个月本地化子项目的正式化是 SIG Docs 的一大胜利。此前，本地化工作没有任何简化的流程，重点是通过在过去几个月里起草一份 KEP 来为本地化提供结构，使其正式成为一个子项目，该计划计划在第三季度末完成。

DM：另一个取得巨大成功的领域是新的贡献者大使角色，它有助于为新贡献者加入该项目建立一个更容易访问的联系点。

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

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

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

总结

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

• ←上一篇
下一篇→