Server Dokumentation

  • Guten Morgen,


    ich bin auf der Suche nach einer Lösung um Änderungen an einem Server (Server Informationen, Konfigurationsdateien, neu installierte Pakete, Updates etc.) vernünftig zu dokumentieren. Am besten wäre hierbei eine Webbasierte Lösung.


    Ich habe hier im Forum schon gelesen das hierfür durchaus das mediawiki genutzt wird, welches ich aber als oversize betrachte in Hinsicht auf den Funktionsumfang. Oder gibt es für das mediawiki eventuell geeignete Erweiterungen zur besseren Realisierung meines Vorhabens?


    Im Internet habe ich bis dato schon das ein oder andere zu dem Thema gelesen, jedoch keine konkreten Empfehlungen zu passenden Softwarelösungen gefunden.


    BTW: Bei meiner Recherche bin ich zudem auf „etckeeper“ zur Versionierung von Konfigurationsdatein gestoßen. Klingt sehr spannend und könnte sicherlich hilfreich sein gerade bei unproduktiven Systemen wo man schon mal schnell 5-6 unterschiedliche Konfigurationsdatein vorliegen hat.


    Ist etckeeper hier eine gute Wahl oder gibt es hier bessere Alternativen?

  • Ich bevorzuge auch Markdown als Dokumentations-Sprache. Wenn man das in einem Git Repo speichert, hat man auch eine schöne History über alle Änderungen. Das ist oft das Hauptproblem bei anderen Lösungen. Manchmal möchte man ja gerne wissen, wann sich was und warum geändert hat. Da ist Git eine tolle Lösung für und Markdown macht es für den Bearbeiter sehr leicht Änderungen vorzunehmen. Es gibt nichts Schlimmeres als wenn es einem schwer gemacht wird, die Dokumenation zu einem Projekt anzupassen. Dann macht man es nämlich nicht.


    Aber um nochmal einen konkreten Vorschlag zu machen: mkdocs (https://www.mkdocs.org/)

  • Egal wofür man sich entscheidet, ich kann empfehlen die Doku nicht am Server selbst sondern wo anders zu hosten.

    Genau dann wenn etwas nicht funktioniert und man diese daher braucht, ist sie dann vielleicht nämlich nicht oder schlecht zugreifbar.


    Aus meiner Erfahrung ist das konkrete Produkt auch nicht so wichtig, viel wichtiger ist die eigene Disziplin. Wer keine sensiblen Informationen in die Doku schreibt kann auch einfach ein Google-Docs Dokument verwenden, da ist die Historie auch wunderhübsch per Zeitleiste nachvollziehbar und der WYSIWYG Editor für diese Zwecke mehr als ausreichend.