參與 SIG Docs

SIG Docs 是 Kubernetes 專案中專注於編寫、更新和維護 Kubernetes 整體文件的特殊興趣小組之一。有關 SIG 的更多資訊，請參閱社群 github 儲存庫中的 SIG Docs。

SIG Docs 歡迎所有貢獻者的內容和審閱。任何人都可以開啟提取請求 (PR)，並且歡迎任何人提交有關內容的問題或評論進行中的提取請求。

您也可以成為成員、審閱者或批准者。這些角色需要更大的存取權，並承擔批准和提交變更的某些責任。有關 Kubernetes 社群中成員資格如何運作的更多資訊，請參閱社群成員資格。

本文檔的其餘部分概述了這些角色在 SIG Docs 中的一些獨特運作方式，SIG Docs 負責維護 Kubernetes 最公開的方面之一 - Kubernetes 網站和文件。

SIG Docs 主席

每個 SIG（包括 SIG Docs）都會選取一位或多位 SIG 成員擔任主席。這些是 SIG Docs 和 Kubernetes 組織其他部門之間的聯絡點。他們需要廣泛了解整個 Kubernetes 專案的結構以及 SIG Docs 在其中的運作方式。有關目前的主席列表，請參閱領導階層。

SIG Docs 中的自動化依賴兩種不同的機制：GitHub 團隊和 OWNERS 檔案。

GitHub 上有兩種類別的 SIG Docs 團隊

每個團隊都可以在 GitHub 評論中使用其 @name 來參考，以便與該群組中的所有人溝通。

有時 Prow 和 GitHub 團隊重疊，但並不完全匹配。為了指派問題、提取請求和支援 PR 批准，自動化使用來自 OWNERS 檔案的資訊。

Kubernetes 專案使用名為 prow 的自動化工具來進行與 GitHub 問題和提取請求相關的自動化。 Kubernetes 網站儲存庫使用兩個prow 外掛程式

這兩個外掛程式使用 kubernetes/website GitHub 儲存庫頂層的OWNERS和OWNERS_ALIASES檔案來控制 prow 在儲存庫中的運作方式。

OWNERS 檔案包含 SIG Docs 審閱者和批准者的清單。 OWNERS 檔案也可以存在於子目錄中，並且可以覆寫誰可以擔任該子目錄及其後代目錄中檔案的審閱者或批准者。有關 OWNERS 檔案的更多資訊，請參閱OWNERS。

此外，個別 Markdown 檔案可以在其 front-matter 中列出審閱者和批准者，方法是列出個別 GitHub 使用者名稱或 GitHub 群組。

OWNERS 檔案和 Markdown 檔案中 front-matter 的組合決定了 PR 擁有者從自動化系統獲得的關於應要求誰對其 PR 進行技術和編輯審閱的建議。

當提取請求合併到用於發布內容的分支時，該內容將發布到 https://kubernetes.dev.org.tw。為了確保我們發布的內容品質很高，我們將合併提取請求限制為 SIG Docs 批准者。以下是它的運作方式。

當提取請求同時具有 lgtm 和 approve 標籤、沒有 hold 標籤且所有測試都通過時，提取請求會自動合併。
Kubernetes 組織成員和 SIG Docs 批准者可以新增評論，以防止自動合併給定的提取請求（透過新增 /hold 評論或拒絕 /lgtm 評論）。
任何 Kubernetes 成員都可以透過新增 /lgtm 評論來新增 lgtm 標籤。
只有 SIG Docs 批准者才能透過新增 /approve 評論來合併提取請求。一些批准者還執行其他特定角色，例如PR Wrangler或SIG Docs 主席。

有關貢獻 Kubernetes 文件的更多資訊，請參閱