高階貢獻
本頁面假設您已瞭解如何為新內容做貢獻以及評審他人工作,並已準備好學習更多貢獻方式。您需要使用 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 和其他 SIG 的代表。要了解有關 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 協調員合作,為新貢獻者識別“好開始”議題。
- 指導新貢獻者完成他們向 docs 倉庫提交的第一個 PR。
- 幫助新貢獻者建立更復雜的 PR,以成為 Kubernetes 成員。
- 贊助貢獻者,幫助他們成為 Kubernetes 成員。
- 每月舉辦會議,幫助和指導新貢獻者。
當前的新貢獻者大使將在每次 SIG-Docs 會議和 Kubernetes #sig-docs 頻道中公佈。
贊助新貢獻者
SIG Docs 評審員可以贊助新貢獻者。
當一位新貢獻者成功提交了至少一個 Kubernetes 儲存庫的 5 個實質性拉取請求後,他們就有資格申請成為 Kubernetes 組織的成員。該貢獻者的成員資格需要獲得兩位已經是評審員的贊助人的支援。
新的文件貢獻者可以透過在 Kubernetes Slack 例項上的 #sig-docs 頻道或 SIG Docs 郵件列表上提問來請求贊助者。如果您對申請人的工作充滿信心,請主動提出贊助。當他們提交成員申請時,回覆申請 "+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 和華為)招募並代表 SIG Docs 發聲。
- 確保 SIG 順利執行。
執行有效的會議
要安排和執行有效的會議,以下指南將展示如何做、怎麼做以及為什麼這麼做。
遵守社群行為準則。:
- 進行尊重、包容的討論,使用尊重、包容的語言。
設定清晰的議程:
- 設定清晰的議題列表。
- 提前釋出議程。
對於每週會議,將上一週的會議記錄複製貼上到筆記的“過往會議”部分。
協作進行準確的會議記錄。:
- 記錄會議的討論內容。
- 考慮委託記錄員的角色。
清晰準確地分配行動項。:
- 記錄行動項、分配給誰以及預期的完成日期。
視情況進行主持。:
- 如果討論偏離了議程,將參與者重新聚焦到當前議題上。
- 為不同的討論風格留出空間,同時保持討論的焦點並尊重大家的時間。
尊重大家的時間。:
準時開始和結束會議。
有效使用 Zoom。:
- 熟悉 Kubernetes 的 Zoom 指南。
- 登入時透過輸入主機金鑰來認領主機角色。

在 Zoom 上錄製會議。
當您準備好開始錄製時,點選“錄製到雲端”。
當您準備好停止錄製時,點選“停止”。
影片會自動上傳到 YouTube。