贡献新内容

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

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

新内容任务流程

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 页面内容
类型和 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,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 shortcodes 外，我们还在文档中使用了一些自定义 Hugo shortcodes来控制内容的呈现方式。
  • 文档源可在 /content/ 中以多种语言获取。每种语言都有自己的文件夹，文件夹名称由ISO 639-1 标准确定的双字母代码表示。例如，英文文档源存储在 /content/en/docs/ 中。
  • 有关为多种语言文档做贡献或启动新翻译的更多信息，请参阅本地化。

开始之前

签署 CNCF CLA

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

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

选择要使用的 Git 分支

提交拉取请求时，你需要提前知道工作应该基于哪个分支。

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

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

每个 PR 的语言数量

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

贡献者工具

kubernetes/website 仓库中的文档贡献者工具目录包含有助于你的贡献过程更加顺利的工具。

下一步

最后修改于 2025 年 3 月 13 日太平洋标准时间 10:41：添加博客贡献指南 (815a75d025)