貢獻新內容

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

還有關於提交案例研究和部落格文章的專門頁面。

新內容任務流程

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）