贡献新内容

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

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
功能更改发布的内容与功能更改所属的 major 和 minor 版本相对应的分支，使用模式 dev-<version>。例如，如果某个功能在 v1.32 版本中进行了更改，则将文档更改添加到 dev-1.32 分支。
其他语言 (本地化) 的内容使用本地化的约定。有关更多信息，请参阅 本地化分支策略。

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

每个 PR 一种语言

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

贡献者工具

kubernetes/website 存储库中的 文档贡献者工具 目录包含可帮助您更顺利地完成贡献之旅的工具。

打开拉取请求

为发布文档某个功能

提交博客文章和案例研究

上次修改时间：2023 年 12 月 29 日，太平洋标准时间下午 9:47：修复过时的链接/锚点 (bcc55ae7c9)