Handbuch
Vorbild für dieses Handbuch ist das Handbuch der GitLab Inc.. Alle Mitarbeiter sind eingeladen zum Handbuch beizutragen.
Bei Fragen zum Handbuch wendet euch an:
Bearbeiten
Beim Handbuch handelt es sich um eine von MkDocs erzeugte Seite. Der Quellcode dafür findet sich im Git-Repositorium documentation auf Bitbucket. Er kann entweder dort direkt online bearbeitet werden oder alternativ mit Git heruntergeladen, bearbeitet und dann wieder hochgeladen werden.
Das Handbuch ist in Markdown (mit Erweiterungen) geschrieben und wird von Jenkins nach dem bearbeiten automatisch ausgerollt.
Zur Koordination der Arbeit am Handbuch nutzen wir das JIRA-Projekt Dokumentation (DOC).
Diagramme
Wir erstellen Diagramme mithilfe des Dienstes draw.io. Der Login erfolgt über den Google-Login und draw.io benötigt Zugriff auf Google Drive.
Diagramm einbinden
Sharing des Dokuments auf “Jeder der über den Link verfügt” stellen Edit auf Custom stellen und den Link zum Dokument angeben wenn nicht vorausgefüllt.