diff --git a/docs/assets/images/dashboard.png b/docs/assets/images/dashboard.png deleted file mode 100644 index a47b46a..0000000 Binary files a/docs/assets/images/dashboard.png and /dev/null differ diff --git a/docs/assets/images/index.png b/docs/assets/images/index.png deleted file mode 100644 index 49eac1a..0000000 Binary files a/docs/assets/images/index.png and /dev/null differ diff --git a/docs/development/api.md b/docs/development/api.md deleted file mode 100644 index 65c309e..0000000 --- a/docs/development/api.md +++ /dev/null @@ -1,13 +0,0 @@ -# Schnittstelle - -Die Software bietet eine spezielle Webseite (API), die es ermöglicht, Nutzerdaten zu bearbeiten. Diese Webseite ist über die Adresse `/api` erreichbar. - -- **OpenAPI-Spezifikation:** Es gibt eine Anleitung, wie man die API benutzt, die unter `/api/openapi.json` abrufbar ist. -- **Interaktive Dokumentation:** Eine benutzerfreundlichere Version der Dokumentation findest du unter `/api/docs`. - -## Authentifizierung - -Um sicherzugehen, dass nur berechtigte Personen Zugang haben, nutzt die Software JWT-Token: - -- Nach dem Einloggen erhältst du einen JWT-Token von der Adresse `/api/login_check`. -- Diesen Token musst du bei jeder Anfrage im `Authorization`-Bereich deiner Internetanfrage als Bearer-Token mitschicken. \ No newline at end of file diff --git a/docs/development/documentation.md b/docs/development/documentation.md deleted file mode 100644 index cd99b36..0000000 --- a/docs/development/documentation.md +++ /dev/null @@ -1,25 +0,0 @@ -# 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 deleted file mode 100644 index 1dc0fde..0000000 --- a/docs/development/updates.md +++ /dev/null @@ -1,5 +0,0 @@ -# Aktualisierungen und Updates - -## Letzter Changelog - -Es wurde noch kein Changelog veröffentlicht. \ No newline at end of file diff --git a/docs/manage/activity.md b/docs/manage/activity.md deleted file mode 100644 index f3d20b2..0000000 --- a/docs/manage/activity.md +++ /dev/null @@ -1 +0,0 @@ -# Dokumentation von Streckenkunden \ No newline at end of file diff --git a/docs/manage/export.md b/docs/manage/export.md deleted file mode 100644 index 3747e38..0000000 --- a/docs/manage/export.md +++ /dev/null @@ -1 +0,0 @@ -# Export der Daten \ No newline at end of file diff --git a/docs/manage/route.md b/docs/manage/route.md deleted file mode 100644 index 066921b..0000000 --- a/docs/manage/route.md +++ /dev/null @@ -1 +0,0 @@ -# Strecken verwalten \ No newline at end of file diff --git a/docs/manage/tour.md b/docs/manage/tour.md deleted file mode 100644 index 86ea2ce..0000000 --- a/docs/manage/tour.md +++ /dev/null @@ -1 +0,0 @@ -# Touren verwalten \ No newline at end of file diff --git a/docs/user/account.md b/docs/user/account.md deleted file mode 100644 index b32ef85..0000000 --- a/docs/user/account.md +++ /dev/null @@ -1,27 +0,0 @@ -# Kontoverwaltung - -## Registrierung - -Für die Registrierung begeben Sie sich auf die Startseite der Anwendung. Dort finden -Sie ein Eingabefeld für die Anmeldung. Klicken Sie darunter auf den Link "Registrieren". -Es öffnet sich ein Formular, in dem Sie Ihre Daten eingeben können. - -- Ihre E-Mail-Adresse wird später als ihr Benutzername verwendet. - - Ihre E-Mail muss gültig sein und wird auf ihre Gültigkeit überprüft. - - Sie erhalten eine E-Mail nach Ihrer Registrierung zur Bestätigung. -- Ihren Vor- und Nachnamen können Sie frei wählen. -- Ihr Passwort für die späteren Anmeldungen muss sicher sein. - -Anschließend klicken Sie auf den Button "Registrieren". Sie werden automatisch angemeldet. - -## Anmeldung - -Für die Anmeldung begeben Sie sich auf die Startseite der Anwendung. Dort finden -Sie ein Eingabefeld für die Anmeldung. Geben Sie Ihre E-Mail-Adresse und Ihr Passwort ein. Nach -dem Klick auf den Button "Anmelden" werden Sie automatisch angemeldet, sofern die Eingaben korrekt sind. - -## Passwort vergessen - -Wenn Sie Ihr Passwort vergessen haben, können Sie auf der Anmeldeseite auf den Link "Passwort vergessen" klicken. -Geben Sie Ihre E-Mail-Adresse ein und klicken Sie auf den Button "Passwort zurücksetzen". Sie erhalten eine E-Mail -mit einem neuen Passwort (sofern die E-Mail existiert). \ No newline at end of file diff --git a/docs/user/dashboard.md b/docs/user/dashboard.md deleted file mode 100644 index e3c224f..0000000 --- a/docs/user/dashboard.md +++ /dev/null @@ -1,7 +0,0 @@ -# Dashboard - -Das Dashboard bietet dem Anwender nach der Anmeldung einen schnellen Überblick über die Informationen. Dort sind zum Beispiel die nächsten, verfallenden Streckenkunden aufgelistet. - -![Dashboard] - -[Dashboard]: ../assets/images/dashboard.png \ No newline at end of file diff --git a/docs/user/index.md b/docs/user/index.md deleted file mode 100644 index 1025e7d..0000000 --- a/docs/user/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Startseite - -![Startseite] - -[Startseite]: ../assets/images/index.png - -## Anmeldung, Registration und Passwort vergessen - -Für weitere Informationen zur Anmeldung, Registration und Passwort vergessen, siehe [Kontoverwaltung](account.md). diff --git a/docs/user/notifications.md b/docs/user/notifications.md deleted file mode 100644 index 4655d6c..0000000 --- a/docs/user/notifications.md +++ /dev/null @@ -1,2 +0,0 @@ -# Benachrichtigungen -