为 Kubernetes 文档做贡献

本网站由 Kubernetes SIG Docs 维护。Kubernetes 项目欢迎所有贡献者的帮助，无论新手还是经验丰富的贡献者！

Kubernetes 文档贡献者

• 改进现有内容
• 创建新内容
• 翻译文档
• 管理和发布 Kubernetes 发布周期中的文档部分

入门

任何人都可以针对文档提出 issue，或通过向 kubernetes/website GitHub 仓库 提交拉取请求 (PR) 来贡献更改。您需要熟悉 git 和 GitHub 才能在 Kubernetes 社区中高效工作。

参与文档工作

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

图 1 概述了新贡献者的路线图。您可以按照“注册”和“审查”中列出的一些或所有步骤进行操作。现在，您已准备好打开 PR，以实现您在“打开 PR”下列出的一些贡献目标。再次强调，欢迎随时提问！

某些任务需要在 Kubernetes 组织中获得更多信任和更多访问权限。有关角色和权限的更多详细信息，请参阅 参与 SIG Docs。

您的第一次贡献

您可以通过事先查看几个步骤来为您的第一次贡献做好准备。图 2 概述了这些步骤，具体细节如下。

• 阅读 贡献概述，了解您可以做出贡献的不同方式。
• 查看 kubernetes/website issue 列表，寻找适合作为切入点的 issue。
• 使用 GitHub 打开拉取请求 到现有文档，并详细了解如何在 GitHub 中提交 issue。
• 审查 其他 Kubernetes 社区成员提交的拉取请求的准确性和语言。
• 阅读 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 贡献者 和 其他贡献者资源。
• 提交 博文或案例研究。