贡献新内容

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

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-<版本>` 模式。例如，如果某个功能在 `v1.33` 版本中更改，则将文档更改添加到 `dev-1.33` 分支。
其他语言（本地化）的内容	使用本地化的约定。有关更多信息，请参阅本地化分支策略。

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

注意

如果您已经提交了拉取请求，并且您知道基本分支错误，则您（且只有您，提交者）可以更改它。

每个 PR 的语言

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

贡献者工具

kubernetes/website 仓库中的文档贡献者工具目录包含有助于您更顺利地进行贡献的工具。