为 Kubernetes 文档贡献

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

Kubernetes 文档贡献者

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

入门

任何人都可以提出关于文档的问题，或通过拉取请求 (PR) 为 kubernetes/website GitHub 仓库贡献更改。您需要熟悉 git 和 GitHub才能在 Kubernetes 社区中有效地工作。

参与文档

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

图 1 为新贡献者概述了一条路线图。您可以按照“注册”和“审查”中的一些或全部步骤操作。现在，您已准备好创建 PR 来实现您的贡献目标，其中一些目标列在“创建 PR”下。再次提醒，欢迎随时提问！

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

您的首次贡献

您可以通过事先查看几个步骤来为您的首次贡献做好准备。图 2 概述了这些步骤，详情如下。

• 阅读 贡献概述以了解您可以贡献的不同方式。
• 查看 kubernetes/website 问题列表，寻找适合作为入门点的 issue。
• 使用 GitHub 创建拉取请求以贡献到现有文档，并了解有关在 GitHub 中提交问题的信息。
• 审查来自其他 Kubernetes 社区成员的拉取请求，以确保其准确性和语言表达。
• 阅读 Kubernetes 的 内容和 样式指南，以便您可以留下知情评论。
• 了解 页面内容类型和 Hugo Shortcodes。

在贡献时获取帮助

进行您的首次贡献可能会令人不知所措。 新贡献者大使可以帮助您完成前几次贡献。您可以在 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 贡献者和 其他贡献者资源的更多信息。
• 提交 博客文章或案例研究。