本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- 雲端原生運算基金會 (CNCF)
- 技術文件撰寫者：
- feloy
- 專案名稱：
- 更新 Kubernetes 網站提供 API 參考資料的方式
- 專案長度：
- 標準長度 (3 個月)
Project description
目前，Kubernetes API 參照是大型 HTML 文件，來源為 Swagger 規格，由網站存放區代管的指令碼產生，且可新增至此網站存放區。
Kubernetes 說明文件網站則是使用網站存放區中以 Markdown 格式編寫的文件，使用 Docsy Hugo 主題建構而成。
這項專案的目標是將產生 Kubernetes API 參考資料的流程整合至建構說明文件網站的程序中。
具體來說，我們會聚焦於 swaggerui 簡碼，這是一種 swagger-ui 的包裝函式 (由 Docsy Hugo 主題和特定工具提供)，可讓您在 Kubernetes 說明文件流程中插入 API 規格的部分內容。
由於 swagger-ui 可以輸出 swagger 檔案中所述的完整規格，但不包含特定工具 (請參閱 8)，因此需要特定工具。Kubernetes API 過大，無法顯示在單部分中(輸出範例)。我們會考慮兩種做法：
第一種方法是建立多個 Swagger 檔案，從 (10) 提供的來源中，各個 Kubernetes API 群組(core/v1、apps/v1、...) 各建立一個，並使用這些檔案，做為 Kubernetes 說明文件網站上特定位置的 swaggerui 排序程式碼。
第二種做法是建立工具，以便輸入在 (11) 中取得的 Kubernetes API 完整項目檔案，並輸出用於特定端點或數量有限的端點新檔案，以及相關聯的資源和定義。接著，您可以使用這些交換器檔案，輸入 Kubernetes 說明文件網站中特定位置的 swaggerui 簡碼。
由於規格來源 (10 和 11) 存放在文件來源以外的存放區中，因此我們必須設法在文件存放區變更時自動更新說明文件存放區。
由於 Kubernetes 說明文件提供多種不同語言，因此我們會特別留意您發布 Kubernetes API 參考資料的翻譯內容。