贡献 Kubernetes 文档
本网站由 Kubernetes SIG Docs 维护。Kubernetes 项目欢迎所有贡献者（无论是新手还是有经验者）提供帮助！
Kubernetes 文档贡献者
- 改进现有内容
- 创建新内容
- 翻译文档
- 管理和发布 Kubernetes 发布周期中的文档部分
博客团队是 SIG Docs 的一部分，负责管理官方博客。阅读贡献 Kubernetes 博客了解更多信息。
注意
要了解有关普遍贡献 Kubernetes 的更多信息，请参阅通用的贡献者文档网站。入门
任何人都可以提出与文档相关的 Issue，或通过 Pull Request (PR) 向 kubernetes/website GitHub 仓库贡献变更。为了在 Kubernetes 社区有效地工作，你需要熟悉 git 和 GitHub。
参与文档工作
- 签署 CNCF 贡献者许可协议。
- 熟悉文档仓库和网站使用的 静态站点生成器。
- 确保你理解发起 Pull Request 和审查变更的基本流程。
flowchart TB subgraph third[发起 PR] direction TB U[ ] -.- Q[改进内容] --- N[创建内容] N --- O[翻译文档] O --- P[管理/发布文档部分
(K8s 发布周期)] end subgraph second[审查] direction TB T[ ] -.- D[查看
kubernetes/website
仓库] --- E[了解
Hugo 静态站点
生成器] E --- F[理解基本
GitHub 命令] F --- G[审查开放 PR
和变更审查
流程] end subgraph first[注册/加入] direction TB S[ ] -.- B[签署 CNCF
贡献者
许可协议] --- C[加入 sig-docs
Slack 频道] C --- V[加入 kubernetes-sig-docs
邮件列表] V --- M[参加每周
sig-docs 例会
或 Slack 会议] end A([fa:fa-user 新
贡献者]) --> first A --> second A --> third A --> H[提问!!!] classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,C,D,E,F,G,H,M,Q,N,O,P,V grey class S,T,U spacewhite class first,second,third white
(K8s 发布周期)] end subgraph second[审查] direction TB T[ ] -.- D[查看
kubernetes/website
仓库] --- E[了解
Hugo 静态站点
生成器] E --- F[理解基本
GitHub 命令] F --- G[审查开放 PR
和变更审查
流程] end subgraph first[注册/加入] direction TB S[ ] -.- B[签署 CNCF
贡献者
许可协议] --- C[加入 sig-docs
Slack 频道] C --- V[加入 kubernetes-sig-docs
邮件列表] V --- M[参加每周
sig-docs 例会
或 Slack 会议] end A([fa:fa-user 新
贡献者]) --> first A --> second A --> third A --> H[提问!!!] classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,C,D,E,F,G,H,M,Q,N,O,P,V grey class S,T,U spacewhite class first,second,third white
图 1 概述了新贡献者的路线图。你可以遵循“注册/加入”和“审查”部分的部分或全部步骤。现在你可以发起 Pull Request，完成你在“发起 PR”下列出的贡献目标。再次强调，随时欢迎提问！
有些任务需要在 Kubernetes 组织中获得更多的信任和访问权限。参阅参与 SIG Docs 了解关于角色和权限的更多细节。
你的第一次贡献
你可以通过提前复习几个步骤来准备你的第一次贡献。图 2 概述了这些步骤，详细信息如下。
flowchart LR subgraph second[第一次贡献] direction TB S[ ] -.- G[审查其他
K8s 成员的 PR] --> A[查看 kubernetes/website
Issue 列表寻找
适合新手的 PR] --> B[发起一个 PR!!] end subgraph first[建议的准备] direction TB T[ ] -.- D[阅读贡献概览] -->E[阅读 K8s 内容
和风格指南] E --> F[学习 Hugo 页面
内容类型
和 Shortcodes] end first ----> second classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,D,E,F,G grey class S,T spacewhite class first,second white
K8s 成员的 PR] --> A[查看 kubernetes/website
Issue 列表寻找
适合新手的 PR] --> B[发起一个 PR!!] end subgraph first[建议的准备] direction TB T[ ] -.- D[阅读贡献概览] -->E[阅读 K8s 内容
和风格指南] E --> F[学习 Hugo 页面
内容类型
和 Shortcodes] end first ----> second classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,D,E,F,G grey class S,T spacewhite class first,second white
- 阅读贡献概览，了解你可以贡献的不同方式。
- 查看
kubernetes/websiteIssue 列表，寻找适合作为入门的 Issue。 - 使用 GitHub 发起 Pull Request 修改现有文档，并了解如何在 GitHub 中提交 Issue。
- 审查其他 Kubernetes 社区成员的 Pull Request，检查其准确性和语言。
- 阅读 Kubernetes 的内容和风格指南，以便你可以留下有价值的评论。
- 了解页面内容类型和Hugo shortcodes。
贡献时获取帮助
你的第一次贡献可能会让你不知所措。新贡献者大使会指导你完成你的最初几次贡献。你可以在Kubernetes Slack 中联系他们，最好是在 #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 贡献者和其他贡献者资源的信息。
- 学习如何贡献官方博客
- 提交一个案例研究
上次修改时间：2025 年 3 月 13 日 上午 10:41 PST：添加博客贡献指南 (815a75d025)