DEV Community

Alanna Burke for Lagoon

Posted on

Lagoon Documentation Update

You might notice our documentation now looks a little different - that’s because we’ve moved off of GitBook and are now hosting it on GitHub pages, using a Github action to handle the publishing. The documentation itself is built in MkDocs, using the excellent Material for MkDocs theme

Why the departure from GitBook? While we loved their features, there have always been a couple of minor irritations (mostly as we tried to maintain documents in GitHub and GitBook at the same time). For all the work done to update the tool recently, our initial concerns remain, and in some areas the ability for us to keep our documentation up to date has been critically impaired. We thought about it for a long time, and decided we’d rather keep something so vital under our control, as much as possible.

Additionally, keeping our documentation in GitHub fits in with our team’s existing workflow. We’re also looking into lagoonizing MkDocs, so stay tuned for that!

There should be no functional difference for our users, and we’ve attempted to preserve all the links from previous documentation. If you’ve got any magic MkDocs tips you want to share with us, let us know - we’ve even got a documentation page in our documentation with some information on building and running locally!

After all, we do say that Documentation is like a plant, and half the trick of nurturing a growing plant is knowing when to re-pot it, right?

Check it out at https://docs.lagoon.sh and let us know what you think - we’re going to be able to respond even faster to any updates/additions you may have.

Discussion (0)