A New Home (and Platform) for Our Lagoon Documentation

We are excited to announce that our documentation has moved to a new platform, GitBook, and is now available at https://docs.lagoon.sh! 

We’ve hosted our documentation on ReadtheDocs for several years, which has been solid and worked well, but we wanted an upgrade. Enter GitBook.

Our Journey

From the moment we first started playing with it, we knew it would be a fantastic experience. Documentation needs to be easy to read and navigate. Our new documentation is bright, stylish, and modern. It has beautiful code snippets and call-outs. Best of all, it’s effortless for our team to keep current. 

What sold us on GitBook was that content syncs in two directions! Once we imported all our existing content, no changes were needed to our engineers’ workflow, as they documented their code. Engineers can update the markdown files in our Lagoon GitHub repository as they always have. Still, with GitBook, we also have a WYSIWYG editor that lets us make quick, easy edits and commit them directly to our GitHub repository! Now, we don’t have to check out a branch, make a pull request (and wait for a release) for a quick typo fix. The live preview makes it much easier to keep everything looking good and expands documentation housekeeping to a broader internal audience.

(We may be fans, but this isn’t an advertisement - GitBook is free for open source projects like Lagoon!)

We’ve also rearranged some of our documentation so you can get to the most critical information first. We’ve added new pages, fresh FAQs, a glossary of terms, and links to tutorials and webinars on Lagoon, including videos. We’ve also done a lot of work to make our documentation more accessible and inclusive (though the job is never done!). 

Finally, there is a neat function on each page that lets you give us feedback and tell us how useful you find our documentation, so we can keep improving.

With the upcoming release of Lagoon 2, our documentation will live at https://docs.lagoon.sh, and we will progressively add more components.

For people still using Lagoon 1.x (or earlier), the ReadtheDocs site will remain for the foreseeable future, although it will no longer be updated.

So check out our new documentation, learn about Lagoon, and tell us what you think!