頁面內容類型

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

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

內容章節

每個頁面內容類型都包含許多章節，這些章節由 Markdown 註解與 HTML 標題定義。您可以使用 heading Shortcode 將內容標題新增至您的頁面。註解與標題有助於維護頁面內容類型的結構。

定義頁面內容章節的 Markdown 註解範例

<!-- overview -->

<!-- body -->

若要在您的內容頁面中建立通用標題，請使用具有標題字串的 heading Shortcode。

標題字串範例

• whatsnext
• prerequisites
• objectives
• cleanup
• synopsis
• seealso
• options

例如，若要建立 whatsnext 標題，請新增具有 "whatsnext" 字串的 heading Shortcode

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

您可以宣告 prerequisites 標題，如下所示

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

heading Shortcode 預期一個字串參數。標題字串參數符合 i18n/<lang>.toml 檔案中變數的前綴。例如

i18n/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 Shortcode 將 whatsnext 章節新增至您的頁面。

在每個章節中填寫內容。請遵循下列準則

• 使用 H2 與 H3 標題組織內容。
• 對於 overview，請使用單一段落設定主題的背景。
• 對於 body，請說明概念。
• 對於 whatsnext，請提供項目符號清單（最多 5 個），以深入瞭解概念。

註解 是已發佈的概念頁面範例。

任務

任務頁面示範如何執行單一事情，通常是透過提供簡短的步驟序列。任務頁面提供最少的說明，但經常提供概念主題的連結，以提供相關的背景知識。

若要撰寫新的任務頁面，請在 /content/en/docs/tasks 目錄的子目錄中建立 Markdown 檔案，並具有下列特性

overview、steps 與 discussion 章節以註解形式出現在任務頁面中。您可以使用 heading Shortcode 將 prerequisites 與 whatsnext 章節新增至您的頁面。

在每個章節中，撰寫您的內容。請使用下列準則

• 至少使用 H2 標題（帶有兩個前導 # 字元）。章節本身由範本自動命名。
• 對於 overview，請使用段落為整個主題設定背景。
• 對於 prerequisites，請盡可能使用項目符號清單。在 include 下方開始新增其他先決條件。預設先決條件包含執行中的 Kubernetes 叢集。
• 對於 steps，請使用編號清單。
• 對於 discussion，請使用一般內容來擴展 steps 中涵蓋的資訊。
• 對於 whatsnext，請提供最多 5 個主題的項目符號清單，讀者可能會對接下來閱讀的內容感興趣。

已發佈任務主題的範例為 使用 HTTP 代理伺服器存取 Kubernetes API。

教學課程

教學課程頁面示範如何完成比單一任務更大的目標。通常，教學課程頁面包含多個章節，每個章節都有步驟序列。例如，教學課程可能會提供程式碼範例的導覽，該範例說明 Kubernetes 的特定功能。教學課程可以包含表面層次的說明，但應連結至相關的概念主題以進行深入說明。

若要撰寫新的教學課程頁面，請在 /content/en/docs/tutorials 目錄的子目錄中建立 Markdown 檔案，並具有下列特性

overview、objectives 與 lessoncontent 章節以註解形式出現在教學課程頁面中。您可以使用 heading Shortcode 將 prerequisites、cleanup 與 whatsnext 章節新增至您的頁面。

在每個章節中，撰寫您的內容。請使用下列準則

• 至少使用 H2 標題（帶有兩個前導 # 字元）。章節本身由範本自動命名。
• 對於 overview，請使用段落為整個主題設定背景。
• 對於 prerequisites，請盡可能使用項目符號清單。在預設包含的先決條件下方新增其他先決條件。
• 對於 objectives，請使用項目符號清單。
• 對於 lessoncontent，請適當地混合使用編號清單與敘述性內容。
• 對於 cleanup，請使用編號清單來描述在完成任務後清除叢集狀態的步驟。
• 對於 whatsnext，請提供最多 5 個主題的項目符號清單，讀者可能會對接下來閱讀的內容感興趣。

已發佈教學課程主題的範例為 使用部署執行無狀態應用程式。

參考

組件工具參考頁面顯示 Kubernetes 組件工具的描述與旗標選項輸出。每個頁面都使用組件工具命令從腳本產生。

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

已發佈工具參考頁面的範例為

• kubeadm init
• kube-apiserver
• kubectl

下一步是什麼？

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