本文已发布超过一年。较旧的文章可能包含过时的内容。请检查页面中的信息自发布以来是否仍正确。

文档正在从 Jekyll 迁移到 Hugo

更改网站框架

经过近一年的调研如何为 Kubernetes 文档启用多语言支持,我们决定将网站的静态生成器从 Jekyll 迁移到 Hugo

Hugo 迁移对用户和贡献者意味着什么?

事情会出问题

Hugo 的 Markdown 解析器 与 Jekyll 不同且更严格。因此,一些在 Jekyll 中正常渲染的 Markdown 格式现在会产生一些意外结果:包括 奇怪的左侧导航排序教程消失断开的链接 等。

如果您遇到任何网站异常或格式错误,请提交一个 Issue。您可以查看与 Hugo 迁移相关的特定 Issue 列表

即将推出多语言支持

我们最初的搜索侧重于找到一个能与 Jekyll 良好配合的语言选择器。我们找到的项目支持度不高,而且一个插件的原型清楚地表明,Jekyll 的实现会产生技术债,消耗文档质量方面的资源。

经过数月的调研以及与其他开源翻译项目的交流后,我们选择了 Hugo。(特别感谢 Andreas Jaeger 及其在 OpenStack 的经验)。Hugo 的多语言支持 是内置且易用的。

短暂的痛苦,长远的轻松

Hugo 的另一个优势是,其构建性能 在规模增大时仍能很好地扩展。当页面超过 250 个时,使用 Jekyll 构建 Kubernetes 网站的时间会显著增加。我们很高兴能消除由于网站构建时间缓慢而造成的贡献障碍。

再次强调,如果您遇到任何损坏、丢失或意外内容,请提交一个 Issue 并告知我们。