Diese Dokumentation basiert auf Asciidoctor und wird automatisiert als HTML auf docs.checkmk.com bereitgestellt. Über dieses Repository ist es zum einen möglich, die Dokumentation in ein anderes Format zu konvertieren (z.B. über das Makefile) und zum anderen an der Erstellung der Dokumentation teilzuhaben. Wie es möglich ist hier mit mitzuwirken, wird nachfolgend erläutert.
Auch bei sorgfältigster Arbeit schleichen sich immer wieder kleinere Fehler ein, oder es werden Themen nicht in dem Umfang behandelt, wie es vielleicht angebracht wäre. Wenn Du also daran interessiert bist, die Dokumentation von Checkmk zu verbessern, dann freuen wir uns über rege Beteiligung und versuchen entsprechend auch die PRs zeitnahe zu behandeln. Natürlich hat jedes Projekt auch seine Ansprüche und Anforderungen. Wie sie in diesem Projekt aussehen, kann man hier nachlesen:
| Einleitung | Grundprinzipien dazu, wie wir uns eine gute Dokumention vorstellen. |
| Aufbau des Git | Hier wird beschrieben, wie der Aufbau dieses Repository gedacht ist. |
| Leitfaden zum Schreiben | Best-Practices und Hilfestellungen zum Schreiben, um selbst an der Dokumentation mitzuwirken. |
| Hilfe zur Entwicklungsumgebung | Anleitungen für die Arbeit mit Code Editoren und zum lokalen konvertieren nach HTML |
Du hast ein Problem entdeckt, aber keine Lust, keine Zeit oder Du traust Dir es schlicht nicht zu, hier selbst mitzuwirken? Dann schreib uns ein Feedback an feedback@checkmk.com.