Add documents

.gitlab-ci.yml

@@ -11,5 +11,5 @@ Create Documentation:
     - ./gradlew --no-daemon asciidoctor
   artifacts:
     paths:
-      - build/docs/asciidocPdf/versabundus.pdf
+      - build/docs/asciidocPdf/*.pdf
 

src/docs/asciidoc/Entwicklungshandbuch.adoc

@@ -0,0 +1,69 @@
+= Entwicklungshandbuch: Projekt versabundus
+:author: Thomas Peetz
+:email: <thomas.peetz@thpeetz.de>
+:doctype: article
+:toc:
+:sectnums:
+
+== Allgemeines
+
+=== Zweck des Dokumentes
+
+Das Entwicklungshandbuch beschreibt die Werkzeuge und die Vorgehensweise bei der Entwicklung
+im Projekt generations und der Erstellung der Dokumentation.
+
+=== Verwendete Tools
+
+==== Gitlab
+
+Für die Verwaltung des Sourcecode kommt ((Gitlab))<<2>> zum Einsatz.
+Mit Gitlab werden auch die Projektaufgaben verwaltet.
+
+Das Projekt und das dazugehörige Git Repository sind unter der Adresse
+
+https://gitlab.ingenieurbuero-peetz.de/tpeetz/generations
+
+zu finden.
+
+==== Jenkins
+
+Zur automatischen Erstellung der Dokumentation und Anwendung wird ((Jenkins))<<4>> als Buildserver integriert.
+
+Zur Ermittlung der Projekte und Branches ist das Plugin `Gitlab Branch Source` installiert und für die Gruppe `tpeetz` konfiguriert.
+Die Konfiguration des Jenkins Jobs wird über ein `Jenkinsfile` gesteuert.
+Für jeden Branch der Projekte, das ein Jenkinsfile enthält, wird ein Jenkins Job erzeugt.
+Merge Requests und Tags erzeugen ebenfalls Jenkins Jobs.
+
+Das Projekt kann unter
+
+https://jenkins.ingenieurbuero-peetz.de/job/its-people/job/its-people%252Fdevops-ki-playground/
+
+gefunden werden.
+
+== Erstellung der Dokumentation
+
+Die Dokumentation des Projektes wird mit ((Asciidoctor))<<1>> geschrieben.
+Die Dokumente erhalten ihre Namen nach dem jeweiligen Hauptdokument.
+
+=== Quellcode Verwaltung
+
+Die Asciidoctor-Dateien haben die Endung `.adoc`.
+
+=== Buildsystem
+
+Zur Erstellung der PDF-Dateien aus den Asciidoctor-Dateien wird das Buildsystem ((Gradle))<<3>> verwendet.
+Die Dateien für die Dokumente liegen im Verzeichnis `src/docs/asciidoc`.
+
+Der Gradle Build wird über die Datei `build.gradle` definiert.
+
+[index]
+== Index
+
+[bibliography]
+== Referenzen
+
+- [[[phb]]] Thomas Peetz. Projekthandbuch: Projekt generations. 2020.
+- [[[1]]] http://asciidoctor.org
+- [[[2]]] http://www.gitlab.org
+- [[[3]]] http://www.gradle.org
+- [[[4]]] http://jenkins-ci.org

src/docs/asciidoc/Projekthandbuch.adoc

@@ -0,0 +1,80 @@
+= Projekthandbuch: Projekt versabundus
+:author: Thomas Peetz
+:email: <thomas.peetz@thpeetz.de>
+:doctype: book
+:toc: left
+:sectnums:
+
+== Zweck des Dokumentes
+
+Das Projekthandbuch beinhaltet die Informationen zum Projekt generations.
+
+== Projektbeschreibung
+
+=== Ausgangslage
+
+
+//==== Rechtliche Vorgaben und Rahmenbedingungen
+//=== Rahmenbedingungen
+
+//==== Vorhandene Regelungen
+
+=== Projektziele
+
+=== Projektabgrenzung
+
+//=== Voraussichtliche Kosten
+
+//=== Projektrisiken
+
+//==== Produktivität
+
+//==== Finanzielle Risiken
+
+//==== Akzeptanz
+
+== Projektorganisation
+
+=== Projekt-Aufbauorganisation
+
+=== Rollendefinition
+
+//==== Projektauftraggeber
+
+//==== Projektausschuss
+
+//==== Beratung / Qualitätssicherung
+
+==== Projekteiter
+
+==== Projektteam
+
+==== Liste der Stakeholder
+
+=== Projektablauforganisation
+
+==== Projekt-Phasen
+
+===== Erstellung der Projektdokumentation
+
+
+== Verschiedenes
+
+=== Erreichbarkeiten
+
+[glossary]
+== Glossar
+
+KI:: Künstliche Intelligenz
+ML:: Machine Learning
+
+[index]
+== Index
+
+[bibliography]
+== Referenzen
+
+- [[[ehb]]] Thomas Peetz. Entwicklungshandbuch: Projekt Generations. 2020.
+- [[[1]]] http://asciidoctor.org
+- [[[2]]] http://www.gitlab.org
+- [[[3]]] http://www.gradle.org