進階貢獻
本頁假設您了解如何貢獻新內容和審閱他人的工作,並已準備好學習更多貢獻方式。您需要使用 Git 命令列用戶端和其他工具來執行其中一些任務。
提出改進建議
SIG Docs 成員可以提出改進建議。
在您為 Kubernetes 文件貢獻一段時間後,您可能會對改進樣式指南、內容指南、用於建置文件的工具鏈、網站樣式、審閱和合併提取請求的流程,或文件的其他方面有想法。為了最大程度的透明度,這些類型的提案需要在 SIG Docs 會議或 kubernetes-sig-docs 郵寄清單中討論。此外,在提出全面變更之前,了解目前運作方式以及過去決策的原因可能會有所幫助。取得有關文件目前運作方式問題解答的最快方法是在 kubernetes.slack.com 上的 #sig-docs
Slack 頻道中提問
在進行討論並且 SIG 就期望的結果達成一致後,您可以採用最合適的方式來處理建議的變更。例如,樣式指南或網站功能的更新可能涉及開啟提取請求,而與文件測試相關的變更可能涉及與 sig-testing 合作。
協調 Kubernetes 版本的文檔
SIG Docs 核准者可以協調 Kubernetes 版本的文檔。
每個 Kubernetes 版本都由參與 sig-release 特殊興趣小組 (SIG) 的團隊協調。給定版本的發布團隊中的其他成員包括整體發布負責人,以及來自 sig-testing 和其他單位的代表。若要深入了解 Kubernetes 發布流程,請參閱 https://github.com/kubernetes/sig-release。
給定版本的 SIG Docs 代表協調以下任務
- 監控功能追蹤試算表,以了解對文件有影響的新功能或變更功能。如果給定功能的文檔尚未準備好用於發布,則該功能可能不允許進入發布版本。
- 定期參加 sig-release 會議,並提供有關版本文檔狀態的更新。
- 審閱和編輯負責實作功能的 SIG 起草的功能文檔。
- 合併與發布相關的提取請求,並維護發布版本的 Git 功能分支。
- 指導其他 SIG Docs 貢獻者,讓他們學習未來如何擔任此角色。這稱為「見習」。
- 在發布版本產出時,發布與版本相關的文件變更。
協調版本發布通常需要 3-4 個月的投入,此職責會在 SIG Docs 核准者之間輪流。
擔任新貢獻者大使
SIG Docs 核准者可以擔任新貢獻者大使。
新貢獻者大使歡迎新的貢獻者加入 SIG-Docs,向新貢獻者建議 PR,並指導新貢獻者完成最初的幾個 PR 提交。
新貢獻者大使的職責包括
- 監看 #sig-docs Slack 頻道,回覆新貢獻者的問題。
- 與 PR 管理員合作,找出適合新貢獻者的「適合新手入門的問題」。
- 指導新貢獻者完成最初幾個提交到文件庫的 PR。
- 協助新貢獻者建立更複雜的 PR,讓他們能夠成為 Kubernetes 成員。
- 在貢獻者成為 Kubernetes 成員的過程中擔任推薦人。
- 每月舉辦會議,以協助和指導新貢獻者。
目前的新貢獻者大使會在每次 SIG-Docs 會議和 Kubernetes #sig-docs 頻道中宣布。
推薦新貢獻者
SIG Docs 審閱者可以推薦新貢獻者。
新貢獻者成功提交 5 個實質性的 Pull Request 到一個或多個 Kubernetes 儲存庫後,他們就有資格申請成為 Kubernetes 組織的成員。貢獻者的成員資格需要兩位已是審閱者的推薦人支持。
新的文件貢獻者可以透過在 Kubernetes Slack 實例上的 #sig-docs 頻道或在 SIG Docs mailing list 中詢問來請求推薦人。如果您對申請人的工作感到有信心,您可以自願擔任他們的推薦人。當他們提交成員資格申請時,請回覆申請並加上 "+1",並詳細說明您認為申請人為何適合成為 Kubernetes 組織的成員。
擔任 SIG 聯合主席
SIG Docs 成員可以擔任 SIG Docs 聯合主席一職。
先決條件
Kubernetes 成員必須符合以下要求才能擔任聯合主席
- 了解 SIG Docs 工作流程和工具:git、Hugo、本地化、部落格子專案
- 了解其他 Kubernetes SIG 和儲存庫如何影響 SIG Docs 工作流程,包括:k/org 中的團隊、k/community 中的流程、k/test-infra 中的外掛程式以及 SIG Architecture 的角色。此外,了解 Kubernetes 文件發布流程的運作方式。
- 經由 SIG Docs 社群直接或透過無異議共識核准。
- 每週至少投入 5 小時(通常更多)在此角色上,至少 6 個月
職責
聯合主席的角色是服務性質的:聯合主席建立貢獻者能力、處理流程和政策、安排和主持會議、安排 PR 管理員、在 Kubernetes 社群中倡導文件、確保文件在 Kubernetes 版本週期中成功,並使 SIG Docs 專注於有效的優先事項。
職責包括
- 保持 SIG Docs 專注於透過優良的文件來最大化開發人員的幸福感
- 以社群行為準則為榜樣,並要求 SIG 成員對此負責
- 透過更新貢獻指南來學習並設定 SIG 的最佳實踐
- 安排和主持 SIG 會議:每週狀態更新、每季回顧/規劃會議以及其他需要的會議
- 在 KubeCon 活動和其他會議中安排和主持文件衝刺
- 與 CNCF 及其白金合作夥伴(包括 Google、Oracle、Azure、IBM 和 Huawei)合作,為 SIG Docs 招募和倡導
- 保持 SIG 順利運作
舉辦有效的會議
為了安排和舉辦有效的會議,這些指南說明了該做什麼、如何做以及為什麼要這樣做。
遵守社群行為準則:
- 以尊重、包容的語言進行尊重、包容的討論。
設定明確的議程:
- 設定明確的議題議程
- 提前發布議程
對於每週會議,將上週的會議記錄複製貼上到會議記錄的「過去會議」部分
協作撰寫準確的會議記錄:
- 記錄會議的討論內容
- 考慮委派記錄員的角色
明確且準確地分配行動項目:
- 記錄行動項目、負責人以及預期的完成日期
視需要進行協調:
- 如果討論偏離議程,請將參與者重新聚焦於當前主題
- 在保持討論重點和尊重大家時間的同時,為不同的討論風格留出空間
尊重大家的時間:
準時開始和結束會議。
有效地使用 Zoom:
- 熟悉 Kubernetes 的 Zoom 指南
- 登入時輸入主持人金鑰以取得主持人角色

在 Zoom 上錄製會議
當您準備好開始錄製時,按一下「錄製到雲端」。
當您準備好停止錄製時,按一下「停止」。
影片會自動上傳到 YouTube。