貢獻新內容

本節包含您在貢獻新內容之前應瞭解的資訊。

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.33 發行版本中變更，則將文件變更新增至 dev-1.33 分支。
其他語言的內容 (本地化)使用本地化的慣例。如需更多資訊，請參閱本地化分支策略。

如果您仍然不確定要選擇哪個分支，請在 Slack 上的 #sig-docs 中詢問。

每個 PR 的語言

將提取請求限制為每個 PR 一種語言。如果您需要對多種語言的相同程式碼範例進行相同的變更，請為每種語言開啟個別的 PR。

貢獻者工具

文件貢獻者工具目錄在 kubernetes/website 儲存庫中，包含可協助您更順利地完成貢獻旅程的工具。

開啟提取請求

為發行版本編寫功能文件

提交部落格文章和案例研究

上次修改時間為 2023 年 12 月 29 日下午 9:47 PST：修正過時的連結/錨點 (bcc55ae7c9)