这篇文章已超过一年。较旧的文章可能包含过时的内容。请检查页面中的信息自发布以来是否已变得不正确。
使用 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 参考。我们希望被选中,并且我们期待 8 月 16 日 Google 公布的项目列表。自从我 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 和团队的其他成员所做的全部工作!