本文發表於一年多前。舊文章可能包含過時內容。請檢查頁面中的資訊自發布以來是否已變得不正確。
使用 Docsy 獲得更好的文件使用者體驗
編者注:Zach 是 Kubernetes 文件特別興趣小組 (SIG Docs) 的主席之一。
我很高興地宣佈 Kubernetes 網站現在採用了 Docsy Hugo 主題。
Docsy 主題改進了網站的組織結構和可導航性,併為改進 API 參考文件開闢了道路。在四年多沒有進行有意義的使用者體驗改進之後,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,他為如何進行 0.60.0 版本之後的 Hugo 升級提供了寶貴的建議。
CNCF 與位於不列顛哥倫比亞省維多利亞的 Gearbox 簽訂合同,將該主題應用於網站。感謝 Aidan、Troy 以及團隊其他成員的所有工作!