聚焦 SIG 文件

簡介

官方文件是任何開放原始碼專案的首選來源。對於 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 官方部落格推送和審查內容，以及與每個週期的發布團隊合作以審查文件和部落格。

Docs 下有 2 個子專案：部落格和在地化。社群從中獲得了哪些益處？您想重點介紹這些團隊的一些有趣貢獻嗎？

部落格：此子專案重點介紹 Kubernetes 的新功能或已畢業的功能增強、社群報告、SIG 更新或與 Kubernetes 社群相關的任何新聞，例如思想領導力、教學課程和專案更新，例如 Dockershim 移除和 PodSecurityPolicy 移除，這些將在 1.25 版本中推出。SIG Docs 技術主管之一 Tim Bannister 完成了出色的工作，並且是在推動貢獻通過文件和部落格方面的主要力量。

在地化：透過此子專案，Kubernetes 社群已能夠在使用者和貢獻者之間實現更大的包容性和多樣性。自幾年前以來，這也有助於專案獲得更多貢獻者，尤其是學生。主要亮點之一以及即將到來的在地化是印地語和孟加拉語。目前在印度學生的帶領下進行印地語在地化的工作。

除了這些之外，還有兩個其他子專案：reference-docs 和 網站，該網站是使用 Hugo 建構的，是一個重要的所有權領域。

最近，關於 Kubernetes 生態系統以及業界在最新 1.24 版本中移除 dockershim 的問題引起了很多討論。SIG Docs 如何協助專案確保終端使用者之間的順利變更？

記錄 Dockershim 的移除是一項艱鉅的任務，需要修改現有文件並與各個利害關係人溝通有關棄用工作。這需要社群的共同努力，因此在 1.24 版本發布之前，SIG Docs 與文件和傳播部門、發布團隊的發布負責人以及 CNCF 合作，以協助發布消息。設定了每週會議和 GitHub 專案看板來追蹤進度、審查問題和批准 PR，並保持 Kubernetes 網站更新。這也有助於新貢獻者了解棄用，以便在出現任何「good-first-issue」時，他們可以參與其中。專門的 Slack 頻道用於溝通會議更新、邀請回饋或徵求有關未解決問題和 PR 的協助。每週會議在 1.24 版本發布後又持續了一個月，以審查相關問題並修復它們。非常感謝 Celeste Horgan，他在整個棄用過程中一直推動著這項對話。

新貢獻者和現有貢獻者為何應考慮加入此 SIG？

Kubernetes 是一個龐大的專案，對於許多人來說，一開始可能會感到不知所措，難以找到起點。任何開放原始碼專案都由其文件品質來定義，而 SIG Docs 旨在成為一個歡迎、樂於助人的地方，讓新貢獻者可以上手。人們可以獲得使用專案文件的權益，並透過閱讀文件來學習。他們還可以帶來自己的全新視角來建立和改進文件。從長遠來看，如果他們堅持 SIG Docs，他們可以晉升為維護者。這將有助於使像 Kubernetes 這樣的大型專案更容易解析和導航。

您如何協助新貢獻者入門？加入有任何先決條件嗎？

開始貢獻文件沒有任何先決條件。但肯定有一份很棒的文件貢獻指南，該指南始終保持最新和相關性，並敦促新貢獻者閱讀並隨身攜帶。此外，社群 Slack 頻道 #sig-docs 中有很多有用的釘選和書籤。GitHub 上的 kubernetes/website 儲存庫中帶有「good-first-issue」標籤的問題是建立您的第一個 PR 的絕佳場所。現在，SIG Docs 每月的第一個星期二都會舉辦新貢獻者見面會，由新貢獻者大使角色的第一位擔任者 Arsh Sharma 主持。這有助於在新貢獻者的 SIG 內建立更容易接觸的聯絡點。

您對 SIG 相關的任何成就感到非常自豪嗎？

DM 和 RL：在過去幾個月中，在地化子專案的正式化是 SIG Docs 的一大勝利，考慮到來自不同國家的貢獻者所投入的所有出色工作。早期，在地化工作沒有任何簡化的流程，重點是透過在過去幾個月中起草 KEP 以使在地化正式化為子專案，從而提供結構，該子專案計劃在第三季度末完成。

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

NV：對於每個發布週期，SIG Docs 都必須在短時間內審查發布文件和重點介紹發布更新的功能部落格。這對於文件和部落格審閱者來說始終是一項巨大的工作。

SIG Docs 的未來是否有什麼令人興奮的事情即將到來，您想讓社群知道？

SIG Docs 現在期待建立藍圖、讓穩定的人才管道能夠推動文件改進，以及簡化社群參與問題分類和審查已提交的 PR。為了建立這樣一個貢獻者和審閱者基礎，正在建立指導計畫，以協助目前的貢獻者成為審閱者。這絕對是一個值得關注的領域，敬請期待更多資訊！

總結

SIG Docs 在 KubeCon + CloudNativeCon North America 2021 期間主持了一場 深入探討演講，介紹了他們出色的 SIG。他們非常歡迎，並且已成為許多想要為專案做出貢獻的新手進入 Kubernetes 的起點。加入 SIG 的會議，以了解最新的研究成果、他們對來年的計畫，以及如何以貢獻者身分參與上游 Docs 團隊！

• ←上一篇
下一篇→