Evaluation und Aufbau eines webbasierten Dokumentationsservers

From Lsdf
Revision as of 17:17, 10 October 2019 by Nico.schlitter (talk | contribs) (Created page with "Bei der täglichen Arbeit im Rechenzentrum spielt die Dokumentation von Prozessen und Konfigurationen eine wichtige Rolle. Aufgrund ihrer Einfachheit nutzen wir dafür die Mar...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Bei der täglichen Arbeit im Rechenzentrum spielt die Dokumentation von Prozessen und Konfigurationen eine wichtige Rolle. Aufgrund ihrer Einfachheit nutzen wir dafür die Markdown [1] Syntax und erzeugen Text-Dateien mit entsprechenden Inhalt.

Zur Dokumentation größerer Projekte werden mehrere Dateien in Verzeichnisstrukturen abgelegt und über das Versionierungs-Werkzeug git [2] versioniert.

Ziel des Praktikums ist die Evaluation von vorhandenen Frameworks, um das Erzeugen, Anzeigen und Verwalten von projektbezogener Dokumentation zu vereinfachen. Es müssen Evaluierungskriterien (z.B. git-Integration, Authentifizierung, Autorisierung) entwickelt und anschließend auf existierende Frameworks angewendet werden. Nach Auswahl einer kleinen Anzahl geeigneter Frameworks werden dieses auf einem Linux-Server installiert und getestet.

Die Praktikumsergebnisse werden am Ende in einem Vortrag inkl. kurzer Demo vorgestellt. Die Evaluierung vorhandener Frameworks sollte in einem kurzen Bericht dokumentiert werden.

Voraussetzungen

  • Grundkenntnisse über git-Nutzung [1]
  • Grundkenntnisse über Markdown [2]
  • Grundkenntnisse über Linux Administration

Kontakt

nico.schlitter@kit.edu

Weitere Informationen

[1]: https://de.wikipedia.org/wiki/Git [2]: https://de.wikipedia.org/wiki/Markdown