Support #1206
open
Dokumentation der Komponenten und Datenflüsse
50%
Description
Es wird eine entsprechende Projekt- und Softwaredokumentation der Komponenten und Datenflüsse zwischen den einzelnen Modulen benötigt. Diese sollte auf die einzelnen Nutzergruppen zugeschnitten sein.
Updated by Udo Daniel Walter over 5 years ago
- Due date deleted (
10/31/2018) - Status changed from New to In Progress
- Einrichtung/Deployment des Servers
- Technische Dokumentation der REST API
- Funktionen und Benutzung des BAS (mit Webapp und API)
- Workflows der verschiedenen Nutzergruppen
Updated by Dirk von Suchodoletz over 5 years ago
- Due date set to 02/28/2019
- Assignee set to Udo Daniel Walter
Bitte Status dieses Tickets aktualisieren.
Updated by Udo Daniel Walter about 5 years ago
- % Done changed from 0 to 30
Wir haben angefangen eine Dokumentation in Markdown zu schreiben, aus dem dann sehr einfach mit VuePress ein benutzerfreundliches Handbuch in Form einer statischen Webseite generiert werden kann.
Das CSS haben wir so angepasst, dass das Design der generierten Seite zu unserer Webapp passt.
Updated by Christian Rößler about 5 years ago
- Priority changed from Normal to High
Insbesondere die Dokumentation für die Anwender des BAS "Funktionen und Benutzung des BAS (mit Webapp und API), Workflows der verschiedenen Nutzergruppen" sollte bald zur Verfügung stehen. Ich lese gern Korrektur, wenn nötig.
Updated by Jonathan Bauer about 5 years ago
Udo Daniel Walter wrote:
Wir haben angefangen eine Dokumentation in Markdown zu schreiben, aus dem dann sehr einfach mit VuePress ein benutzerfreundliches Handbuch in Form einer statischen Webseite generiert werden kann.
Das CSS haben wir so angepasst, dass das Design der generierten Seite zu unserer Webapp passt.
Das heißt das soll in der Webseite integriert werden - schick! Wann? :) Sehe davon bisher nichts. Auch wenn's nicht vollständig ist könnt ihr es ruhig mal live schalten....
Updated by Christian Rößler about 5 years ago
- Priority changed from High to Urgent
Updated by Jannik Schönartz about 5 years ago
Die Doku wird nicht direkt in die BAS Website integriert, sondern es ist eine eigene VuePress (Node) Anwendung.
Ist aber auch im Git. Live ist das ganze natürlich schon lange. Nur haben wir euch den Link nie gegeben. ;)
https://bas.intra.uni-freiburg.de/documentation
Für das User Management Modul haben wir Screenshots gebastelt und einen kurzen Text dazu geschrieben. Ist aber auch noch nicht commited.
Das könnt ihr euch aber gerne auf dem Testserver anschauen:
Ist noch nicht viel, aber wir haben uns auf ein Einheitliches Screenshot/Doku Schema einigen müssen.
Updated by Dirk von Suchodoletz about 5 years ago
Der Link liefert leider keine Dokumentation, eine statisch gerenderte Version darf gerne hier auch als angehängte Datei abgelegt werden.
Updated by Jannik Schönartz about 5 years ago
Das liegt daran, dass der bas.intra nur aus dem Uninetz erreichbar ist.
Der Testserver hingegen sollte von überall erreichbar sein. Der ist nur immer mal wieder Offline, wenn der Server einen restart hatte.
Aber generell ist die Dokumentation auch noch recht übersichtlich.
Updated by Jannik Schönartz almost 5 years ago
pong
ipxe Builder module documentation added (63845051)
Updated by Christian Rößler over 4 years ago
Doku nach wie vor nicht ausreichend…