Hi all,
We want to develop a local OOD user guide, and don’t love any documentation systems we’ve used in the past. I’m curious to know if anyone can recommend a documentation system that uses markdown.
Thanks!
Sarah
I built our OOD docs system using MkDocs: https://www.mkdocs.org/
We deploy and customize OOD via Ansible, and I was able to access Ansible variables for OOD along with some strategic set_fact commands to look up cluster configs, resources, etc, and then templatize various pages so they are fully dynamic depending on which cluster/environment the docs are built for.
It was one of those projects that was sort of fidgety and painful getting it all working, but once it was in place, it works rather nicely to ensure the docs are (almost) always up to date.
Neat, thanks! The two things I’m hearing about most often are mkdocs and docusaurus, so I’ll definitely research mkdocs further.
Cheers,
Sarah