本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- Jenkins X
- 技術撰稿人：
- Nitin
- 專案名稱：
- 重構現有的 Jenkins X 說明網站和 Jenkins X 功能矩陣
- 專案長度：
- 標準長度 (3 個月)
Project description
這項專案的主要目標是重構現有的 Jenkins X 說明文件，同時修正文件相關問題，以及準備更新版 Jenkins X 功能矩陣，以及有關企業雲端服務供應商使用 Jenkins X 的使用者說明文件。此外，這項專案還包括與 Daniel 合作，共同開發以 OpenShift 為基礎的 Jenkins X 預覽環境基礎架構。
在重構現有的 Jenkins X 說明文件時，我們會進行的部分問題包括：
- 在 EKS 資源中啟動：問題
- 在 EKS 中使用 Boot 時，Vault 發生問題
- 為 jx 啟動程序編寫說明文件：問題
- 設定保管箱所需的文件：問題
- 無法從本機啟動升級至保管箱：問題
- 說明文件意見回饋：「create」與「install jx」、「boot」與「import」的關係：問題
- Helm 說明文件散落各處：問題
- 改善說明文件，說明為何不以 Nexus 取代 ChartMuseum、Monocular 和 Docker Registry
- 使用 Boot 和 GKE 時無法變更 Docker Registry：問題
- 無法將網域從 nip.io 變更為自訂網域：問題
至於 Jenkins X 功能矩陣，工作涉及 (如下所述) 適用於各雲端服務供應商提供的企業 Kubernetes 服務，即Google Cloud (GKE)、Amazon Web Services (AWS EKS) 和 Azure Cloud (AKS)。
- 透過 Terraform 指令碼和
jx boot在雲端安裝 Jenkins X - 確認這些雲端服務供應商 Kubernetes 服務中的 Kubernetes 版本與 Jenkins X 的相容性。
- 需與 Deane 和 Jenkins X 社群成員討論的其他功能 (例如密鑰、原始碼控製版本或其他項目)。
關於如何設定以 OpenShift 為基礎的 Jenkins X 預覽環境基礎架構，相關工作包括：
- 關於 OpenShift 平台上 Jenkins X 預覽環境基礎架構的設計文件
- 在 OpenShift 中自動建立 Jenkins X 預覽環境
- 在預覽環境更新 Jenkins X 的說明文件
專案交付項目：
- 透過 PR 修正上述文件問題，同時考慮重構現有的 Jenkins X 說明文件。
- 更新 Jenkins X 功能矩陣，以及使用者文件，說明如何在不同雲端服務供應商 (主要為 AKS、EKS 和 GKE 的 Kubernetes 服務) 中使用 Jenkins X。
- 與 Daniel 合作，以 OpenShift 為基礎的 Jenkins X 預覽環境基礎架構。
建議的暫定時間表 (以及任務)：
社群連結 (8 月 17 日至 9 月 13 日)
- 設定技術文件的開發環境，並取得 Cloud 基礎架構存取權，以便處理專案工作。
- 與專案導師討論提案的暫定時程、專案成果，以及工作 (以及工作優先順序)。
- 瞭解並熟悉機構的工作流程、公關審查程序，並參與社群活動。
- 查看 Jenkins X 目前的說明文件狀態。
第 1 週 (9 月 14 日 - 9 月 20 日)
- 瞭解在雲端設定 Jenkins X 的操作說明、目前狀態和說明文件。
- 與 Deane 討論目前的 Jenkins X 功能 (將在不同雲端服務供應商上進行驗證)。
- 與 Daniel 討論以 OpenShift 為基礎的 Jenkins X 預覽環境基礎架構目前的狀態。
- 與 Daniel 合作，在 OpenShift 上設計 Jenkins X 預覽環境基礎架構的架構。
第 2 週 (9 月 21 日至 9 月 27 日)
- 完成 GKE 雲端適用的 Jenkins X 功能矩陣：安裝 Jenkins X，以及準備使用者筆記草稿。
- 著手處理其中一個文件問題，以改善現有的 Jenkins X 說明文件。
第 3 週 (9 月 28 日至 10 月 4 日)
- 針對 GKE 雲端的 Jenkins X 功能矩陣進行作業：安裝 Jenkins X 並準備使用者說明草稿。
- 著手處理其中一個文件問題，以改善現有的 Jenkins X 說明文件。
- 針對 Jenkins X 預覽環境基礎架構 (以 OpenShift 為基礎) 的設計文件進行作業。
第 4 週 (10 月 5 日 - 10 月 11 日)
- 完成 GKE 上 Jenkins X 的使用者說明。
- 著手處理其中一個文件問題，以改善現有的 Jenkins X 說明文件。
第 5 週 (10 月 12 日至 10 月 18 日)
- 針對 Azure 雲端 (AKS) 的 Jenkins X 功能矩陣進行作業：安裝 Jenkins X 並準備使用者說明草稿。
- 著手處理其中一個文件問題，以改善現有的 Jenkins X 說明文件。
- 取得社群成員的意見回饋後，根據 OpenShift 完成 Jenkins X 預覽環境基礎架構的設計文件。
第 6 週 (10 月 19 日至 10 月 25 日)
- 針對 Azure 雲端 (AKS) 的 Jenkins X 功能矩陣進行作業：安裝 Jenkins X 並準備使用者說明草稿。
- 著手處理其中一個文件問題，以改善現有的 Jenkins X 說明文件。
第 7 週 (10 月 26 日至 11 月 1 日)
- 完成 Azure 雲端 (AKS) 的 Jenkins X 功能矩陣：安裝 Jenkins X，以及準備使用者筆記草稿。
- 著手處理其中一個文件問題，以改善現有的 Jenkins X 說明文件。
- 著手設定以 OpenShift 為基礎的 Jenkins X 預覽環境基礎架構。
第 8 週 (11 月 2 日 - 11 月 8 日)
- 完成 AKS 上 Jenkins X 的使用者說明文件。
- 著手處理其中一個文件問題，以改善現有的 Jenkins X 說明文件。
第 9 週 (11 月 9 日至 11 月 15 日)
- 針對 AWS (EKS) 的 Jenkins X 功能矩陣進行作業：安裝 Jenkins X 並準備使用者說明草稿。
- 著手處理其中一個文件問題，以改善現有的 Jenkins X 說明文件。
- 著手設定以 OpenShift 為基礎的 Jenkins X 預覽環境基礎架構。
第 10 週 (11 月 16 日至 11 月 22 日)
- 針對 AWS (EKS) 的 Jenkins X 功能矩陣進行作業：安裝 Jenkins X 並準備使用者說明草稿。
- 著手處理其中一個文件問題，以改善現有的 Jenkins X 說明文件。
第 11 週 (11 月 23 日至 11 月 29 日)
- 完成 EKS 上 Jenkins X 的使用者說明。
- 著手處理其中一個文件問題，以改善現有的 Jenkins X 說明文件。
- 在 Jenkins X 說明文件網站上，完成 Jenkins X 預覽環境基礎架構的說明文件。
第 12 週 (11 月 30 日 - 12 月 5 日)
- 完成專案交付項目，並依據意見回饋重構程式碼 (如果有的話)。
- 測試 Jenkins X 文件網站的運作情形，包括連結、圖片、超連結等。
- 檢查 Jenkins X 說明文件網站的使用者定義控制項和導覽。
- 查看 Jenkins X Capabilites 矩陣的最終呈現方式。
2020 年 12 月 10 日前 技術作家和導師都會提交對專案的評估。
這項提案的專案對 Jenkins X 及其社群有何好處？這個專案將協助 Jenkins X 社群改善說明文件，供 Jenkins X 技術架構、相容性、使用方式和整合方式的參考。完成這個建議專案後，就會有完整、明確且經過技術驗證的 Jenkins X 使用者說明文件，以及 Jenkins X 能力矩陣，以便與不同雲端服務供應商相容。
您預計未來會透過 Jenkins X 獲得哪些好處？在 2020 年 Google 季節性文件計畫結束後，我打算成為 Jenkins X 專案的長期貢獻者，並成為社群的活躍成員。我隨時都會協助其他人 (新手)，並鼓勵他們加入 Jenkins X 社群。我隨時願意著手其他 Jenkins X 專案構想。
以下是讓我最適合參與這個專案的原因：
- 我做事很有條理。我非常期待每週透過網誌文章與專案導師和機構社群即時瞭解專案進度，並定期安排 SIG 文件和電子郵件。
- 將經常向導師和社群成員尋求指導和意見回饋，以便繼續執行工作，並確保每個人都瞭解情況 (包括提到遇到的任何挑戰和/或阻礙點)。
- 定期提交所有編寫的原始碼，以便接受導師和貢獻者的審查，並記錄完成的工作，供社群成員參考。
- 我具備執行這個專案構想所需的所有技術技能，也已經與導師 Deane、Kara 和 Daniel 一起討論專案提案。我已深入瞭解專案提案和其成果。
- 我具備相關技術技能 (Google Cloud、Azure Cloud、AWS、Kubernetes、OpenShift、Hugo 等)，可提供完整的說明文件，並解決目前大部分的說明文件相關問題。我有積極的態度，能獨立完成專案工作，不需要太多監督。