贡献新内容

本节包含您在贡献新内容之前应该了解的信息。

还有专门的页面介绍提交案例研究和博客文章。

新内容任务流程

flowchart LR subgraph second[在开始之前] direction TB S[ ] -.- A[签署 CNCF CLA] --> B[选择 Git 分支] B --> C[每个 PR 一种语言] C --> F[检出
贡献者工具] end subgraph first[贡献基础] direction TB T[ ] -.- D[用 markdown 编写文档
并使用 Hugo 构建站点] --- E[在 GitHub 中] E --- G['/content/../docs' 文件夹包含多语言文档
] G --- H[查看 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,C,D,E,F,G,H grey class S,T spacewhite class first,second white

图 - 贡献新内容准备

上图描述了您在提交新内容之前应该了解的信息。详细信息如下。

贡献基础

  • 使用 Markdown 编写 Kubernetes 文档，并使用 Hugo 构建 Kubernetes 站点。
  • Kubernetes 文档使用 CommonMark 作为其 Markdown 风格。
  • 源代码位于 GitHub 中。您可以在 /content/en/docs/ 中找到 Kubernetes 文档。部分参考文档会从 update-imported-docs/ 目录中的脚本自动生成。
  • 页面内容类型描述了 Hugo 中文档内容的呈现方式。
  • 您可以使用 Docsy 短代码或 自定义 Hugo 短代码来贡献 Kubernetes 文档。
  • 除了标准的 Hugo 短代码外，我们还在文档中使用许多 自定义 Hugo 短代码来控制内容的呈现方式。
  • 文档源代码以多种语言保存在 /content/ 中。每种语言都有一个由 ISO 639-1 标准 确定的两字母代码的文件夹。例如，英语文档源代码存储在 /content/en/docs/ 中。
  • 有关贡献多语言文档或开始新的翻译的更多信息，请参阅 本地化。

开始之前

签署 CNCF CLA

所有 Kubernetes 贡献者必须阅读 贡献者指南和 签署贡献者许可协议 (CLA) 。

未签署 CLA 的贡献者的拉取请求将无法通过自动化测试。您提供的姓名和电子邮件必须与您的 git config 中找到的匹配，并且您的 git 姓名和电子邮件必须与用于 CNCF CLA 的匹配。

选择要使用的 Git 分支

打开拉取请求时，您需要提前知道要基于哪个分支进行工作。

场景分支
当前版本的现有或新英语内容main
功能变更版本的内容使用模式 dev-<version> 的与功能变更所在的主要和次版本对应的分支。例如，如果功能在 v1.36 版本中发生变化，则将文档更改添加到 dev-1.36 分支。
其他语言的内容（本地化）使用本地化的约定。有关更多信息，请参阅 本地化分支策略。

如果您仍然不确定选择哪个分支，请在 Slack 的 #sig-docs 中提问。

每个 PR 的语言

将拉取请求限制为每个 PR 一种语言。如果您需要在多个语言中对相同的代码示例进行相同的更改，请为每种语言打开一个单独的 PR。

贡献者工具

kubernetes/website 仓库中的 doc 贡献者工具 目录包含可以帮助您的贡献之旅更顺利的工具。

接下来

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