为 Kubernetes 文档做贡献

本网站由 Kubernetes SIG Docs 维护。Kubernetes 项目欢迎来自所有贡献者的帮助,无论您是新人还是经验丰富的老手!

Kubernetes 文档贡献者

  • 完善现有内容
  • 创建新内容
  • 翻译文档
  • 管理并发布 Kubernetes 发布周期中的文档部分

博客团队是 SIG Docs 的一部分,负责协助管理官方博客。阅读 为 Kubernetes 博客做出贡献 以了解更多信息。


说明

要了解有关向 Kubernetes 贡献的更多通用信息,请参阅 贡献者文档 站点。

开始使用

任何人都可以就文档打开一个议题(issue),或通过拉取请求(PR)向 kubernetes/website GitHub 仓库 贡献更改。您需要熟悉 gitGitHub 才能在 Kubernetes 社区中高效工作。

如何参与文档工作

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

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
图 1. 新贡献者入门指南。

图 1 概述了新贡献者的路线图。您可以按照“注册”和“审查”中的部分或全部步骤操作。现在,您已经准备好开启符合您贡献目标的 PR,其中一些已列在“开启 PR”下。再次强调,随时欢迎提问!

某些任务需要 Kubernetes 组织给予更多的信任和权限。有关角色和权限的更多详细信息,请参阅 参与 SIG Docs

您的第一次贡献

您可以在开始前通过审查几个步骤来准备您的第一次贡献。图 2 概述了这些步骤,详情如下。

flowchart LR subgraph second[第一次贡献] direction TB S[ ] -.- G[审查来自其他
K8s 成员的 PR] --> A[查看 kubernetes/website
的问题列表以查找
适合新手的 PR] --> B[开启一个 PR!!] end subgraph first[建议准备] direction TB T[ ] -.- D[阅读贡献概览] -->E[阅读 K8s 内容
和样式指南] E --> F[了解 Hugo 页面
内容类型
和短代码] 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
图 2. 第一次贡献的准备工作。

贡献时的帮助

第一次贡献可能会让人不知所措。新贡献者大使 (New Contributor Ambassadors) 将指导您完成最初的几次贡献。您可以通过 Kubernetes Slack 联系他们(建议在 #sig-docs 频道)。此外,每个月的第一个星期二还有 新贡献者见面会 (New Contributors Meet and Greet call)。您可以在此处与新贡献者大使互动并解决您的疑问。

参与 SIG Docs

SIG Docs 是负责发布和维护 Kubernetes 文档及网站的贡献者团体。对于 Kubernetes 贡献者(无论是功能开发还是其他方面)而言,参与 SIG Docs 是对 Kubernetes 项目产生重大影响的好途径。

SIG Docs 通过多种方式进行沟通

其他贡献方式

后续步骤


最后修改时间:2026 年 4 月 14 日凌晨 1:15(太平洋标准时间):fix(links): update kubernetes/community links from master to main (03c191bcc4)