本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- Jenkins X
- 技術文件撰寫者：
- Nitin
- 專案名稱：
- 重構現有的 Jenkins X 文件網站和 Jenkins X Capabilities Matrix
- 專案長度：
- 標準長度 (3 個月)
Project description
這項專案的主要目標是重構現有的 Jenkins X 說明文件，同時修正文件相關問題、準備新版 Jenkins X 功能矩陣，以及有關在企業雲端服務供應商上使用 Jenkins X 的使用者說明文件。此外，這項專案也涉及與 Daniel 合作，共同開發以 OpenShift 為基礎的 Jenkins X 預覽環境基礎架構。
在重構現有的 Jenkins X 說明文件時，我正在處理的部分問題包括：
- 在 EKS 資源中啟動：問題
- 保管箱在 EKS 中執行啟動程序失敗：問題
- jx 開機程序的文件 Envars：問題
- 保管箱設定所需的文件：問題
- 無法從本機啟動升級作業到保管箱：問題
- 「建立」、「安裝 Jx」、「啟動」與「匯入」的說明文件意見回饋關係：問題
- Helm 說明文件一切就緒：問題
- 改善說明文件，瞭解為何 ChartMuseum、單聲道和 Docker Registry 不會替換為 Nexus 問題
- 使用啟動 + 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 和 Jenkins X 在這些雲端服務供應商 Kubernetes 服務的相容性。
- 與 Deane 和 Jenkins X 社群成員討論的任何其他功能 (例如保管箱的密鑰、原始碼控製版本或其他功能)。
關於根據 OpenShift 設定 Jenkins X 預覽環境基礎架構的工作，相關工作包括：
- 在 OpenShift 平台上設計 Jenkins X 預覽環境基礎架構的文件
- 在 OpenShift 中自動建立 Jenkins X 預覽環境
- 更新預覽環境上的 Jenkins X 說明文件
專案交付項目：
- 透過 PR 修正上述文件問題，考慮重構現有的 Jenkins X 說明文件。
- 更新 Jenkins X 功能矩陣，並為使用者提供說明文件，瞭解如何將 Jenkins X 與其他雲端服務供應商搭配使用 (Kubernetes 服務主要是 AKS、EKS 和 GKE)。
- 與 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 說明文件。
- 運用以 OpenShift 為基礎的設計文件 (適用於 Jenkins X 的預覽環境基礎架構)。
第 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 在未來獲得哪些好處？等到 Google 2020 年 Google 文件季結束後，我計劃成為社群中的活躍成員，成為 Jenkins X 專案的長期貢獻者。我一直在協助他人 (新進人員)，並鼓勵他們參與 Jenkins X 社群。我很樂意構思其他 Jenkins X 專案構想。
促使我處理這項專案的一些原因：
- 我很習慣且井然有序，我非常期待系統每週透過網誌文章和機構社群分享一次 SIG 文件和電子郵件，以便掌握專案導師和機構社群的進度。
- 他們會經常在尋求指引及參考導師和社群成員的意見，藉此推動工作進度並確保每個人都能瞭解一致 (包括提及任何挑戰和/或封鎖積分)。
- 定期修訂所有原始碼，以便將程式碼交由導師審查、貢獻者並記錄完成的工作，以供社群成員參考。
- 我具備完成這項專案所需的所有技術技能，也曾與導師 Deane、Kara 和 Daniel 討論專案提案。我對於專案提案和交付項目有深入的瞭解。
- 我曾擁有相關技術技能 (Google Cloud、Azure Cloud、AWS、Kubernetes、OpenShift 和 Hugo 等)，以提供完整的說明文件，並解決大多數的說明文件相關問題。我能抱持正面態度，人人都能在沒有監督的情況下，準時完成專案。