本文發表於一年多前。舊文章可能包含過時內容。請檢查頁面中的資訊自發布以來是否已變得不正確。

聚焦 SIG Docs

作者：Purneswar Prasad |

引言

官方文件是任何開源專案的首選資源。對於 Kubernetes 來說，它是一個不斷發展的特殊興趣小組（SIG），人們不斷努力使專案細節更容易被新的貢獻者和使用者理解。SIG Docs 在 kubernetes.io 上釋出官方文件，其中包括但不限於核心 API、核心架構細節以及 Kubernetes 版本隨附的 CLI 工具的文件。

為了更多地瞭解 SIG Docs 的工作及其在塑造社群方面的未來，我總結了與聯合主席 Divya Mohan (DM)、Rey Lejano (RL) 和 Natali Vlatko (NV) 的對話，他們介紹了 SIG 的目標以及貢獻者可以如何提供幫助。

對話摘要

您能簡單介紹一下 SIG Docs 的職責嗎？

SIG Docs 是 Kubernetes 專案在 kubernetes.io 上的文件特殊興趣小組，負責生成 Kubernetes API、kubeadm 和 kubectl 的參考指南，並維護官方網站的基礎設施和分析。他們的工作範圍還包括文件釋出、文件翻譯、改進和向現有文件新增新功能、推動和審查官方 Kubernetes 部落格的內容，以及與每個釋出週期的釋出團隊合作，審查文件和部落格。

文件下有兩個子專案：部落格和本地化。社群是如何從中受益的，這些團隊是否有您想重點介紹的有趣貢獻？

部落格：這個子專案重點介紹新的或已畢業的 Kubernetes 增強功能、社群報告、SIG 更新或任何與 Kubernetes 社群相關的新聞，例如思想領導力、教程和專案更新，例如 Dockershim 的移除和 PodSecurityPolicy 的移除，後者將在 1.25 版本中推出。Tim Bannister 是 SIG Docs 的技術負責人之一，他做出了出色的工作，是推動貢獻到文件和部落格的主要力量。

本地化：透過這個子專案，Kubernetes 社群在使用者和貢獻者之間實現了更大的包容性和多樣性。這也幫助該專案在幾年前獲得了更多貢獻者，尤其是學生。主要的亮點和新興的本地化是印地語和孟加拉語。印地語本地化的工作目前由印度的學生牽頭。

除此之外，還有另外兩個子專案：參考文件和網站，該網站使用 Hugo 構建，是一個重要的所有權領域。

最近，關於最新 1.24 版本中移除 dockershim 的訊息在 Kubernetes 生態系統和業界引起了廣泛關注。SIG Docs 如何幫助該專案確保終端使用者之間的平穩過渡？

記錄 Dockershim 的移除是一項艱鉅的任務，需要修改現有文件並與各個利益相關者溝通棄用工作。這需要社群的共同努力，因此在 1.24 版本釋出之前，SIG Docs 與文件和通訊部門、釋出團隊的釋出負責人以及 CNCF 合作，共同宣傳。每週會議和 GitHub 專案板被建立起來，以跟蹤進展、審查問題、批准 PR 並保持 Kubernetes 網站的更新。這也有助於新貢獻者瞭解棄用情況，以便如果有任何“良好開端問題”出現，他們可以參與進來。一個專門的 Slack 頻道用於溝通會議更新、徵求反饋或尋求對未解決問題和 PR 的幫助。每週會議在 1.24 版本釋出後也持續了一個月，以審查相關問題並進行修復。非常感謝 Celeste Horgan，她在整個棄用過程中保持了這次對話的持續進行。

為什麼新的和現有的貢獻者應該考慮加入這個 SIG？

Kubernetes 是一個龐大的專案，對於很多人來說，一開始可能會感到不知所措，不知道從何開始。任何開源專案都由其文件質量定義，SIG Docs 旨在成為新貢獻者入職的友好、有幫助的地方。人們可以獲得使用專案文件的額外好處，並透過閱讀文件來學習。他們還可以帶來自己新的視角來建立和改進文件。長遠來看，如果他們堅持 SIG Docs，他們可以晉升為維護者。這將有助於使 Kubernetes 這樣一個大型專案更容易解析和導航。

您如何幫助新貢獻者入門？加入有什麼先決條件嗎？

對文件的貢獻沒有先決條件。但肯定有一個很棒的《文件貢獻指南》，它始終保持更新和相關，鼓勵新貢獻者閱讀並隨身攜帶。此外，在社群 Slack 頻道 #sig-docs 中有很多有用的置頂和書籤。kubernetes/website 倉庫中帶有 good-first-issue 標籤的 GitHub issue 是建立您的第一個 PR 的好地方。現在，SIG Docs 每月第一個星期二都會舉辦一次新貢獻者見面會，由首位新貢獻者大使 Arsh Sharma 主持。這有助於為 SIG 內的新貢獻者提供更便捷的聯絡點。

DM & RL：在過去幾個月裡，本地化子專案的正式化是 SIG Docs 的一個巨大勝利，這得益於來自不同國家的貢獻者所做的出色工作。早期的本地化工作沒有一個流線型的流程，重點是透過在過去幾個月裡起草一個 KEP 來為本地化提供一個結構，使其正式化為一個子專案，計劃在第三季度末推出。

DM：另一個取得巨大成功的領域是新貢獻者大使的角色，這有助於為新貢獻者加入專案提供一個更容易接觸到的聯絡點。

NV：在每個釋出週期中，SIG Docs 都必須在短時間內審查釋出文件和突出釋出更新的功能部落格。這對文件和部落格審閱者來說始終是一項巨大的努力。

對於 SIG Docs 的未來，有什麼令人興奮的事情想讓社群知道嗎？

SIG Docs 正在期待制定路線圖，建立一個穩定的團隊，能夠推動文件改進，並簡化社群在問題分類和 PR 審查方面的參與。為了建立這樣一個貢獻者和審查者基礎，正在建立一個指導計劃，以幫助當前的貢獻者成為審查者。這絕對是一個值得關注的領域！

總結

SIG Docs 在 2021 年北美 KubeCon + CloudNativeCon 期間舉辦了一場深度探討，介紹了他們出色的 SIG。他們非常熱情，是許多希望為 Kubernetes 專案做出貢獻的新手的起點。加入 SIG 會議，瞭解最新的研究成果、他們未來一年的計劃，以及如何作為貢獻者加入上游文件團隊！