efa74c5c6e
ac2c4a487 Update documentation for Ugly URLs (#1082) 88bdec17a Change 072.0 to 0.72.0 in release post's description 2aa7d7818 Update rss.md (#1104) c80677aeb Update quick-start.md (#1076) d04196bbd Minor spelling and capitalization fixes 837d2feba Fixed spelling mistake 67dc78e12 Update installing.md ce280c5d6 Update relurl.md bb4d0e703 Capitalization and Redirecting URL fixes e1fecada0 Update partials.md 1d99bb182 Typos and whitespacing issues fixed b20dba125 actually fix index function link this time f47d6f1e3 Fixing typos, whitespace issues and links dc82309b9 fix link to the index function 1eab0cbea add missing word (#1130) 9c3ee62ae more fixes e9bc5880a whitespace, typos and HTTPS fixes 93b806493 Add missing word to Module section 80ced9062 Display image on page bundles page. 727029b0a Update index.md 51fc48e4d Release 0.72.0 1ff68ac3b releaser: Add release notes to /docs for release of 0.72.0 f74a25b92 common/maps: Add Scratch.Values 2fd83db96 Add redirect support to the server bdfccf9f4 Fix typo in install instructions e12737ea6 Create SUPPORT.md git-subtree-dir: docs git-subtree-split: ac2c4a4871e90ddfb180f23704ce7ec9023529ca
3.6 KiB
| title | date | description | siteURL | byline | aliases | |
|---|---|---|---|---|---|---|
| 1Password Support | 2018-02-22 | Showcase: "Compiles 400 pages in five languages in the blink of an eye." | https://support.1password.com/ | [Mitch Cohen](https://github.com/mitchchn), Documentation Team Lead |
|
At 1Password, we used to go through a different documentation platform every month: blog engines, ebooks, wikis, site generators written in Ruby and JavaScript. Each was inadequate in its own special way. Then we found Hugo. We made one last switch, and we're glad we did.
Not all static site generators are created equal
Finding a tool that will make your customers, writers, designers, and DevOps team happy is no easy task, but we managed it with Hugo:
Hugo is static. We're a security company, so we swear by static sites and use them wherever possible. We feel much safer pointing customers at HTML files than at a complicated server which needs to be hardened.
Hugo is Go. We love the Go programming language at 1Password, and we were delighted to learn that Hugo used the same Go template syntax that our designers and front-end developers had already mastered.
Hugo is FAST. Our previous static site generator took nearly a minute to compile our (then much smaller) site. Developers might be used to this, but it wasn't cutting it for writers who wanted to see live previews of their work. Hugo did the same job in milliseconds, and to this day compiles 400 pages in five languages in the blink of an eye.
Hugo is flexible. Thanks to Hugo's content and layout system, we were able to preserve our existing file and folder structure and port our entire production site in a few days. We could then create new content types that weren't possible before, like these snazzy showcases.
Hugo is great for writers. Our documentation team was already comfortable with Markdown and Git and could start creating content for Hugo with zero downtime. Once we added shortcodes, our writers were able to dress up articles with features like platform boxes with just a bit of new syntax.
Hugo has an amazing developer community. Hugo updates are frequent and filled to the brim with features and fixes. As we developed the multilingual version of our site, we submitted PRs for features we needed and were helped through the process by @bep and others.
Hugo is simple to deploy. Hugo has just the right amount of configuration options to fit into our build system without being too complicated.
Tech specs
- 1Password Support uses Hugo with a custom theme. It shares styles and some template code with 1Password.com, which we also moved to Hugo in 2016.
- Code and articles live in a private GitHub repository, which is deployed to a static content server using Git hooks.
- Writers build and preview the site on their computers and contribute content using pull requests.
- We use Hugo's multilingual support to build the site in English, Spanish, French, Italian, German, and Russian. With the help of Hugo, 1Password Support became our very first site in multiple languages.
- Our contact form is a single-page React app. We were able to integrate it with Hugo seamlessly thanks to its support for static files.
- The one part of the support site which is not static is our search engine, which we developed with Elasticsearch and host on AWS.