Ruderverein-Donau-Linz/rowt
1
1
Fork 0
Code Issues 30 Pull Requests Actions Packages Projects Wiki Activity

docs #757

Merged
philipp merged 5 commits from docs into main 2024-10-08 10:10:46 +02:00
Conversation 0 Commits 5 Files Changed 18 +4
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 96fd9c8ed6 - Show all commits

4
doc/db/README.md
View File

@ -14,12 +14,14 @@ Thus, here is the current (October '24) model and the reasoning behind it:
![](./planned.svg) ![](./planned.svg)
There are 2 main types: There are 2 main types:
1. **Trips:** Trips can be created by every cox. They are "simple", every-day trips. 1. **Trips:** Trips can be created by every cox. They are "simple", every-day trips.
2. **Events:** Events can be created by everyone who has the `manage_events` role. They are used if multiple coxes are needed, e.g. for "Fetzenfahrt", "Anrudern", .... Additionally, events are shown in public calendar (e.g. on the website). 2. **Events:** Events can be created by everyone who has the `manage_events` role. They are used if multiple coxes are needed, e.g. for "Fetzenfahrt", "Anrudern", .... Additionally, events are shown in public calendar (e.g. on the website).
`TripDetails` extracts the common data for both Trips and Events. `TripDetails` extracts the common data for both Trips and Events.
Rower can register using the `UserTrip` table. Rower can register using the `UserTrip` table.
This table expects either... This table expects either...
- a `user_id`, if a person who has an account registers to the trip/event - a `user_id`, if a person who has an account registers to the trip/event
- a `user_note`, if the cox of a trip, or a `manage_events` user of an event wants to add a guest which has no account - a `user_note`, if the cox of a trip, or a `manage_events` user of an event wants to add a guest which has no account
@ -28,6 +30,7 @@ This table expects either...
If `arrival` is NULL, the boat is assumed to still be on the water. If `arrival` is NULL, the boat is assumed to still be on the water.
There are a few `LogbookType`s: There are a few `LogbookType`s:
- `Wanderfahrt`: Used to check if a user has accomplished their `Fahrtenabzeichen` in the current year. - `Wanderfahrt`: Used to check if a user has accomplished their `Fahrtenabzeichen` in the current year.
- `Regatta` - `Regatta`
@ -43,6 +46,7 @@ If the number of users entered is less than the boat's maximum capacity, the rem
![](./fetching.svg) ![](./fetching.svg)
This tables are used to automatically fetch data (every hour). Currently we have: This tables are used to automatically fetch data (every hour). Currently we have:
- `Waterlevel` which fetches the current waterlevel in Linz from hydro (with their explicit permission :-)) - `Waterlevel` which fetches the current waterlevel in Linz from hydro (with their explicit permission :-))
- `Weather` weather data from *Open Weather* - `Weather` weather data from *Open Weather*