Unser Handbuch basiert auf Asciidoctor, wird mit der Auszeichnungssprache (markup language) AsciiDoc formatiert, in diesem GitHub Repository abgelegt und automatisiert als HTML auf docs.checkmk.com bereitgestellt. Über dieses GitHub Repository ist es möglich, an der Erstellung der Dokumentation mitzuwirken. Wie das möglich ist, 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 und Umgang mit diesem Repository |
Hier wird beschrieben, wie Du mit dem Repository umgehst. |
| Leitfaden zum Schreiben |
Best Practices und Hilfestellungen zum Schreiben, um selbst an der Dokumentation mitzuwirken. |
| Hilfe zur Entwicklungsumgebung |
Anleitung für die Arbeit mit Code Editoren. |
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 [email protected].