From 3c6cd4797e1ae2dba8c1c783b59391498eb1d9cd Mon Sep 17 00:00:00 2001 From: Dennis Heinrich Date: Mon, 25 Mar 2024 05:17:11 +0100 Subject: [PATCH] =?UTF-8?q?README=20hinzugef=C3=BCgt=20f=C3=BCr=20Beitrage?= =?UTF-8?q?nde,=20Justfile=20f=C3=BCr=20schnelle=20Entwicklung=20und=20Hin?= =?UTF-8?q?weise=20in=20der=20Dokumentation=20angepasst?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 28 ++++++++++++++++++++++++++++ docs/development/documentation.md | 25 +++++++++++++++++++++++++ docs/development/updates.md | 4 ---- justfile | 7 +++++++ mkdocs.yml | 3 ++- 5 files changed, 62 insertions(+), 5 deletions(-) create mode 100644 README.md create mode 100644 docs/development/documentation.md create mode 100644 justfile diff --git a/README.md b/README.md new file mode 100644 index 0000000..e932bb3 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Anwenderdokumentation + +## Vorschlag zur Dokumentation einreichen + +Um einen Vorschlag zur Dokumentation einzureichen, erstellen Sie bitte ein Issue in diesem Repository. +Dort können Sie die gewünschte Änderung oder Ergänzung beschreiben und wir werden nach einer Lösung suchen. + +> [Einen Vorschlag einreichen](https://github.com/Streckenkunde/Anwenderdokumentation/issues/new/choose) + +## Entwicklung an der Dokumentation + +### Voraussetzungen an den Beitragenden + +Zum Beitragen an der Dokumentation sind folgende Voraussetzungen notwendig: + +- *[Docker](https://docs.docker.com/get-docker)* um die Dokumentation zu kompilieren und zu starten +- Das Tool *[Just](https://just.systems)*, es ist ein Management-Tool für das Ausführen von Befehlen +- Erfahrung im Umgang mit Markdown-Dateien und der Versionsverwaltung *[Git](https://git-scm.com)* + +### Befehle zur Entwicklung + +Folgende Befehle stehen dem Beitragenden zur Verfügung: + +| Befehl | Beschreibung | +|--------------|-------------------------------------------------------| +| `just build` | Baut die Dokumentation statisch in den Ordner `site` | +| `just serve` | Startet die Dokumentation auf `http://localhost:3000` | + diff --git a/docs/development/documentation.md b/docs/development/documentation.md new file mode 100644 index 0000000..cd99b36 --- /dev/null +++ b/docs/development/documentation.md @@ -0,0 +1,25 @@ +# Dokumentation + +## Vorschlag zur Dokumentation einreichen + +Um einen Vorschlag zur Dokumentation einzureichen, erstellen Sie bitte ein Issue auf GitHub im Projekt zur +Anwenderdokumentation. Dort können Sie die gewünschte Änderung oder eine Ergänzung mitteilen. + +> Hier können Sie [einen Vorschlag einreichen](https://github.com/Streckenkunde/Anwenderdokumentation/issues/new/choose) + +## Beitragen an der Dokumentation + +Wenn Sie an der Dokumentation mitarbeiten möchten, können Sie ihre Änderungen selbst in das Repository einpflegen. +Dazu können Sie das Repository klonen und die Änderungen lokal vornehmen. Anschließend können Sie die Änderungen +über einen Pull-Request einreichen und werden diese nach einer Prüfung in die Dokumentation überführen. + +> Mehr Informationen zum Beitragen finden Sie [in dem Repository](https://github.com/Streckenkunde/Anwenderdokumentation). + +### Voraussetzungen an den Beitragenden + +Zum Beitragen an der Dokumentation sind folgende Voraussetzungen notwendig: + +- *[Docker](https://docs.docker.com/get-docker)* um die Dokumentation zu kompilieren und zu starten +- Das Tool *[Just](https://just.systems)*, es ist ein Management-Tool für das Ausführen von Befehlen +- Erfahrung im Umgang mit Markdown-Dateien und der Versionsverwaltung *[Git](https://git-scm.com)* + diff --git a/docs/development/updates.md b/docs/development/updates.md index 95f6949..1dc0fde 100644 --- a/docs/development/updates.md +++ b/docs/development/updates.md @@ -1,9 +1,5 @@ # Aktualisierungen und Updates -## Aktuellste Version - -Die aktuellste Version ist 1.0.0 - ## Letzter Changelog Es wurde noch kein Changelog veröffentlicht. \ No newline at end of file diff --git a/justfile b/justfile new file mode 100644 index 0000000..971c8dc --- /dev/null +++ b/justfile @@ -0,0 +1,7 @@ +serve: + @echo "Der Entwicklungsserver für die Dokumentation wird gestartet" + docker run --rm -it -p 3001:8000 -v ${PWD}:/docs squidfunk/mkdocs-material + +build: + @echo "Die Dokumentation wird lokal gebaut" + docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 20c3cc5..1487057 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -26,5 +26,6 @@ nav: - Touren verwalten: manage/tour.md - Export der Daten: manage/export.md - Sonstiges: - - Schnittstellen: development/api.md + - Dokumentation: development/documentation.md + - Schnittstelle: development/api.md - Updates: development/updates.md