update release process docs

First commit using Nuxt Sudio

content/1.getting-started/1.index.md

@@ -6,41 +6,41 @@ title: Getting Started
 
 ### Citizens
 
-* Listing, Viewing and Searching Citizens
-* Setting "Citizen props", e.g., wanted status, traffic infraction points.
+- Listing, Viewing and Searching Citizens
+- Setting "Citizen props", e.g., wanted status, traffic infraction points.
 
 ### Documents
 
-* Creating and Editing documents.
-* Creating and Editing templates for documents.
-* Commenting on documents.
-* Access management by job ranks and citizens with multiple access levels.
+- Creating and Editing documents.
+- Creating and Editing templates for documents.
+- Commenting on documents.
+- Access management by job ranks and citizens with multiple access levels.
 
 ### Job
 
-* List of your colleagues with date of births and phone numbers.
-* Time clock with stats for yourself and colleagues.
+- List of your colleagues with date of births and phone numbers.
+- Time clock with stats for yourself and colleagues.
 
 ### Calendar
 
-* Calendar for public, "private" and faction events.
+- Calendar for public, "private" and faction events.
 
 ### Qualifications
 
-* Provide basic qualification modules with a request system to citizens.
+- Provide basic qualification modules with a request system to citizens.
 
 ### Livemap
 
-* Map to see your colleagues and other factions live.
-* It allows you to see dispatches from your own faction from the dispatch center.
+- Map to see your colleagues and other factions live.
+- It allows you to see dispatches from your own faction from the dispatch center.
 
 ### Dispatch Center (Centrum)
 
-* Functionality to convert GKSPhone dispatches to FiveNet dispatches.
-* Live streamed to each users client.
-* Employees can accept/decline dispatches.
-* Automatic dispatch assignment mode. Disponents can manually handle dispatch assignment as well.
+- Functionality to convert GKSPhone dispatches to FiveNet dispatches.
+- Live streamed to each users client.
+- Employees can accept/decline dispatches.
+- Automatic dispatch assignment mode. Disponents can manually handle dispatch assignment as well.
 
 ### Control Panel
 
-* Each faction, if allowed to, can create and manage their own roles. Administrators can set "limits" in regards to permissions and attributes (e.g., what fields they can grant their members, etc.)
+- Each faction, if allowed to, can create and manage their own roles. Administrators can set "limits" in regards to permissions and attributes (e.g., what fields they can grant their members, etc.)

content/2.user-guides/1.citizens.md

@@ -4,8 +4,8 @@ title: Citizens
 
 ## Features
 
-* Searching citizens by their name, date of birth, phone number, traffic infraction points and open fines.
-* Setting citizen "properties"
-    * Wanted state
-    * Mug Shot
-    * And more...
+- Searching citizens by their name, date of birth, phone number, traffic infraction points and open fines.
+- Setting citizen "properties"
+  * Wanted state
+  * Mug Shot
+  * And more...

content/2.user-guides/2.vehicles.md

@@ -4,4 +4,4 @@ title: Vehicles
 
 ## Features
 
-* Searching for vehicles by their plate and model (if available).
+- Searching for vehicles by their plate and model (if available).

content/2.user-guides/3.documents/index.md

@@ -4,8 +4,8 @@ title: Documents
 
 ## Features
 
-* Creating, editing and deleting documents.
-    * Document relations to citizens can be managed.
-    * Document references to other documents can be managed.
-    * Commenting on documents.
-* Around documents there is the possibility to manage categories and templates to keep documents organized and clean.
+- Creating, editing and deleting documents.
+  * Document relations to citizens can be managed.
+  * Document references to other documents can be managed.
+  * Commenting on documents.
+- Around documents there is the possibility to manage categories and templates to keep documents organized and clean.

content/2.user-guides/3.documents/templates.md

