为 Kubernetes 文档贡献

本网站由 Kubernetes SIG Docs 维护。Kubernetes 项目欢迎所有贡献者,无论新老!

Kubernetes 文档贡献者

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

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


入门

任何人都可以就文档问题提交 issue,或通过 pull request (PR) 对 kubernetes/website GitHub 仓库 贡献更改。要有效地参与 Kubernetes 社区,您需要熟悉 gitGitHub

参与文档贡献

  1. 签署 CNCF 贡献者许可协议
  2. 熟悉 文档仓库 和网站的 静态站点生成器
  3. 确保您理解 打开 pull request审查更改 的基本流程。

flowchart TB subgraph third[打开 PR] direction TB U[ ] -.- Q[改进内容] --- N[创建内容] N --- O[翻译文档] O --- P[管理/发布文档部分
Kubernetes 发布周期] 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
issues 列表中的
适合初学者的 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. 为您的第一次贡献做准备。

贡献过程中获得帮助

第一次贡献可能会让人感到不知所措。 新贡献者大使 将会引导您完成最初的几次贡献。您可以通过 Kubernetes Slack 与他们联系,最好是在 #sig-docs 频道。还有一个新贡献者见面会(New Contributors Meet and Greet),每月第一个星期二举行。您可以在这里与新贡献者大使互动并解决您的问题。

下一步

参与 SIG Docs

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

SIG Docs 通过多种方式沟通

其他贡献方式

最后修改时间:2025 年 3 月 13 日上午 10:41 PST:添加博客贡献指南(815a75d025)