Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.38 KB

File metadata and controls

50 lines (32 loc) · 2.38 KB

Das offizielle Checkmk Handbuch

Willkommen

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.

Zur Dokumentation beitragen

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 Deine Anregungen zeitnah zu behandeln.

GitHub-Issue

Ein GitHub-Issue ist der von uns bevorzugte Weg. Füge einen Link auf den betroffenen Abschnitt im Artikel des Checkmk-Handbuchs hinzu, zitiere gegebenenfalls die Textstelle und beschreibe das Problem möglichst konkret. Mit diesem Link kannst du ein neues GitHub-Issue erstellen.

Du kannst auf GitHub auch einen Pull Request (PR) stellen. Allerdings hat sich in der Vergangenheit gezeigt, dass ein PR in den meisten Fällen von uns nicht einfach übernommen werden konnte, da z.B. auch eine andere Sprache oder ein anderer Branch von der Korrektur betroffen waren. Außerdem verwenden wir seit einiger Zeit in vielen Artikeln spezielle AsciiDoc-Makros, die es für Außenstehende schwierig machen, den Quelltext zu lesen und einen alternativen Text vorzuschlagen.

Feedback

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.