本文已發布超過一年。較舊的文章可能包含過時的內容。請檢查頁面中的資訊自發布以來是否已變得不正確。
使用 Docsy 獲得更好的文件使用者體驗
編者註:Zach 是 Kubernetes 文件特殊興趣小組 (SIG Docs) 的主席之一。
我很榮幸地宣布 Kubernetes 網站 現在採用了 Docsy Hugo 主題。
Docsy 主題改進了網站的組織和導航性,並為改進 API 參考文檔開闢了道路。在經歷了超過 4 年幾乎沒有任何有意義的 UX 改進之後,Docsy 實施了一些技術內容的最佳實踐。該主題使 Kubernetes 網站更易於閱讀,並使各個頁面更易於導航。它為網站帶來了急需的改版。
例如:新增右側邊欄以導航頁面上的主題。不再需要向上捲動才能導航!
該主題為未來改進網站開闢了道路。我對 Docsy 功能最興奮的是該主題的 swaggerui
短代碼,它為從 OpenAPI 規範生成 API 參考文檔提供了原生支援。CNCF 正在與 Google Season of Docs (GSoD) 合作,以在今年第四季實現更好的 API 參考文檔。我們希望被選中,並且我們期待 Google 在 8 月 16 日公佈項目列表。自從我於 2017 年首次開始與 SIG Docs 合作以來,更好的 API 參考文檔一直是我的個人目標。很高興看到目標觸手可及。
SIG Docs 的技術主管之一 Karen Bradshaw 完成了大量繁重的工作,以修復各種網站相容性問題,包括在 2018 年我們 從 Jekyll 遷移到 Hugo 時修復了我們最後的 舊版程式碼。我們的其他技術主管 Tim Bannister 和 Taylor Dolezal 提供了廣泛的審查。
還要感謝 Björn-Erik Pedersen,他提供了關於如何導航 Hugo 升級到 0.60.0 版本 以上的寶貴建議。
CNCF 與位於 BC 省維多利亞的 Gearbox 簽約,將該主題應用於網站。感謝 Aidan、Troy 和團隊的其他成員的所有工作!