为 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（“good first PR”）。
• 使用 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 贡献者 和 其他贡献者资源 的更多信息。
• 提交 博客文章或案例研究。