本文发表于一年多前。旧文章可能包含过时内容。请检查页面中的信息自发布以来是否已变得不正确。

使用 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 BannisterTaylor Dolezal 提供了广泛的审查。

还要感谢 Björn-Erik Pedersen,他为如何进行 0.60.0 版本之后的 Hugo 升级提供了宝贵的建议。

CNCF 与位于不列颠哥伦比亚省维多利亚的 Gearbox 签订合同,将该主题应用于网站。感谢 Aidan、Troy 以及团队其他成员的所有工作!