參與 SIG Docs

SIG Docs 是 Kubernetes 專案中的一個特別興趣小組，專注於為整個 Kubernetes 編寫、更新和維護文件。有關該 SIG 的更多資訊，請參閱社群 GitHub 倉庫中的 SIG Docs。

SIG Docs 歡迎所有貢獻者提供內容和審閱。任何人都可以提交一個拉取請求 (PR)，並且歡迎任何人針對內容提交問題或評論正在進行的拉取請求。

您還可以成為成員、審閱者或批准者。這些角色需要更高的訪問許可權，並承擔批准和提交更改的某些責任。有關成員身份在 Kubernetes 社群中如何運作的更多資訊，請參閱community-membership。

本文件的其餘部分概述了這些角色在 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 評論中，可以透過 @名稱 來引用它們，以與該組中的所有人進行交流。

有時 Prow 和 GitHub 團隊會重疊但不完全匹配。對於問題的分配、拉取請求以及支援 PR 批准，自動化使用來自 OWNERS 檔案中的資訊。

Kubernetes 專案使用一個名為 prow 的自動化工具來處理與 GitHub 問題和拉取請求相關的自動化。 the 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.club.tw。為了確保我們釋出內容的質量很高，我們限制了拉取請求的合併許可權給 SIG Docs 批准者。工作原理如下：

當一個拉取請求同時具有 lgtm 和 approve 標籤，沒有 hold 標籤，並且所有測試都透過時，該拉取請求將自動合併。
Kubernetes 組織成員和 SIG Docs 批准者可以透過新增 /hold 註釋來阻止給定拉取請求的自動合併（或者不新增 /lgtm 註釋）。
任何 Kubernetes 成員都可以透過新增 /lgtm 註釋來新增 lgtm 標籤。
只有 SIG Docs 批准者可以透過新增 /approve 註釋來合併拉取請求。一些批准者還承擔額外的特定角色，例如 PR Wrangler 或 SIG Docs 主席。

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