tpeetz/versabundus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Use Convention Plugin - OP#241

Browse Source
This commit is contained in:
Thomas Peetz
2022-08-21 18:45:40 +00:00
parent fd4eba37dd
commit 7096fa032f
11 changed files with 405 additions and 522 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/docs/asciidoc/Entwicklungshandbuch.adoc
-69
View File
@@ -1,69 +0,0 @@
= 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/Pflichtenheft.adoc
-89
View File
@@ -1,89 +0,0 @@
= Projektbeschreibung versabundus: Pflichtenheft der Anwendung versabundus
:author: Thomas Peetz
:email: <thomas.peetz@thpeetz.de>
:doctype: article
:sectnums:
:sectnumlevels: 4
:toc:
:toclevels: 4
:table-caption!:
:counter: table-number: 0
//[title="Dokumenthistorie", caption="Tabelle {counter:table-number} ", id="Tabelle-{counter:table-number}", options="header"]
//[title="Dokumenthistorie", id="Table-{counter:table-number}", options="header", cols="4"]
[title="Dokumenthistorie", id="Table-{counter:table-number}", options="header"]
|===
| Version | Datum | Autor | Änderungsgrund / Bemerkungen
| 0.0.1 | 07.10.2014 | Thomas Peetz | Ersterstellung
|===
== Einführung
=== Zweck
=== Stakeholder des Systems
=== Systemumfang
==== Zielsetzung des Systems
=== Systemübersicht
==== Systemkontext
==== Systemarchitektur
===== Systemkomponente 1
===== Systemkomponente 2
==== Systemschnittstellen
===== Realisierte Schnittstellen
===== Verwendete Schnittstellen
==== Logisches Datenmodell
==== Einschränkungen
== Anforderungen der Domäne
=== Systemfunktionen
==== Anwendungsfälle
==== Akteure
==== Zielgruppen
=== Anforderungen
==== Anforderungen an externe Schnittstellen
==== Funktionale Anforderungen
==== Qualitätsanforderungen
==== Randbedingungen
==== Weitere Anforderungen
==== Wartungs- und Supportinformationen
=== Verifikation
[bibliography]
== Referenzen
[glossary]
== Glossar
== Verzeichnisse
=== Abbildungsverzeichnis
=== Tabellenverzeichnis
<<Table-1, Tabelle 1>> <<Table-1>>
src/docs/asciidoc/Projekthandbuch.adoc
-80
View File
@@ -1,80 +0,0 @@
= 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
src/docs/asciidoc/versabundus.adoc
+202
View File
@@ -0,0 +1,202 @@
= Projektbeschreibung Versabundus: Entwicklungs- und Projekthandbuch
:author: Thomas Peetz
:email: <thomas.peetz@thpeetz.de>
:doctype: book
:sectnums:
:sectnumlevels: 4
:toc:
:toclevels: 4
:table-caption!:
:counter: table-number: 0
[title="Dokumenthistorie", id="Table-{counter:table-number}", options="header"]
|===
| Version | Datum | Autor | Änderungsgrund / Bemerkungen
| 1.0.0 | 16.05.2022 | Thomas Peetz | Ersterstellung
|===
== Allgemeines
=== Zweck des Dokumentes
Das Entwicklungshandbuch beschreibt die Werkzeuge und die Vorgehensweise bei der Entwicklung
im Projekt Vresabundus und der Erstellung der Dokumentation.
=== Verwendete Tools
==== Gitlab
Für die Verwaltung des Sourcecode kommt ((Gitlab))<<gitlab>> 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/versabundus
zu finden.
==== Jenkins
Zur automatischen Erstellung der Dokumentation und Anwendung wird ((Jenkins))<<jenkins>> 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))<<asciidoctor>> 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.
== Einführung
=== Zweck
=== Stakeholder des Systems
=== Systemumfang
==== Zielsetzung des Systems
=== Systemübersicht
==== Systemkontext
==== Systemarchitektur
Einzelne Funktionen wie Vererbung, Kommunikation werden als Module implementiert.
Die einzelnen Körper werden aus Modulen zusammengesetzt.
Die Körper existieren nur virtuell, leben also nur im Speicher.
Kann ein Winterschlaf als Speichern implementiert werden?
==== Systemschnittstellen
===== Realisierte Schnittstellen
===== Verwendete Schnittstellen
==== Logisches Datenmodell
==== Einschränkungen
== Anforderungen der Domäne
=== Systemfunktionen
==== Anwendungsfälle
==== Akteure
==== Zielgruppen
=== Anforderungen
==== Anforderungen an externe Schnittstellen
==== Funktionale Anforderungen
==== Qualitätsanforderungen
==== Randbedingungen
==== Weitere Anforderungen
==== Wartungs- und Supportinformationen
=== Verifikation
== 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
[bibliography]
== Referenzen
- [[[asciidoctor]]] http://asciidoctor.org
- [[[gitlab]]] http://www.gitlab.org
- [[[gradle]]] http://www.gradle.org
- [[[jenkins]]] http://jenkins-ci.org
[glossary]
== Glossar
KI:: Künstliche Intelligenz
ML:: Machine Learning
[index]
== Index
== Verzeichnisse
=== Abbildungsverzeichnis
=== Tabellenverzeichnis
<<Table-1, Tabelle 1>> <<Table-1>>