@@ -6,45 +6,44 @@ title: Templates
 
 Golang templating is used. In addition to base [Golang html/template functions](https://pkg.go.dev/html/template) [`sprig` template functions](https://masterminds.github.io/sprig/) are available for convience.
 
-* The whole template needs to be wrapped in `<p>` and `</p>`.
-* Use `<br>` for new lines.
+- The whole template needs to be wrapped in `<p>` and `</p>`.
+- Use `<br>` for new lines.
 
 ## Available Variables
 
-* `.Documents` - List of documents that are in the user's clipboard.
-    * `.Id`
-    * `.CreatedAt`
-    * `.Title`
-    * `.State`
-    * `.CreatorId`
-    * `.Creator` - See [User Info Structure](#user-info-structure).
-    * `.Closed` - Boolean.
-    * `.CategoryId`
-    * `.Category`
-        * `.Name`
-        * `.Description`
-* `.Users` - List of citizens/ users that are in the user's clipboard.
-    * See [User Info Structure](#user-info-structure).
-* `.Vehicles` - List of vehicles that are in the user's clipboard.
-    * `Plate`
-    * `Model`
-    * `Type`
-    * `Owner` - See [User Info Structure](#user-info-structure).
-* `.ActiveChar` - Author/Submitting user's info.
-    * See [User Info Structure](#user-info-structure).
+- `.Documents` - List of documents that are in the user's clipboard.
+  * `.Id`
+  * `.CreatedAt`
+  * `.Title`
+  * `.State`
+  * `.CreatorId`
+  * `.Creator` - See [User Info Structure](#user-info-structure).
+  * `.Closed` - Boolean.
+  * `.CategoryId`
+  * `.Category`* `.Name`
+    * `.Description`
+- `.Users` - List of citizens/ users that are in the user's clipboard.
+  * See [User Info Structure](#user-info-structure).
+- `.Vehicles` - List of vehicles that are in the user's clipboard.
+  * `Plate`
+  * `Model`
+  * `Type`
+  * `Owner` - See [User Info Structure](#user-info-structure).
+- `.ActiveChar` - Author/Submitting user's info.
+  * See [User Info Structure](#user-info-structure).
 
 ### User Info Structure
 
-* `.UserId`
-* `.Identifier`
-* `.Job`* - Preferrably use `jobLabel`.
-* `.JobLabel`*
-* `.JobGrade`* - Preferrably use `jobGradeLabel`.
-* `.JobGradeLabel`*
-* `.Firstname`
-* `.Lastname`
-* `.Dateofbirth` - In `DD.MM.YYYY` format.
-* `.PhoneNumber` - Optional, might not always be included.
+- `.UserId`
+- `.Identifier`
+- `.Job`\* - Preferrably use `jobLabel`.
+- `.JobLabel`\*
+- `.JobGrade`\* - Preferrably use `jobGradeLabel`.
+- `.JobGradeLabel`\*
+- `.Firstname`
+- `.Lastname`
+- `.Dateofbirth` - In `DD.MM.YYYY` format.
+- `.PhoneNumber` - Optional, might not always be included.
 
 (\*these fields are only available on the `.activeChar` variable)
 

content/2.user-guides/3.jobs.md

@@ -4,9 +4,9 @@ title: Jobs
 
 ## Features
 
-* MOTD and Radio frequency available on the overview page.
-* List of your colleagues.
-    * Activity of your colleagues, such as when a colleague has joined/"fired" from the job, got promoted/demoted, and other activity.
-* Timeclock for on duty time tracking.
-* Qualifications: A way to manage qualifications of citizens.
-* Conduct register to track good and bad behavior of your employees.
+- MOTD and Radio frequency available on the overview page.
+- List of your colleagues.
+  * Activity of your colleagues, such as when a colleague has joined/"fired" from the job, got promoted/demoted, and other activity.
+- Timeclock for on duty time tracking.
+- Qualifications: A way to manage qualifications of citizens.
+- Conduct register to track good and bad behavior of your employees.

content/2.user-guides/4.calendar.md

@@ -4,6 +4,6 @@ title: Calendar
 
 ## Features
 
-* Creating and Editing calendars.
-* Creating calendar appointments.
-* RSVP-ing to appointments.
+- Creating and Editing calendars.
+- Creating calendar appointments.
+- RSVP-ing to appointments.

content/2.user-guides/5.livemap.md

@@ -4,7 +4,7 @@ title: Livemap
 
 ## Features
 
-* Live position of your colleagues (depending on what your faction is allowed to see).
-* Markers on the map of different types:
-    * Circle
-    * Icons
+- Live position of your colleagues (depending on what your faction is allowed to see).
+- Markers on the map of different types:
+  * Circle
+  * Icons

content/2.user-guides/6.centrum.md

@@ -4,4 +4,4 @@ title: Dispatch Center
 
 ## Features
 
-* Dispatch Center.
+- Dispatch Center.

content/2.user-guides/7.settings.md

@@ -4,6 +4,6 @@ title: Settings
 
 ## Features
 
-* Setting job properties, such as the logo, radio frequency, and more.
-    * Additionally the Discord sync settings can be accessed.
-* For the server team, there are options to manage many other aspects of FiveNet.
+- Setting job properties, such as the logo, radio frequency, and more.
+  * Additionally the Discord sync settings can be accessed.
+- For the server team, there are options to manage many other aspects of FiveNet.

content/2.user-guides/8.i18n.md

@@ -0,0 +1,11 @@
+FiveNet supports multiple languages.
+
+Current list of languages:
+
+- German
+- English
+
+---
+
+We use [POEditor](https://poeditor.com/) for managing the translations.
+If you want to contribute a language or fix translation texts, please post on the FiveNet discord.

content/8.development/4.release.md

@@ -1,13 +1,23 @@
 ---
-title: Release
+title: Release Process
 ---
 
 FiveNet tries to follow [Semantic Versioning](https://semver.org/).
 
-## Process
+## Update Version
 
-Use the following script to update the FiveNet version:
+Use the following script to bump the FiveNet version (where `X.Y.Z` c:
 
-```console
+```bash
 ./internal/scripts/bump_version.sh X.Y.Z
 ```
+
+Make sure to update [the Helm chart `Chart.yaml` `version:` and `appVersion:` entry](https://github.com/fivenet-app/charts/blob/main/charts/fivenet/Chart.yaml#L18-24) accordingly, and don't forget to run `make helm-docs` to update the Helm chart `README.md`.
+
+## Release Notes
+
+Generating release notes is made easier by using the following script:
+
+```bash
+./internal/scripts/generate_update_entry.sh
+```

content/8.development/5.user-activity.md

@@ -4,33 +4,25 @@ title: User Activity
 
 ## Entry Structure
 
-* Built-in
-    * `DocStore.Relation`
-        * If `newValue` set, user mention has been added.
-        * If `oldValue` set, user mention has been removed.
-    * `UserProps.Job`
-        * `newValue` contains the job and rank "pre-formatted" (e.g., `LSMD (Rettungsassistent)`).
-    * `UserProps.TrafficInfractionPoints`
-        * `oldValue` old points and `newValue` new points.
-    * `UserProps.Wanted`
-        * `newValue` new wanted state, `oldValue` previous wanted state.
-    * `UserProps.MugShot`
-        * `oldValue` contains the previous URL if any image was set.
-        * `newValue` contains the new URL or empty if removed.
-    * `UserProps.Attributes`
-        * `oldValue` removed attributes.
-        * `newValue` added attributes.
-* External ("Plugin")
-    * `Plugin.Licenses`
-        * Fields:
-            * `reason`: Label of license
-        * Add/Given: If `newValue` is set, user was given a license.
-        * Remove/Revoked: If `oldValue` is set, user got license revoked.
-    * `Plugin.Billing.Fines`
-            * Sent: If `newValue` equal `0`, bill has been paid.
-            * Paid: If `oldValue = newValue`, bill has been removed/cleared.
-            * Removed: If `newValue` set, bill has been created.
-    * `Plugin.Jail`
-        * Jailed: If `oldValue` is empty and `newValue > 0`, player has been jailed for `newValue` time (seconds).
-        * Unjailed: If `newValue` is `0`, player has been unjailed by "police"/"admin" (in reason).
-        * Escaped: If `oldValue` is `0`, player has escaped (police notification triggered).
+- Built-in
+  * `DocStore.Relation`- If `newValue` set, user mention has been added.
+    - If `oldValue` set, user mention has been removed.
+  * `UserProps.Job`* `newValue` contains the job and rank "pre-formatted" (e.g., `LSMD (Rettungsassistent)`).
+  * `UserProps.TrafficInfractionPoints`* `oldValue` old points and `newValue` new points.
+  * `UserProps.Wanted`* `newValue` new wanted state, `oldValue` previous wanted state.
+  * `UserProps.MugShot`* `oldValue` contains the previous URL if any image was set.
+    * `newValue` contains the new URL or empty if removed.
+  * `UserProps.Attributes`* `oldValue` removed attributes.
+    * `newValue` added attributes.
+- External ("Plugin")
+  * `Plugin.Licenses`- Fields:
+      * `reason`: Label of license
+    - Add/Given: If `newValue` is set, user was given a license.
+    - Remove/Revoked: If `oldValue` is set, user got license revoked.
+  * `Plugin.Billing.Fines`
+    \* Sent: If `newValue` equal `0`, bill has been paid.
+    \* Paid: If `oldValue = newValue`, bill has been removed/cleared.
+    \* Removed: If `newValue` set, bill has been created.
+  * `Plugin.Jail`* Jailed: If `oldValue` is empty and `newValue > 0`, player has been jailed for `newValue` time (seconds).
+    * Unjailed: If `newValue` is `0`, player has been unjailed by "police"/"admin" (in reason).
+    * Escaped: If `oldValue` is `0`, player has escaped (police notification triggered).