本文已发布超过一年。较旧的文章可能包含过时的内容。请检查页面中的信息自发布以来是否已不再正确。
使用 Docsy 改善文档用户体验
编者按:Zach 是 Kubernetes 文档特殊兴趣小组 (SIG Docs) 的主席之一。
我很高兴宣布 Kubernetes 网站现在采用了 Docsy Hugo 主题。
Docsy 主题改进了网站的组织结构和导航性,并为改进 API 参考文档铺平了道路。在四年多以来缺乏有意义的 UX 改进之后,Docsy 实施了一些技术内容的最佳实践。该主题使得 Kubernetes 网站更易于阅读,单个页面更易于导航。它为网站带来了急需的改进。
例如:在页面右侧添加了一个用于导航主题的边栏。再也不用向上滚动来导航了!
该主题为将来对网站的改进开辟了道路。我最兴奋的 Docsy 功能是该主题的 swaggerui
shortcode,它提供了从 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 和团队的其他成员所做的一切工作!