文件審閱流程
Istio 文件工作組 (WG) 的維護人員和工作組負責人會核准對 Istio 網站的所有變更。
文件審閱者是受信任的貢獻者，會核准符合審閱標準中所述接受標準的內容。所有內容審閱都遵循審閱內容 PR中所述的流程。
只有文件維護人員和工作組負責人才能將內容合併到 istio.io 儲存庫。
Istio 的內容通常需要在短時間內審閱，並非所有內容都具有相同的相關性。貢獻的臨時性質和有限的審閱者數量使得內容審閱的優先順序對於大規模運作至關重要。此頁面提供明確的審閱標準，以確保所有審閱工作都能一致、可靠且遵循相同的品質標準。
審閱內容 PR
文件審閱者、維護人員和工作組負責人遵循明確的流程來審閱內容 PR，以確保所有審閱都是一致的。流程如下
- 貢獻者將新的內容 PR 提交到 istio.io 儲存庫。
- 審閱者執行內容審閱，並判斷其是否符合接受標準。
- 如果貢獻者尚未新增，審閱者會新增任何與內容相關的技術工作組。
- 貢獻者和審閱者會共同合作，直到內容符合所有必要的接受標準，並且問題都已解決。
- 如果內容很緊急，且符合補充接受標準需要付出大量努力，則審閱者會在 istio.io 儲存庫上提交追蹤問題，以在稍後解決問題。
- 貢獻者會解決審閱者和貢獻者同意的所有必要和補充意見。在追蹤問題中提交的任何意見都會在稍後解決。
- 當技術工作組（WG）領導或維護者批准內容的 PR（Pull Request，拉取請求）後，審閱者即可批准該 PR。
- 如果文件工作組的維護者或領導審閱了內容，他們不僅會批准，還會合併內容。否則，維護者和領導會自動收到審閱者批准的通知，並優先批准和合併已審閱的內容。
以下圖表描述了這個流程
- 貢獻者執行灰色形狀中的步驟。
- 審閱者執行藍色形狀中的步驟。
- 文件維護者和工作組領導執行綠色形狀中的步驟。
追蹤問題
當審閱者在審閱流程中提交後續問題時，GitHub 問題必須包含以下資訊：
- 關於內容未能滿足的補充驗收標準的詳細資訊。
- 原始 PR 的連結。
- 技術領域專家（SME）的使用者名稱。
- 用於分類問題的標籤。
- 工作量估計：審閱者提供他們與原始貢獻者一起解決剩餘問題所需時間的最佳估計。
審閱標準
我們的審閱流程透過使審閱標準透明並將其應用於所有內容貢獻，來支持我們的行為準則。
標準分為兩個層級：必要和補充。
必要的接受標準
- 技術準確性：至少一位技術工作組領導或維護者審閱並批准內容。
- 正確標記：所有程式碼檢查和測試均通過。
- 語言：內容必須清晰易懂。若要了解更多資訊，請參閱 Google 開發者樣式指南的重點和一般原則。
- 連結和導覽：內容沒有損壞的連結，且網站能正確建置。
補充接受標準
- 內容結構：資訊結構能增強讀者的體驗。
- 一致性：內容符合Istio 貢獻指南中的所有建議。
- 樣式：內容符合Google 開發者樣式指南。
- 圖形資源：圖表遵循 Istio 圖表建立指南。
- 程式碼範例：內容提供相關、可測試且可運作的程式碼範例。
- 內容重用：任何可重複的內容都遵循使用樣板文字的可重用策略。
- 詞彙表：新術語會新增至詞彙表，並附上清晰的定義。