Dokumentations für Root-Server-Setup und weitere Projekte?

[TimmyDuese]

Hallo zusammen,

ich stehe gerade vor der Aufgabe, einen Root-Server aufzusetzen, und da dies mein erstes Mal ist, möchte ich den gesamten Prozess gründlich dokumentieren. Ziel ist es, eine ordentliche und nachvollziehbare Dokumentation zu erstellen, die mir auch in Zukunft als Referenz dienen kann.

Derzeit setze ich den Root-Server auf einer VM in meinem Heimnetz auf, um mich mit der ganzen Sache vertraut zu machen, bevor ich einen scharfen Server schalte.

Ich habe meine Auswahl an Software auf zwei Optionen eingegrenzt: Obsidian und DokuWiki. Beide scheinen interessante Möglichkeiten zu bieten, aber ich bin mir unsicher, welche die beste Wahl für mein Projekt ist.

Meine Fragen an euch:

• Welche Erfahrungen habt ihr mit Obsidian oder DokuWiki bei der Dokumentation technischer Projekte, insbesondere beim Aufsetzen von Servern?
• Gibt es wichtige Vor- oder Nachteile, die ich bei der Entscheidung berücksichtigen sollte?
• Wie geht ihr in Obsidian mit der Erstellung von Inhaltsverzeichnissen um? Gibt es Plugins oder Workarounds, die ihr empfehlen könnt?
• Gibt es vielleicht noch andere Tools oder Software, die ich bisher nicht in Erwägung gezogen habe und die sich gut für meine Zwecke eignen könnten?

Ich plane, die gewählte Software auch für zukünftige Projekte einzusetzen, daher ist es mir wichtig, eine flexible und effiziente Lösung zu finden.

Ich freue mich auf eure Ratschläge und Erfahrungen!

Vielen Dank im Voraus für eure Hilfe!

 

[andy_0]

Ich würde erst einmal empfehlen vlt auf Cloudron oder Yunohost zu setzen. Da kann man vieles damit an das System abgeben.

Zur Doku Software: ich würde vermutlich auf wiki.js setzen. ABER: wir kennen ja deine Anforderungen nicht. Unterschiedlicher als Obsidian (Notizen) und DokuWiki kann es fast nicht sein. Verschiedene Systeme haben verschiedene Nutzungskonzepte. Je nachdem nutzt man das integrierte Wiki System in Gitea / Gitlab oder so mit.

 

[madmax2010]

DokuWiki

Eigentlich gute, aber in 2024 wuerde ich doch eher Outline oder vllt noch WikiJS nehmen

Je nachdem nutzt man das integrierte Wiki System in Gitea / Gitlab oder so mit.

Auch super

 

[gaym0r]

• Welche Erfahrungen habt ihr mit Obsidian oder DokuWiki bei der Dokumentation technischer Projekte, insbesondere beim Aufsetzen von Servern?

DokuWiki nutzen wir (noch). Ist halt etwas altbacken und manche Sachen (z.B. Bilder reinladen) sind nicht ganz so schnell und einfach wie man es heutzutage gerne hätte.

Obsidian hatte ich mir mal als Alternative zu Jolin angesehen, welches ich persönlich für mich nutze. Bin bei Jolin geblieben.
Lösungen wie Joplin oder Obisidian find ich für einzelne Personen besser im Vergleich zu nem Wiki.

Und: Doku ist wichtig, aber betreib kein Overengineering damit!

 

[TheBeastMaster]

Obsidian ist ❤️

Ich erstelle eigentlich alle Dokumentationen in Obsidian und nicht nur das. Obsidian ist für mich mittlerweile einer der wichtigsten Applikationen geworden, eben weil es so unfassbar flexibel ist zeitgleich aber auch einfach sein kann (es KANN aber auch komplex). Ich nutze Obsidian für technische Dokumentationen für meinen Heimserver/Dienste, als Umgebung für Pen&Paper kram, als Notizapp, als Ablage von MD Files von github Projekten und vieles mehr.

Aber zu deinen Fragen:

Welche Erfahrungen habt ihr mit Obsidian oder DokuWiki bei der Dokumentation technischer Projekte, insbesondere beim Aufsetzen von Servern?

Ich kann hier nur für Obsidian spechen und hier hab ich nur positive Erfahrungen. Wenn man sich bisschen in Markdown einarbeitet oder ein entsprechendes Hilfsplugin verwendet, ist es ein leichtes strukturierte Dokus zu erstellen. Ich habe für diese Zwecke sogar Templates erstellt. z.B. für Assets.

Gibt es wichtige Vor- oder Nachteile, die ich bei der Entscheidung berücksichtigen sollte?

Ich denke sowohl Dokuwiki als auch Obsidian oder Joplin sind für den Einsatzzweck geeignet. Da ich persönlich mit Obsidian aber nicht nur technische Dokumentationen erstelle sondern diverse Anwendungsgebiete habe, ist es für mich das Tool der Wahl.

Wie geht ihr in Obsidian mit der Erstellung von Inhaltsverzeichnissen um? Gibt es Plugins oder Workarounds, die ihr empfehlen könnt?

Ich verwende dafür 2 Plugins. Folder Notes von Lost Paul und Waypoint von Idrees Hasan. Damit lassen sich schnell und unkompliziert Inhaltsverzeichnisse erstellen. Ich hab hier mal ein Video von Youtube rausgesucht das die Funktionalität gut beschreit und darstellt: Link
Alternative dazu wäre das Dataview Plugin, mit dem man sowas auch realisieren kann. Ich empfehle für den Einstieg aber erstere Lösung.

Gibt es vielleicht noch andere Tools oder Software, die ich bisher nicht in Erwägung gezogen habe und die sich gut für meine Zwecke eignen könnten?

Mir fällt da noch Logseq und Trillium Notes ein. Logseq fand ich persönlich nicht Intuitiv, ich will nicht Jahrelang eine Doku lesen ich will eine erstellen

Trillium Notes finde ich sympatisch, da sowohl im Browser als auch als Client nutzbar, selfhostet und publish fähig.