Added scan docs 💳
continuous-integration/drone/push Build is passing Details

This commit is contained in:
Nicolai Ort 2021-03-19 15:31:19 +01:00
parent 19c3fb7929
commit fd58a5b435
3 changed files with 74 additions and 31 deletions

View File

@ -59,6 +59,7 @@ module.exports = {
'donations',
'sponsoring_contracts',
'tracks',
'scans',
'scanstations'
]
}

43
src/users/scans.md Normal file
View File

@ -0,0 +1,43 @@
# Scannerstationen
Scannerstationen sind erstellen Scans für Läuferkarten auf [Tracks](./tracks).
Die Scannerstationen sind in realen Welt üblicherweise Laptops mit Barcode-Scannern und einer speziellen Software.
Die Scannerstationen im Läufersystem dienen dazu die "realen" Scannerstationen anzumelden und einem Track zuzuweisen.
Dieser Teil der Dokumentation befasst sich nur mit den Scannerstationen im Läufersystem!
## Anlegen
> Bevor du eine Scannerstation anlegen kannst musst du erst einen [Track](./tracks) anlegen, zu dem sie gehört.
> Du bekommst beim Erstellen einer Scanenrstation einen Token (Code/Key) für diese - bewahre ihn gut auf!
Um eine neue Scannerstation anzulegen öffne im Läufersystem die Seite `Scannerstationen`.
Über den Button `Station erstellen` kannst du eine neue Scanerstation erstellen.
Dabei musst du die Station einem Track zuweisen und kannst du der Station eine Beschreibung geben und sie deaktiveren.
Wenn du fertig bist kannst du einfach auf den Button `Erstellen` klicken.
Nachdem die Scannerstation im System erstellt wurde bekommst du ihren Token angezeigt.
Dieser Token wird nur einmal angezeigt und kann nicht geändert werden - bewahre ihn also gut auf!
Du kannst auf den Token oder den kopieren Button klicken, um den Token in deine Zwischenablage zu kopieren.
Wenn du den Token sicher gespeichert hast kannst du den Dialog über den Button `Ja, ich habe den Token kopiert` schließen.
## Bearbeiten
Um eine Scannerstation zu bearbeiten kannst du in der Scannerstationsübersicht den Button `Details` für die gewünschte Scannerstation anklicken.
In der Übersicht für diese Scannerstation kannst du nun den Track und die Beschreibung der Scannerstation ändern und sie (de)aktivieren.
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
## Löschen
> Du kannst eine Scannerstation entweder aus der Scannerstationsübersicht oder der Scannerstationsdetailansicht löschen.
### In der Scannerstationsübersicht
Klick bei der gewünschten Scannerstation auf den Button `Löschen`.
Daraufhin wirst du gefragt, ob du die Scannerstation wirklich löschen oder abbrechen willst.
### In der Scannerstationsdetailansicht
Klick bei der gewünschten Scannerstation auf den Button `Details`.
Oben auf der Seite gibt es jetzt den Knopf `Station löschen`.
Daraufhin wirst du gefragt, ob du die Scannerstation wirklich löschen oder abbrechen willst.
### Scannerstation mit Scans
> Achtung: Wir empfehlen Stationen mit Scans nie zu löschen sondern einfach zu deaktivieren!
Sollte die Scannerstation noch assoziierte Scans haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf.
Hier musst du nochmal die Löschung inklusive aller Scans bestätigen, alternativ kannst du auch Abbrechen.

View File

