kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Blog post: Hugo migration (#8320) 

* Supersedes #8288 with a post-Hugo location

* Adjusted time for earlier publishing

* Dropped blog post into http/

* Another time adjustment

* Update front matter

* Testing a location change

* Adding a top-level heading

* More tweaks
This commit is contained in:
Zach Corleissen 2018-05-05 18:57:43 +02:00 committed by GitHub
parent 7f3b633aa0
commit d139fe6527
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
content/en/blog/_posts/2018-05-05-hugo-migration.md Normal file
View File

@ -0,0 +1,31 @@
---
title: 'Docs are Migrating from Jekyll to Hugo'
date: 2018-05-05
author: zcorleissen
slug: hugo-migration
---
**Author**: [Zach Corleissen](https://www.cncf.io/people/staff/) (CNCF)
## Changing the site framework
After nearly a year of investigating how to enable multilingual support for Kubernetes docs, we've decided to migrate the site's static generator from Jekyll to [Hugo](https://gohugo.io/).
What does the Hugo migration mean for users and contributors?
### Things will break
Hugo's Markdown parser is [stricter than Jekyll's](https://gohugo.io/getting-started/configuration/#configure-blackfriday). As a consequence, some Markdown formatting that rendered fine in Jekyll now produces some unexpected results: [strange left nav ordering](https://github.com/kubernetes/website/issues/8258), [vanishing tutorials](https://github.com/kubernetes/website/issues/8247), and [broken links](https://github.com/kubernetes/website/issues/8246), among others.
If you encounter any site weirdness or broken formatting, please [open an issue](https://github.com/kubernetes/website/issues/new). You can see the list of issues that are [specific to Hugo migration](https://github.com/kubernetes/website/issues?q=is%3Aissue+is%3Aopen+Hugo+label%3A%22Needs+Docs+Review%22).
### Multilingual support is coming
Our initial search focused on finding a language selector that would play well with Jekyll. The projects we found weren't well-supported, and a prototype of one plugin made it clear that a Jekyll implementation would create technical debt that drained resources away from the quality of the docs.
We chose Hugo after months of research and conversations with other open source translation projects. (Special thanks to [Andreas Jaeger](https://twitter.com/jaegerandi?lang=da) and his experience at OpenStack). Hugo's [multilingual support](https://gohugo.io/content-management/multilingual/) is built in and easy.
### Pain now, relief later
Another advantage of Hugo is that [build performance](https://gohugo.io/troubleshooting/build-performance/) scales well at size. At 250+ pages, the Kubernetes site's build times suffered significantly with Jekyll. We're excited about removing the barrier to contribution created by slow site build times.
Again, if you encounter any broken, missing, or unexpected content, please [open an issue](https://github.com/kubernetes/website/issues/new) and let us know.