本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- 雲端原生運算基金會 (CNCF)
- 技術文件撰寫者：
- Syam Sundar K
- 專案名稱：
- 更多更佳的 Kubectl 範例
- 專案長度：
- 標準長度 (3 個月)
Project description
這項專案的目的是強化現有的 kubectl 一覽表和參考文件。
以下是這項專案的最終目標： • 建立更多更優質的 kubectl 範例。 • 將 kubectl 範例新增至 kubectl 一覽表。 • 重構 kubectl 文件，盡可能提升實用性。
目標 I - kubectl 範例：
我們會與 CLI 特殊興趣群組密切合作，以便瞭解 Kubernetes 使用者最想要的案例類型，並記錄下來。影響範圍包括改善一覽表中現有的 kubectl 指令，或是在一覽表中新增指令。
目標 II - 提高文件實用性：
為了提昇文件實用性，可執行下列作業：
• 排除新手問題 • 按照特定順序重新排列 kubectl 指令，確保在邏輯流程中能繼續運作
運用更好的指令 / 使用者案例說明來避免新手練習。這看似簡單，但能大幅影響初學者持續學習或放棄學習。舉例來說，透過 kubectl 開始使用 Kubernetes 時，我不確定 Pod 和部署作業之間的差異。我一開始就部署以 nodejs 編寫的後端服務。幾個小時後，我想在幾個小時內關閉 Pod，但我嘗試刪除 Pod，但由於 Pod 需要自行修復，導致其重新建立的 Pod。我剛好想著發生了什麼事，不知為什麼會重建而不是被刪除。在網路上經過數查詢後，我發現刪除 Pod 與刪除部署作業不同。若是受過專業訓練的眼睛，這可能看似簡單，但是清晰的解釋可以消除這種歧義，這就是區分優質文件與優質文件的原因。
按特定順序重新排列 kubectl 指令，以確保邏輯流程中的連續性。如果您像我一樣深深相信自己述說故事，可能會想知道，該如何將述說故事的元素納入含有終端機指令的文件工作表中，這樣說，就能辦得到。我們學到的東西一定都有這樣的流程，可以的話就是一個開始和終點。kubectl 是指令列工具，顯然具有學習曲線，事實上，學習曲線與 Kubernetes 本身的學習曲線恰好相關。由於幾乎所有人都會透過 kubectl (使用網頁版 UI 的人員) 開始與 kubernetes 互動，且由於機器學習的學習曲線與 Kubernetes 的學習曲線密切相關，因此只要變更這些指令的順序，並加入述說故事的元素，就能大幅改善文件效果。舉例來說，您可以提供水平 Pod 自動調度資源等功能，並附上實際例子和插圖說明。
目標 III - 改善文件可用性：
最近將 Kubernetes 網站遷移至 Docsy Hugo 的過程相當不錯，而且文件的觀點也有巨大轉變。雖然遷移成功，但文件空間中仍有大幅改善的空間。
這裡有一些我建議做的調整
• 左側窗格會自動捲動至主要文件的目前使用中部分 - 方便您追蹤目前、即將到來和過去的章節。 • 複製到剪貼簿：部分指令可能很冗長，複製功能非常適合用來處理這些指令。 • 文件檔案的內容格式設定 - 遷移完成後，少數頁面中的內容格式有誤。例如：kubectl 總覽中的「資源類型」區段。這會降低使用者體驗。
這些異動不僅可以改善 Kubernetes 網站的使用者體驗，也能提高使用者的工作效率。