mirror of
https://github.com/Streckenkunde/Anwenderdokumentation.git
synced 2025-12-06 07:58:35 +00:00
Informationen aus der alten Dokumentation entfernt zur kompletten Überarbeitung
This commit is contained in:
parent
1e6c7e686f
commit
b03b8e7a16
13 changed files with 0 additions and 92 deletions
Binary file not shown.
|
Before Width: | Height: | Size: 43 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1 MiB |
|
|
@ -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.
|
|
||||||
|
|
@ -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)*
|
|
||||||
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
# Aktualisierungen und Updates
|
|
||||||
|
|
||||||
## Letzter Changelog
|
|
||||||
|
|
||||||
Es wurde noch kein Changelog veröffentlicht.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
# Dokumentation von Streckenkunden
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
# Export der Daten
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
# Strecken verwalten
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
# Touren verwalten
|
|
||||||
|
|
@ -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).
|
|
||||||
|
|
@ -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
|
|
||||||
|
|
@ -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).
|
|
||||||
|
|
@ -1,2 +0,0 @@
|
||||||
# Benachrichtigungen
|
|
||||||
|
|
||||||
Loading…
Reference in a new issue