@ -1,43 +1,42 @@
# Scannerstationen
# Scans
Scannerstationen sind erstellen Scans für Läuferkarten auf [Tracks](./tracks).
Die Scannerstationen sind in realen Welt üblicherweise Laptops mit Barcode-Scannern und einer speziellen Software.
Scans sind das Herzstück der Kilometerzählung - sie verbinden [Läufer:innen](./runners) mit zurückgeleter Distantz.
Es gibt zwei Arten von Scans im System: "Festdistanzscans" und "Trackscans"
Die Scannerstationen im Läufersystem dienen dazu die "realen" Scannerstationen anzumelden und einem Track zuzuweisen.
Dieser Teil der Dokumentation befasst sich nur mit den Scannerstationen im Läufersystem!
Festdistanzscans können nur von Benutzer:innen im Läufersystem angelegt werden und weisen einer Läufer:in eine feste Distanz zu.
Dies ist besonders nützlich, wenn Läufer:innen Karten auf halber Strecke verloren haben oder aus anderen Gründen einen Distanzbonus bekommen.
Trackscans hingegen können nur dadurch erzeugt werden, dass eine Scannerstation den Code der Karte einer Läufer:in scannen und so einen neuen Scan anlegen.
Die Trackscans sind immer Fest mit einer Läufer:in und einem [Track](./tracks) verbunden, von dem die Distanz abgeleitet wird.
## Anlegen
> Bevor du eine Scannerstation anlegen kannst musst du erst einen [Track](./tracks) anlegen, zu dem sie gehört.
> Du bekommst beim Erstellen einer Scanenrstation einen Token (Code/Key) für diese - bewahre ihn gut auf!
> Du kannst im Läufersystem nur Festdistanzscans anlegen.
Um eine neue Scannerstation anzulegen öffne im Läufersystem die Seite `Scannerstationen`.
Über den Button `Station erstellen` kannst du eine neue Scanerstation erstellen.
Dabei musst du die Station einem Track zuweisen und kannst du der Station eine Beschreibung geben und sie deaktiveren.
Wenn du fertig bist kannst du einfach auf den Button `Erstellen` klicken.
Nachdem die Scannerstation im System erstellt wurde bekommst du ihren Token angezeigt.
Dieser Token wird nur einmal angezeigt und kann nicht geändert werden - bewahre ihn also gut auf!
Du kannst auf den Token oder den kopieren Button klicken, um den Token in deine Zwischenablage zu kopieren.
Wenn du den Token sicher gespeichert hast kannst du den Dialog über den Button `Ja, ich habe den Token kopiert` schließen.
Um einen neue Scan anzulegen öffne im Läufersystem die Seite `Scans`.
Über den Button `Scan erstellen` kannst du einen neuen Scan erstellen.
Dabei musst du dem Scan eine Läufer:in und eine Distanz in Metern zuweisen.
Sobald du alles angegeben hast kannst du über den Button `Erstellen` den Scan anlegen.
## Bearbeiten
Um eine Scannerstation zu bearbeiten kannst du in der Scannerstationsübersicht den Button `Details` für die gewünschte Scannerstation anklicken.
In der Übersicht für diese Scannerstation kannst du nun den Track und die Beschreibung der Scannerstation ändern und sie (de)aktivieren.
Um einen Scan zu bearbeiten kannst du in der Scansübersicht den Button `Details` für den gewünschten Scananklicken.
### Festdistanzscans
Bei Festdistanzscans kannst du in der Scandetailansicht die Gültigkeit, Läufer:in und Distanz anpassen.
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
### Trackscans
Bei Trackscans kannst du in der Scandetailansicht nur die Gültigkeit anpassen - alle anderen Werte sind fest im System hinterlegt.
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
## Löschen
> Du kannst eine Scannerstation entweder aus der Scannerstationsübersicht oder der Scannerstationsdetailansicht löschen.
> Du kannst einen Scan entweder aus der Scansübersicht oder der Scandetailansicht löschen.
> Wir empfehlen grundsätzlich Scans lieber zu deaktiveren, als zu löschen, um menschlichen Fehlern vorzubeugen.
### In der Scannerstationsübersicht
Klick bei der gewünschten Scannerstation auf den Button `Löschen`.
Daraufhin wirst du gefragt, ob du die Scannerstation wirklich löschen oder abbrechen willst.
### In der Scansübersicht
Klick bei dem gewünschten Scan auf den Button `Löschen`.
Daraufhin wirst du gefragt, ob du den Scan wirklich löschen oder abbrechen willst.
### In der Scannerstationsdetailansicht
Klick bei der gewünschten Scannerstation auf den Button `Details`.
Oben auf der Seite gibt es jetzt den Knopf `Station löschen`.
Daraufhin wirst du gefragt, ob du die Scannerstation wirklich löschen oder abbrechen willst.
### Scannerstation mit Scans
> Achtung: Wir empfehlen Stationen mit Scans nie zu löschen sondern einfach zu deaktivieren!
Sollte die Scannerstation noch assoziierte Scans haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf.
Hier musst du nochmal die Löschung inklusive aller Scans bestätigen, alternativ kannst du auch Abbrechen.
### In der Scandetailansicht
Klick bei dem gewünschten Scannerstation auf den Button `Details`.
Oben auf der Seite gibt es jetzt den Knopf `Scan löschen`.
Daraufhin wirst du gefragt, ob du den Scannerstation wirklich löschen oder abbrechen willst.