頁面內容型別

Kubernetes 文件遵循幾種頁面內容型別

• 概念
• 任務
• 教程
• 參考

內容部分

每種頁面內容型別都包含由 Markdown 註釋和 HTML 標題定義的多節內容。您可以使用 heading 短程式碼來新增內容標題。註釋和標題有助於維護頁面內容型別的結構。

定義頁面內容部分的 Markdown 註釋示例

<!-- overview -->

<!-- body -->

要建立內容頁面中的常用標題，請使用帶有標題字串的 heading 短程式碼。

標題字串示例

• 下一步
• 先決條件
• 目標
• 清理
• 摘要
• 相關文章
• options

例如，要建立 whatsnext 標題，請新增帶有“whatsnext”字串的 heading 短程式碼

## {{% heading "whatsnext" %}}

您可以按如下方式宣告 prerequisites 標題

## {{% heading "prerequisites" %}}

heading 短程式碼接受一個字串引數。標題字串引數與 i18n/<lang>/<lang>.toml 檔案中的變數字首匹配。例如

i18n/en/en.toml:

[whatsnext_heading]
other = "What's next"

i18n/ko.toml:

[whatsnext_heading]
other = "다음 내용"

內容型別

每種內容型別都非正式地定義了其預期的頁面結構。使用建議的頁面部分來建立頁面內容。

概念

概念頁面解釋了 Kubernetes 的某些方面。例如，概念頁面可能描述 Kubernetes Deployment 物件，並解釋其在部署、擴充套件和更新應用程式後的作用。通常，概念頁面不包含一系列步驟，而是提供指向任務或教程的連結。

要編寫新的概念頁面，請在 /content/en/docs/concepts 目錄的子目錄中建立一個 Markdown 檔案，該檔案具有以下特徵

概念頁面分為三個部分

overview 和 body 部分顯示為概念頁面中的註釋。您可以使用 heading 短程式碼將 whatsnext 部分新增到頁面。

用內容填充每個部分。遵循以下指南

• 使用 H2 和 H3 標題組織內容。
• 對於 overview，用一個段落設定主題的上下文。
• 對於 body，解釋概念。
• 對於 whatsnext，提供一個專案符號列表（最多 5 個），以便您能瞭解有關該概念的更多資訊。

Annotations 是一個已釋出的示例概念頁面。

任務

任務頁面展示瞭如何完成某項單一任務，通常是透過一系列簡短的步驟。任務頁面只包含最少的解釋，但通常會提供指向提供相關背景和知識的概念主題的連結。

要編寫新的任務頁面，請在 /content/en/docs/tasks 目錄的子目錄中建立一個 Markdown 檔案，該檔案具有以下特徵

overview、steps 和 discussion 部分顯示為任務頁面中的註釋。您可以使用 heading 短程式碼將 prerequisites 和 whatsnext 部分新增到頁面。

在每個部分內，編寫您的內容。使用以下指南

• 使用至少一個 H2 標題（帶有兩個前導 # 字元）。模板會自動為這些部分命名。
• 對於 overview，使用一個段落來設定整個主題的上下文。
• 對於 prerequisites，儘可能使用專案符號列表。在 include 下方開始新增其他先決條件。預設的先決條件包括一個正在執行的 Kubernetes 叢集。
• 對於 steps，使用編號列表。
• 對於討論，使用普通內容來擴充套件 steps 中涵蓋的資訊。
• 對於 whatsnext，提供一個最多包含 5 個主題的專案符號列表，讀者可能會對這些主題感興趣。

已釋出的任務主題示例是 使用 HTTP 代理訪問 Kubernetes API。

教程

教程頁面展示瞭如何完成比單個任務更大的目標。通常，教程頁面有多個部分，每個部分都有一個步驟序列。例如，教程可能會提供一個程式碼示例的演練，該示例說明了 Kubernetes 的某個特定功能。教程可以包含表面級的解釋，但應連結到相關的概念主題以進行深入解釋。

要編寫新的教程頁面，請在 /content/en/docs/tutorials 目錄的子目錄中建立一個 Markdown 檔案，該檔案具有以下特徵

overview、objectives 和 lessoncontent 部分顯示為教程頁面中的註釋。您可以使用 heading 短程式碼將 prerequisites、cleanup 和 whatsnext 部分新增到頁面。

在每個部分內，編寫您的內容。使用以下指南

• 使用至少一個 H2 標題（帶有兩個前導 # 字元）。模板會自動為這些部分命名。
• 對於 overview，使用一個段落來設定整個主題的上下文。
• 對於 prerequisites，儘可能使用專案符號列表。在預設包含的先決條件下方新增其他先決條件。
• 對於 objectives，使用專案符號列表。
• 對於 lessoncontent，根據需要使用編號列表和敘述性內容的組合。
• 對於 cleanup，使用編號列表描述完成任務後清理叢集狀態的步驟。
• 對於 whatsnext，提供一個最多包含 5 個主題的專案符號列表，讀者可能會對這些主題感興趣。

已釋出的教程主題示例是 使用 Deployment 執行無狀態應用程式。

參考

元件工具參考頁面顯示了 Kubernetes 元件工具的描述和標誌選項輸出。每個頁面都由指令碼生成，使用元件工具命令。

工具參考頁面有幾個可能的節

已釋出的工具參考頁面示例是

• kubeadm init
• kube-apiserver
• kubectl

下一步

• 瞭解 樣式指南
• 瞭解 內容指南
• 瞭解 內容組織