文件內容指南

此頁面包含 Kubernetes 文件的指南。

如果您對允許的內容有疑問，請加入 Kubernetes Slack 中的 #sig-docs 頻道並提問！

您可以在 https://slack.k8s.io/ 註冊 Kubernetes Slack。

如需建立 Kubernetes 文件的新內容的相關資訊，請遵循樣式指南。

概觀

Kubernetes 網站（包括文件）的來源位於 kubernetes/website 儲存庫中。

大多數 Kubernetes 文件都位於 kubernetes/website/content/<language_code>/docs 資料夾中，特定於 Kubernetes 專案。

允許的內容

僅在以下情況下，Kubernetes 文件才允許第三方專案的內容

• 內容文件 Kubernetes 專案中的軟體
• 內容文件專案外的軟體，但 Kubernetes 運作所必需
• 內容在 kubernetes.io 上是規範的，或連結到其他地方的規範內容

第三方內容

Kubernetes 文件包含 Kubernetes 專案中專案的應用範例，這些專案位於 kubernetes 和 kubernetes-sigs GitHub 組織中。

始終允許連結到 Kubernetes 專案中的活動內容。

Kubernetes 需要一些第三方內容才能運作。範例包括容器執行期 (containerd、CRI-O、Docker)、網路原則 (CNI 外掛程式)、Ingress 控制器和 記錄。

文件可以連結到 Kubernetes 專案外的第三方開放原始碼軟體 (OSS)，但前提是 Kubernetes 運作所必需。

雙重來源內容

在可能的情況下，Kubernetes 文件會連結到規範來源，而不是託管雙重來源內容。

雙重來源內容需要雙倍的努力（或更多！）來維護，並且更容易過時。

更多資訊

如果您對允許的內容有疑問，請加入 Kubernetes Slack #sig-docs 頻道並提問！

下一步

• 閱讀樣式指南。