To learn about the basic concepts behind Merlin and how to use it, refer to the User Docs.
To configure / deploy Merlin into a production cluster or troubleshoot an existing deployment, refer to the Maintainer Docs.
To understand the development process and the architecture, refer to the Developer Docs.
All docs are created for Gitbook.
Currently, the user docs and maintainer docs are templated using Jinja2.
The templates can be found under ${folder}/templates
and the values for the templates reside in ${folder}/values.json
. To generate the final docs into ${folder}/generated
, run:
make docs