为 Kubernetes 文档做贡献

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

Kubernetes 文档贡献者

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

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

开始使用

任何人都可以针对文档提出问题，或者通过向 kubernetes/website GitHub 仓库 提交拉取请求 (PR) 来贡献更改。要有效地参与 Kubernetes 社区，您需要熟悉 git 和 GitHub。

参与文档

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

flowchart TB subgraph third[Open PR] direction TB U[ ] -.- Q[Improve content] --- N[Create content] N --- O[Translate docs] O --- P[Manage/publish docs parts
of K8s release cycle] end subgraph second[Review] direction TB T[ ] -.- D[Look over the
kubernetes/website
repository] --- E[Check out the
Hugo static site
generator] E --- F[Understand basic
GitHub commands] F --- G[Review open PR
and change review
processes] end subgraph first[Sign up] direction TB S[ ] -.- B[Sign the CNCF
Contributor
License Agreement] --- C[Join sig-docs
Slack channel] C --- V[Join kubernetes-sig-docs
mailing list] V --- M[Attend weekly
sig-docs calls
or slack meetings] end A([fa:fa-user New
Contributor]) --> first A --> second A --> third A --> H[Ask Questions!!!] 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 概述了新贡献者的路线图。您可以遵循 Sign up 和 Review 中的一些或所有步骤。现在您已准备好打开实现您的贡献目标的 PR，其中一些在 Open PR 下列出。再次，欢迎随时提问！

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

您的第一次贡献

在开始您的第一次贡献之前，您可以先查看几个步骤进行准备。图 2 概述了这些步骤和详细信息。

flowchart LR subgraph second[First Contribution] direction TB S[ ] -.- G[Review PRs from other
K8s members] --> A[Check kubernetes/website
issues list for
good first PRs] --> B[Open a PR!!] end subgraph first[Suggested Prep] direction TB T[ ] -.- D[Read contribution overview] -->E[Read K8s content
and style guides] E --> F[Learn about Hugo page
content types
and 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
图 2. 准备您的第一次贡献。

在贡献时获取帮助

您的第一次贡献可能会让人不知所措。新贡献者大使 会指导您完成您的前几次贡献。您可以在 Kubernetes Slack 中联系他们，最好是在 #sig-docs 频道中。此外，还有每月第一个星期二举行的 新贡献者见面问候电话。您可以在这里与新贡献者大使互动并解决您的问题。

后续步骤

参与 SIG Docs

SIG Docs 是发布和维护 Kubernetes 文档和网站的贡献者团队。参与 SIG Docs 是 Kubernetes 贡献者（无论是功能开发还是其他）对 Kubernetes 项目产生重大影响的好方法。

SIG Docs 使用不同的方法进行通信

其他贡献方式

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