为 K8s 文档出一份力

Kubernetes 欢迎来自所有贡献者的改进，无论你是新人和有经验的贡献者！

本网站由 Kubernetes SIG Docs（文档特别兴趣小组）维护。

Kubernetes 文档项目的贡献者：

• 改进现有内容
• 创建新内容
• 翻译文档
• 管理并发布 Kubernetes 周期性发行版的文档

入门

任何人都可以提出文档方面的问题（issue），或贡献一个变更，用拉取请求（PR）的方式提交到 GitHub 上的 kubernetes/website 仓库。 当然你需要熟练使用 git 和 GitHub 才能在 Kubernetes 社区中有效工作。

如何参与文档编制：

1. 签署 CNCF 的贡献者许可协议。
2. 熟悉文档仓库和网站的静态站点生成器。
3. 确保理解发起 PR 和审查变更的基本流程。

图 1. 新手入门指示。

图 1 概述了新贡献者的路线图。 你可以遵从“注册”和“评审”所述的某些或全部步骤。 至此，你完成了发起 PR 的准备工作， 可以通过“发起 PR” 列出的事项实现你的贡献目标。 再次重申，欢迎随时提出问题！

有些任务要求 Kubernetes 组织内更高的信任级别和访问权限。 阅读参与 SIG Docs 工作，获取角色和权限的更多细节。

第一次贡献

你可以提前查阅几个步骤，来准备你的第一次贡献。 图 2 概述了后续的步骤和细节。

图 2. 第一次贡献的准备工作。

• 通读贡献概述，了解参与贡献的不同方式。
• 查看 kubernetes/website 问题列表， 检索最适合作为切入点的问题。
• 在现有文档上，使用 GitHub 提交 PR， 掌握在 GitHub 上登记 Issue 的方法。
• Kubernetes 社区其他成员会评审 PR， 以确保文档精准和语言流畅。
• 阅读 kubernetes 的内容指南和 风格指南，以发表有见地的评论。
• 了解页面内容类型和 Hugo 短代码。

贡献时获取帮助

做出第一个贡献可能会让人感觉比较困难。 新贡献者大使 将引导你完成最初的一些贡献。你可以在 Kubernetes Slack 中联系他们，最好是在 #sig-docs 频道中。还有每月第一个星期二举行的 新贡献者见面会， 你可以在此处与新贡献者大使互动并解决你的疑问。

下一步

• 学习在仓库的本地克隆中工作。
• 为发行版的特性编写文档。
• 加入 SIG Docs， 并成为成员或评审者。
• 开始或帮助本地化工作。

参与 SIG Docs 工作

SIG Docs 是负责发布、维护 Kubernetes 文档的贡献者团体。 参与 SIG Docs 是 Kubernetes 贡献者（开发者和其他人员）对 Kubernetes 项目产生重大影响力的好方式。

SIG Docs 的几种沟通方式：

• 加入 Kubernetes 在 Slack 上的 #sig-docs 频道。 一定记得自我介绍!
• 加入 kubernetes-sig-docs 邮件列表， 这里有更广泛的讨论，和官方决策的记录。
• 参加每两周召开一次的 SIG Docs 视频会议。 会议总是在 #sig-docs 上发出公告，同时添加到 Kubernetes 社区会议日历。 你需要下载 Zoom 客户端软件，或电话拨号接入。
• 如果有几周未召开实况 Zoom 视频会议，请参加 SIG Docs 异步 Slack 站会。 会议总是在 #sig-docs 上发出公告。 你可以在会议公告后 24 小时内为其中任一议题做贡献。

其他贡献方式

• 访问 Kubernetes 社区网站。 参与 Twitter 或 Stack Overflow，了解当地的 Kubernetes 会议和活动等等。
• 阅读贡献者备忘单， 参与 Kubernetes 功能开发。
• 访问贡献者网站，进一步了解有关 Kubernetes 贡献者 和更多贡献者资源的信息。
• 提交一篇博客文章或案例研究。