Our User Guide is based on Asciidoctor, formatted with the AsciiDoc markup language, deposited in this GitHub repository and automatically deployed as HTML on docs.checkmk.com. Through this GitHub repository, it is possible to contribute to the creation of the documentation. How this is possible is explained below.
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 better, we are happy to welcome you and of course try to work on corresponding PRs as soon as possible.
But every project has its 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 and handling of this repository |
Here is described how you deal with the repository. |
| Writing guide |
Best practices and writing assistance to contribute to the documentation yourself |
| How to setup your development environment |
Instructions to setup code editors |
You discovered a problem, bug or typo but you are not 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].