文件內容指南

本頁面包含 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 頻道並提問！

下一步

• 閱讀 樣式指南。