docs(beamershow): Full docs

This commit is contained in:
Nicolai Ort 2025-01-16 20:35:18 +01:00
parent 61d790a79e
commit 6d8fa8ad53
Signed by: niggl
GPG Key ID: 13AFA55AF62F269F
4 changed files with 90 additions and 0 deletions

View File

@ -0,0 +1,27 @@
---
linkTitle: "Beamershow"
title: Beamershow
weight: 1
prev: /
next: /beamershow/config
cascade:
type: docs
---
Die Beamershow zeigt live Statistiken zum aktuellen Event an.
Wie der Name schon andeutet ist sie dafür gedacht mit einem Beamer vor Ort auf eine (Lein)Wand projeziert zu werden.
Sie sollte im Normalfall immer unter `<läufersystem>/beamershow` erreichbar sein, mehr dazu unter [Konfiguration](./config)
## Seiten/Informationen
> Die Beamershow umfasst folgende Seiten/Abschnitte
* Allgemeines
* Anzahl an Läufer:innen
* Bisher insgesamt erlaufene Kilometer
* Aktuelle Spendengesamtsumme
* Top 10 Läufer nach Distanz
* Top 10 Läufer nach schnellster Rundenzeit
* Top 10 Organisationen nach Distanz
* Top 10 Teams nach Distanz

View File

@ -0,0 +1,27 @@
---
linkTitle: "Beamershow"
title: Beamershow
weight: 1
prev: /
next: /beamershow/config
cascade:
type: docs
---
The beamer show displays live statistics for the current event.
As the name suggests, it is intended to be projected on a (screen) wall on-site using a beamer.
It should normally always be accessible under `<läufersystem>/beamershow`, more details can be found under [Configuration](./config).
## Pages/Information
> The beamer show includes the following pages/sections
* General
* Number of runners
* Total kilometers ran so far
* Current total donation amount
* Top 10 runners by distance
* Top 10 runners by fastest lap time
* Top 10 organizations by distance
* Top 10 teams by distance

View File

@ -0,0 +1,18 @@
---
title: Beamershow Konfig
weight: 1
prev: /beamershow
---
## Start
Wenn du die Beamershow öffnest wirst du als erstes nach dem API Endpunkt gefragt - diese entspricht der URL des Läufersystems (z.B.: `https://lauf-fuer-kaya.de`).
Als nächstes musst du noch einen Client Token gefragt, den du von deinem Admin bekommst.
Sobald du den Token eingegeben hast kannst du auf den Button "Konfigurieren" klicken und die Beamershow wird gestartet.
## Konfiguration ändern
Tippe `cnf` auf einer beliebigen Seite der Beamershow.
Du wirst sofort von der Beamershow abbemeldet und kannst so einen neuen API Endpunkt und Client Token angeben.

View File

@ -0,0 +1,18 @@
---
title: Beamershow Config
weight: 1
prev: /beamershow
---
## Start
When you open the Beamershow, you will first be asked for the API endpoint - this corresponds to the URL of the runner system (e.g., `https://lauf-fuer-kaya.de`).
Next, you will be asked for a client token, which you will receive from your admin.
Once you have entered the token, you can click the "Configure" button and the Beamershow will start.
## Change Configuration
Type `cnf` on any page of the Beamershow.
You will be immediately logged out of the Beamershow and can then enter a new API endpoint and client token.