Skip to content

Commit

Permalink
update getting started list
Browse files Browse the repository at this point in the history
  • Loading branch information
galexrt authored May 31, 2024
1 parent 1092614 commit 87b63b7
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 69 deletions.
74 changes: 40 additions & 34 deletions app.config.ts
Original file line number Diff line number Diff line change
@@ -1,35 +1,41 @@
export default defineAppConfig({
ui: {
primary: 'malibu',
gray: 'slate',
footer: {
bottom: {
left: 'text-sm text-gray-500 dark:text-gray-400',
wrapper: 'border-t border-gray-200 dark:border-gray-800',
},
},
icons: {
dynamic: true,
// Nuxt UI Pro Icons
dark: 'i-mdi-moon-and-stars',
light: 'i-mdi-weather-sunny',
system: 'i-mdi-computer',
search: 'i-mdi-search',
external: 'i-mdi-external-link',
chevron: 'i-mdi-chevron-down',
hash: 'i-mdi-hashtag',
menu: 'i-mdi-menu',
close: 'i-mdi-window-close',
check: 'i-mdi-check-circle',
},
},
toc: {
bottom: {
edit: 'https://github.com/fivenet-app/fivenet/edit/main/content',
},
},
links: {
imprint: '',
privacyPolicy: '',
},
});
ui: {
primary: 'malibu',
gray: 'slate',
footer: {
bottom: {
left: 'text-sm text-gray-500 dark:text-gray-400',
wrapper: 'border-t border-gray-200 dark:border-gray-800',
},
},
icons: {
dynamic: true,
// Nuxt UI Pro Icons
dark: 'i-mdi-moon-and-stars',
light: 'i-mdi-weather-sunny',
system: 'i-mdi-computer',
search: 'i-mdi-search',
external: 'i-mdi-external-link',
chevron: 'i-mdi-chevron-down',
hash: 'i-mdi-hashtag',
menu: 'i-mdi-menu',
close: 'i-mdi-window-close',
check: 'i-mdi-check-circle',
},
},

toc: {
bottom: {
edit: 'https://github.com/fivenet-app/fivenet/edit/main/content',
},
},

links: {
imprint: '',
privacyPolicy: '',
},

footer: {
colorMode: false,
},
});
10 changes: 10 additions & 0 deletions content/1.getting-started/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,13 @@ title: Getting Started
### 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.)

### Web UI

- In-game Tablet plugin code available.
- [Multi language](/user-guides/i18n)
- Built using [Vue.js 3](https://vuejs.org/), [Nuxt 3](https://nuxt.com/), [Nuxt UI Pro](https://ui.nuxt.com/pro/getting-started) and [TailwindCSS](https://tailwindcss.com/).

## Backend

- Written in Golang.
4 changes: 4 additions & 0 deletions content/2.user-guides/8.i18n.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Languages (i18n)
---

FiveNet supports multiple languages.

Current list of languages:
Expand Down
69 changes: 34 additions & 35 deletions content/9.design/qualifications.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,60 @@
---
title: "Qualifications"
title: Qualifications
---

## What is a Qualifications?

* An access level protected entity with a "public" (as in "anyone can see") facing name and description.
* A training/module that someone has been "granted" or has succcessfully taken the test for.
* A qualification can require certain prerequisites. A prerequisite can be a job rank, other successful qualification.
- An access level protected entity with a "public" (as in "anyone can see") facing name and description.
- A training/module that someone has been "granted" or has succcessfully taken the test for.
- A qualification can require certain prerequisites. A prerequisite can be a job rank, other successful qualification.

### What elements are needed?

* Qualification: Holds all basic infos about the qualification.
* Access: Holds the access levels to the qualification.
* Requirements: Requirements to be able to take the qualification. -> Don't deny the access to the qualification like access, but are required to send a request or to take the qualification.
* Requests: List of user requests to take the test for the qualification.
* Results: A "mapping" of score of an user test.
* Tests: Test progress of (started) tests from users.
* Info/Config of the Test: E.g., how many questions need to be right to pass, how much time do they have, etc.
* Test Questions: Questions for the qualification tests.
* User Test Answers: Answered questions "waiting for approval" by a "trainer".
- Qualification: Holds all basic infos about the qualification.
* Access: Holds the access levels to the qualification.
* Requirements: Requirements to be able to take the qualification. -> Don't deny the access to the qualification like access, but are required to send a request or to take the qualification.
- Requests: List of user requests to take the test for the qualification.
- Results: A "mapping" of score of an user test.
- Tests: Test progress of (started) tests from users.
* Info/Config of the Test: E.g., how many questions need to be right to pass, how much time do they have, etc.
* Test Questions: Questions for the qualification tests.
* User Test Answers: Answered questions "waiting for approval" by a "trainer".

### Access Levels

Similarily structured to documents access levels.

* Blocked.
* View.
* Request.
* Take.
* Grade.
* Edit.
- Blocked.
- View.
- Request.
- Take.
- Grade.
- Edit.

## Exams

3 modes for a qualification with an exam:

* Disabled.
* Request needed.
* Enabled.
- Disabled.
- Request needed.
- Enabled.

### Flow - Request needed

<mermaid>
::mermaid
sequenceDiagram
User->>+Qualification: Send Request
Approver-->Qualification: Approve Request
User-->Exam: Take exam
User->>Exam: Submit exam response
Approver->>Exam: Create Result
</mermaid>
User->>+Qualification: Send Request
Approver-->Qualification: Approve Request
User-->Exam: Take exam
User->>Exam: Submit exam response
Approver->>Exam: Create Result
::

### Flow - Enabled

<mermaid>
::mermaid
sequenceDiagram
User-->Exam: Take exam
User->>Exam: Submit exam response
Approver->>Exam: Create Result

</mermaid>
User-->Exam: Take exam
User->>Exam: Submit exam response
Approver->>Exam: Create Result
::

0 comments on commit 87b63b7

Please sign in to comment.