贡献新内容

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

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

新内容任务流程

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 shortcodes或自定义Hugo shortcodes来贡献Kubernetes文档。
  • 除了标准的Hugo短代码之外，我们还在文档中使用了一些自定义Hugo短代码来控制内容呈现。
  • 文档源文件有多种语言，位于/content/。每种语言都有自己的文件夹，其两字母代码由ISO 639-1标准确定。例如，英文文档源文件存储在/content/en/docs/中。
  • 有关贡献多语言文档或启动新翻译的更多信息，请参阅本地化。

准备工作

签署CNCF CLA

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

未签署CLA的贡献者的Pull Request将无法通过自动化测试。您提供的姓名和电子邮件必须与您git config中的信息一致，并且您的git姓名和电子邮件必须与CNCF CLA中使用的信息一致。

选择要使用的Git分支

在打开Pull Request时，您需要提前知道要基于哪个分支进行工作。

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

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

每个PR一种语言

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

贡献者工具

kubernetes/website存储库中的/content/en/docs/doc-contributor-tools目录包含可帮助您更顺利地进行贡献的工具。

下一步

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