This documentan is based on Asciidoctor and is automatically provided as HTML on docs.checkmk.com. On the one hand it is possible through this repository to convert the documentation into another file format (e.g. through the Makefile) and gives you the opportunity on the other hand to contribute on the content. We will provide more information about how this is done in the next sections.
There are bugs and typos even in the best work or a topic is not explained in a dimension that would be sufficient. So if you are interested in making the documentation of Checkmk even more better, we are happy to welcome you and of course try to work on corresponding PRs as soon as possible. But every project has it’s requirements and demands and this is no exception. What to consider if you want to contribute and also guides for making your contribution as easy as possible, will be described in the following sections:
| Introduction |
Basic principles about what a good documentation looks like in our point of view. |
| Structure of this git |
Here is explained how we think the repository is structured. |
| Guidance for writing |
Best-Practices and guidance for writing articles in this documentation itself. |
| How to setup your development |
Instructions to setup the most common code editors and for converting adoc files to HTML locally. |
You discovered a problem, bug or typo but you are willing, do not have time or even are not confident enough to contribute directly on this project? Please write us a feedback to [email protected].