diff --git a/src/admins/README.md b/src/admins/README.md index 815c397..31f4580 100644 --- a/src/admins/README.md +++ b/src/admins/README.md @@ -1,7 +1,7 @@ # Admins Dieser Teil der Dokumentation befasst sich mit der Installation, Konfiguration und Bedienung des Läufersystems für normale Admins. -Solltest du an der Bedienung für normale Nutzer interessiert sein schau doch mal in den [Nutzer](../users) Bereich. +Solltest du an der Bedienung für normale Nutzer interessiert sein schau doch mal in den Nutzerbereich. ## FAQ > Ein paar der meist gestellten Fragen vorab diff --git a/src/admins/quickstart.md b/src/admins/quickstart.md index 5c0c0d1..bee7dbc 100644 --- a/src/admins/quickstart.md +++ b/src/admins/quickstart.md @@ -1,6 +1,6 @@ # Schnellstart > Du willst das System schnell aufsetzen und testen? Dann bist du hier genau richtig! -> Um das System für produktive Zwecke einzusetzen schau dir bitte die [Installationsanleitung](./installation) an. +> Um das System für produktive Zwecke einzusetzen schau dir bitte die Installationsanleitung an. ## Voraussetzungen Alle der folgenden Anleitungen gehen davon aus, dass du bereits Docker und Docker-Compose installiert hast. diff --git a/src/scanstations/README.md b/src/scanstations/README.md index df71bab..2dadf4f 100644 --- a/src/scanstations/README.md +++ b/src/scanstations/README.md @@ -6,7 +6,7 @@ Wir schreiben grundsätzlich keine Hardware oder Software vor - stellen aber sel Die API für Scannerstationen im Läufersystem ist grundsätzlich so gestaltet, dass Scans live erfasst und validiert (Läufer, Track, Rundenzeit) werden. ## Bedienung -> Die Bedienung nach der [Konfiguration](./config) +> Die Bedienung nach der Konfiguration Die Bedienung der Software als Helfer an der Scannerstation ist sehr einfach: 1. Scannen diff --git a/src/scanstations/config.md b/src/scanstations/config.md index 0557e7d..a68132a 100644 --- a/src/scanstations/config.md +++ b/src/scanstations/config.md @@ -3,7 +3,8 @@ ## Start Wenn du die Scanclient Software öffnest wirst du als erstes nach einem Client Token gefragt --> [So kommst du an einen Client token](../users/scanstations) +-> So kommst du an einen Client token + Sobald du den Token eingegeben hast kannst du auf den Button "Konfigurieren" klicken und der Scanclient wird gestartet. diff --git a/src/users/README.md b/src/users/README.md index 97c53c2..4970ace 100644 --- a/src/users/README.md +++ b/src/users/README.md @@ -1,7 +1,7 @@ # Einleitung Dieser Teil der Dokumentation befasst sich mit der Bedienung des Läufersystems für normale Nutzer:innen. -Solltest du an der Installation oder Konfiguration interessiert sein schau doch mal in den [Admin](../admins) Bereich. +Solltest du an der Installation oder Konfiguration interessiert sein schau doch mal in den Admin Bereich. ## FAQ > Ein paar der meist gestellten Fragen vorab diff --git a/src/users/cards.md b/src/users/cards.md index c3f78e4..b8b37ad 100644 --- a/src/users/cards.md +++ b/src/users/cards.md @@ -1,6 +1,6 @@ # Läuferkarten -Läuferkarten dienen dazu [Trackscans](./scans) für [Läufer:innen](./runners) durch [Scannerstationen](./scanstations) zu erzeugen +Läuferkarten dienen dazu Trackscans für Läufer:innen durch Scannerstationen zu erzeugen Läuferkarten können entweder fest zu einer Läufer:in gehören, oder als Blankokarten genutzt werden, die frei beliebigen Läufer:innen zugewiesen werden können. ## Anlegen Du kannst Läuferkarten entweder manuell anlegen oder automatisch von System generieren lassen. diff --git a/src/users/contacts.md b/src/users/contacts.md index 07fc232..83229d9 100644 --- a/src/users/contacts.md +++ b/src/users/contacts.md @@ -1,6 +1,6 @@ # Kontakte -Kontakte dienen dem Customer Relation Management (CRM) und können beliebig vielen [Teams](./teams) und [Organisationen](./orgs) zugeordnet werden. +Kontakte dienen dem Customer Relation Management (CRM) und können beliebig vielen Teams und Organisationen zugeordnet werden. Achtung: Ein(e) Team/Organisation kann immer nur einen Kontakt haben. Aktuell dienen die Kontakte nur der Dokumentation, in Zukunft solle es aber auch möglich sein einem Kontakt per Knopfdruck die Urkunden für all seine Teams/Orgs per Mail zu schicken. @@ -8,7 +8,7 @@ Aktuell dienen die Kontakte nur der Dokumentation, in Zukunft solle es aber auch ## Anlegen Um einen neuen Kontakt anzulegen öffne im Läufersystem die Seite `Kontakt`. Über den Button `Kontakt erstellen` kannst du einen neuen Kontakt erstellen. -Dabei kannst du dem Kontakt eine(n) Namen, Telefonnummer und E-Mail Adresse geben und sie beliebig vielen Gruppen (Teams/Orgs) zuweisen. +Dabei kannst du dem Kontakt eine(n) Namen, Telefonnummer und E-Mail Adresse geben und sie beliebig vielen Gruppen (Teams/Organisationen) zuweisen. Ebenfalls kannst du auswählen, ob du eine Adresse für den Kontakt festlegen willst (wenn nicht mach einfach den Haken bei Adresse weg). ## Bearbeiten diff --git a/src/users/donations.md b/src/users/donations.md index 7cada8d..607e00a 100644 --- a/src/users/donations.md +++ b/src/users/donations.md @@ -1,7 +1,7 @@ # Sponsorings Sponsorings können entweder Festbetragsspenden oder Kilometerspenden sein. -Kilometerspenden verbinden [Läufer:innen](./runners) mit [Sponsor:innen](./donors), die einen festen Betrag pro zurückgelegtem Kilometer der Läufer:in spenden. +Kilometerspenden verbinden Läufer:innen mit Sponsor:innen, die einen festen Betrag pro zurückgelegtem Kilometer der Läufer:in spenden. ## Anlegen Um ein neues Sponsoring anzulegen öffne im Läufersystem die Seite `Sponsorings`. diff --git a/src/users/donors.md b/src/users/donors.md index 1540fcf..4a51bab 100644 --- a/src/users/donors.md +++ b/src/users/donors.md @@ -1,7 +1,7 @@ # Sponsor:innen Sponsor:innen sind die Spender, die mit einen Festbetrag oder eine Kilometerspende den Lauf für Kaya! unterstützen. -Zusammen mit den [Sponsorings](./donations) bilden sie das Herzstück des Spendenmanagement und der Spendenverrechnung. +Zusammen mit den Sponsorings bilden sie das Herzstück des Spendenmanagement und der Spendenverrechnung. ## Sponsorübersicht > Eine kurze Übersicht über die Funktionen der Sponsorübersicht. diff --git a/src/users/organizations.md b/src/users/organizations.md index a3adede..6507373 100644 --- a/src/users/organizations.md +++ b/src/users/organizations.md @@ -1,13 +1,13 @@ # Organisationen -> Solltest du dich für den Selfservice für Orgs interessieren findest du die Dokumentation zu [hier](../selfservice/org_selfservice) +> Solltest du dich für den Selfservice für Orgs interessieren findest du die Dokumentation zu hier Läuferorganisationen sind das Herzstück des Gruppensystems für Läufer. Eine Organisation kann eine Firma, Schule, Kindergarten, Verein oder ähnliches sein. Läufer:innen können direkt einer Organisation zugeordnet werden. Um die Läufer:innen einer Organisation (z.B.: Schule) weiter zu sortieren können einer Organisation mehrere Teams (z.B.: Klassen) zugeordnet werden. -Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du [hier](./contacts). -Mehr zu Teams findest du [hier](./teams) +Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du hier. +Mehr zu Teams findest du hier ## Anlegen Um eine neue Organisation anzulegen öffne im Läufersystem die Seite `Orgs`. diff --git a/src/users/runners.md b/src/users/runners.md index bcfce9e..29032a1 100644 --- a/src/users/runners.md +++ b/src/users/runners.md @@ -3,7 +3,7 @@ Läufer sind das Herzstück des Läufersystems. Über sie werden Strecken erfasst und Spenden berechnet. -Läufer können einem [Team](./teams) oder einer [Organisation](./organizations) zugeordnet werden. +Läufer können einem Team oder einer Organisation zugeordnet werden. ## Läuferübersicht > Eine kurze Übersicht über die Funktionen der Läuferübersicht. @@ -51,4 +51,4 @@ Oben auf der Seite gibt es jetzt den Knopf `Läufer:in löschen`. Daraufhin wirst du gefragt, ob du die Läufer:in wirklich löschen oder abbrechen willst. ## Import -> Die Importanleitung findest du [hier](./runner_import) \ No newline at end of file +> Die Importanleitung findest du hier \ No newline at end of file diff --git a/src/users/scans.md b/src/users/scans.md index 99d8fbc..0be537a 100644 --- a/src/users/scans.md +++ b/src/users/scans.md @@ -1,13 +1,13 @@ # Scans -Scans sind das Herzstück der Kilometerzählung - sie verbinden [Läufer:innen](./runners) mit zurückgeleter Distantz. +Scans sind das Herzstück der Kilometerzählung - sie verbinden Läufer:innen mit zurückgeleter Distantz. Es gibt zwei Arten von Scans im System: "Festdistanzscans" und "Trackscans" 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. +Die Trackscans sind immer Fest mit einer Läufer:in und einem Track verbunden, von dem die Distanz abgeleitet wird. ## Anlegen > Du kannst im Läufersystem nur Festdistanzscans anlegen. diff --git a/src/users/scanstations.md b/src/users/scanstations.md index 12802b0..a90e9b5 100644 --- a/src/users/scanstations.md +++ b/src/users/scanstations.md @@ -1,13 +1,14 @@ # Scannerstationen +> Die Doku zur Nutzung der Scannerstationen gibt es hier -Scannerstationen sind erstellen Scans für Läuferkarten auf [Tracks](./tracks). +Scannerstationen sind erstellen Scans für Läuferkarten auf 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. +> Bevor du eine Scannerstation anlegen kannst musst du erst einen Track 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`. diff --git a/src/users/sponsoring_contracts.md b/src/users/sponsoring_contracts.md index 2b520d7..15ff2fb 100644 --- a/src/users/sponsoring_contracts.md +++ b/src/users/sponsoring_contracts.md @@ -1,6 +1,6 @@ # Sponsoring-Erklärungen -Das System kann für beliebige [Läufer:innen](./runners), [Teams](./teams) oder ganze [Organisationen](./organizations) Sponsoring-Erklärungen generieren. +Das System kann für beliebige Läufer:innen, Teams oder ganze Organisationen Sponsoring-Erklärungen generieren. Die Sponsoring-Erklärungen sind dabei aktuell auf Deutsch und Englisch verfügbar. Die Texte auf dem Sponsoring-Erklärungen und die Anzahl von Erklärungen/Läufer:in können deine Admins anpassen. diff --git a/src/users/teams.md b/src/users/teams.md index 399c969..8d63609 100644 --- a/src/users/teams.md +++ b/src/users/teams.md @@ -3,8 +3,8 @@ Läuferteams sind die Untergruppen des Gruppensystems für Läufer:innen. Ein Team kann eine Klasse, Abteilung, Gruppe oder ähnliches sein. -Läufer:innen können einem Team zugeordnet werden, das wiederum zu einer Organisation gehört (mehr zu Organisationen findest du [hier](./organizations)). -Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du [hier](./contacts). +Läufer:innen können einem Team zugeordnet werden, das wiederum zu einer Organisation gehört (mehr zu Organisationen findest du hier). +Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du hier. ## Anlegen > Achtung: Um ein Team anzulegen musst du vorher die Mutter-Organisation für das Team anlegen.