Jenkins X 專案

本頁詳細說明 Google 文件季度接受的一項技術撰寫專案詳細資料。

專案摘要

開放原始碼組織：
Jenkins X
技術撰稿人：
Nitin
專案名稱：
重構現有的 Jenkins X docs 網站和 Jenkins X Capabilities Matrix
專案長度：
標準長度 (3 個月)

Project description

這項專案的主要目標是在修正文件相關問題時重構現有的 Jenkins X 說明文件，並準備更新的 Jenkins X 功能矩陣，以及企業雲端服務供應商上 Jenkins X 使用情形的使用者說明文件。此外，這項專案也與 Daniel 合作，共同開發以 OpenShift 為基礎的 Jenkins X 預覽環境基礎架構。

重構現有的 Jenkins X 說明文件的過程中，我會解決一些問題，包括：

  • 啟動 EKS 資源：問題
  • 保管箱在 EKS 中執行失敗，啟動：問題
  • jx 開機文件記錄：問題
  • 保管箱設定所需的文件：問題
  • 無法從本機升級至保管箱：問題
  • 「create」、「install jx」、「boot」與「匯入」的說明文件意見回饋：問題
  • Helm 文件無所不在：問題
  • 改善說明文件，瞭解為何 ChartMuseum、Monocular 和 Docker Registry 未替換為 Nexus 問題
  • 使用 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 功能矩陣和相關使用者說明文件，協助您瞭解如何將 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 功能 (以便在不同的雲端服務供應商上確認)。
  • 針對 Jenkins X 預覽環境基礎架構的目前狀態，與 Daniel 進行討論。
  • 與 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 docs 網站上完成 Jenkins X 預覽環境基礎架構的說明文件。

第 12 週 (11 月 30 日至 12 月 5 日)

  • 完成專案的交付事項，並依據意見回饋重構程式碼 (如有)。
  • 測試 Jenkins X docs 網站的運作情形，包括連結、圖片、超連結及其他項目。
  • 檢查 Jenkins X docs 網站的使用者定義的控制項和導覽。
  • 查看最後的 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 等技術技能的經驗，可以提供完善的說明文件，並解決目前大多數文件相關問題。我對他人能在沒有監督的情況下準時完成專案，