Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Help #410

Merged
merged 29 commits into from
May 10, 2024
Merged

Help #410

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
3add56b
chore: create help pages routes
tyboro2002 Apr 29, 2024
34bbbce
chore: added base layout and header for help
tyboro2002 Apr 29, 2024
110741c
chore: startup sidebar menu
tyboro2002 Apr 29, 2024
9740a87
chore: basic sidebar
tyboro2002 Apr 29, 2024
4b71059
chore: basic vitepress setup
tyboro2002 May 2, 2024
7ca8625
chore: make buttons on startpage work with i18n
tyboro2002 May 2, 2024
57fa9a7
chore: start student help nl
tyboro2002 May 2, 2024
7866a4f
chore: cleanup capitals
tyboro2002 May 2, 2024
ee67990
chore: student help page nl
tyboro2002 May 2, 2024
d4a34c0
chore: finished first draft of help for students
tyboro2002 May 2, 2024
0f653f4
Merge branch 'development' of github.com:SELab-2/UGent-7 into help
tyboro2002 May 2, 2024
1acb2ec
chore: lint fix
tyboro2002 May 2, 2024
23b2336
chore:teacher join command
tyboro2002 May 2, 2024
ae7b503
chore: fix linter
tyboro2002 May 2, 2024
2d97648
fix: little fixes
BramMeir May 2, 2024
33cae73
Merge branch 'development' of github.com:SELab-2/UGent-7 into help
tyboro2002 May 2, 2024
e60c531
fix: en translations
BramMeir May 2, 2024
490814e
Merge branch 'help' of github.com:SELab-2/UGent-7 into help
tyboro2002 May 2, 2024
07f6692
chore: small cleanup
tyboro2002 May 2, 2024
b608a37
chore: add scafolding for other types of users their help pages
tyboro2002 May 6, 2024
51eddae
chore: fix merge conflicts
tyboro2002 May 6, 2024
7ef5ad7
Merge branch 'development' of github.com:SELab-2/UGent-7 into help
tyboro2002 May 6, 2024
3373e30
Merge branch 'development' of github.com:SELab-2/UGent-7 into help
tyboro2002 May 10, 2024
a4e744e
chore: refactor to cleanup for other types of help pages
tyboro2002 May 10, 2024
bb55b13
chore: add teacher help page (wip)
tyboro2002 May 10, 2024
d8f0c7b
chore: add assistant help page (WIP)
tyboro2002 May 10, 2024
9a7e5aa
chore: add poetry.lock
tyboro2002 May 10, 2024
cab7e87
fix: little cleanup
BramMeir May 10, 2024
3aefaba
fix: assistants help
BramMeir May 10, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 8 additions & 36 deletions docs/en/assistant-examples.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Assistant Help Page

This page describes how to interact with Ypovoli as a assistant.
This page describes how to interact with Ypovoli as an assistant.

## Login/Logout

Expand Down Expand Up @@ -35,26 +35,8 @@ This page describes how to interact with Ypovoli as a assistant.

![mode choice button](../assets/assistant/en/modus-change.png)

## Creating a Course
- Click on Dashboard in the navigation bar.
- Scroll down to the "My Courses" section.
- Click on the + button.

![course creation button](../assets/teacher/en/course-create-button.png)

:::info
If you only want to make your course available via an invitation link, you can do so via this button.
![private course button](../assets/teacher/en/private-course-button.png)

:::danger
- Activate this link via the share button. (maximum validity is 28 days)
<div style="display: flex; align-items: center;">
<img src="../assets/teacher/course-share-button.png" alt="course share button" style="width: auto; height: 75px; margin-right: 10px;">
</div>
:::

## Course Details
- Click on Dashboard in the navigation bar.
- Click on "Dashboard" in the navigation bar.
- Scroll down to the "My Courses" section.
- Click on the details button next to the desired course.

Expand All @@ -67,10 +49,10 @@ If you only want to make your course available via an invitation link, you can d
## Creating a Project

- Option 1:
- Click on Dashboard in the navigation bar.
- Click on "Dashboard" in the navigation bar.
- Click on "Create new project".
- Option 2:
- Click on Calendar in the navigation bar.
- Click on "Calendar" in the navigation bar.
- Click on "Create new project".
- Option 3:
- Go to the detail page of a course (see [Course Details](#course-details)).
Expand All @@ -82,23 +64,23 @@ If you only want to make your course available via an invitation link, you can d
![projects list](../assets/en/project-list.png)

- Option 1:
- Click on Dashboard in the navigation bar.
- Click on "Dashboard" in the navigation bar.
- At the top of the page, there is a "Current Projects" section.
::: info
- Here are all the projects with a deadline within the next 7 days on the left and all projects on the right.
- Use the toggle button at the top to view projects with expired deadlines.
:::
- Option 2:
- Click on Calendar in the navigation bar.
- Click on "Calendar" in the navigation bar.
- On the calendar, an indication of the number of deadlines on a specific day is given using a red circle.
- Select a day with projects and click on the desired project.
- Option 3:
- Click on Dashboard in the navigation bar.
- Click on "Dashboard" in the navigation bar.
- Scroll to the "My Courses" section.
- Click on the course of the desired project.
- Under the "Current Projects" section, you will see all projects for this specific course.
- Option 4:
- Click on Projects in the navigation bar.
- Click on "Projects" in the navigation bar.
- You will see an overview of all your projects.

::: info Project Card Explanation
Expand All @@ -112,13 +94,3 @@ The card is divided as follows:
- Progress bar of all students, including the number of submissions and the number of groups.
- Status of the tests performed for these submissions.
:::

## Searching for and Editing Course Instructors
BramMeir marked this conversation as resolved.
Show resolved Hide resolved
- Go to the detail page of the course (see [Course Details](#course-details)).
- Scroll to the "Instructors Linked to This Course" section.
- Here you will find a list of the instructors for this course.

::: info
- Via the edit button, you can add (or remove) instructors to this course.
- Via the trash can icon, you can remove instructors from this course. (only if there is more than one remaining instructor)
:::
26 changes: 13 additions & 13 deletions docs/en/teacher-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,25 +36,25 @@ This page describes how to interact with Ypovoli as a teacher.
![mode choice button](../assets/teacher/en/modus-change.png)

## Creating a Course
- Click on Dashboard in the navigation bar.
- Click on "Dashboard" in the navigation bar.
- Scroll down to the "My Courses" section.
- Click on the + button.

![course creation button](../assets/teacher/en/course-create-button.png)

:::info
If you only want to make your course available via an invitation link, you can do so via this button.
If you only want to make your course available via an invitation link, you can do so using this button.
![private course button](../assets/teacher/en/private-course-button.png)

:::danger
- Activate this link via the share button. (maximum validity is 28 days)
- Activate this link via the share button (maximum validity is 28 days).
<div style="display: flex; align-items: center;">
<img src="../assets/teacher/course-share-button.png" alt="course share button" style="width: auto; height: 75px; margin-right: 10px;">
</div>
:::

## Course Details
- Click on Dashboard in the navigation bar.
- Click on "Dashboard" in the navigation bar.
- Scroll down to the "My Courses" section.
- Click on the details button next to the desired course.

Expand All @@ -67,10 +67,10 @@ If you only want to make your course available via an invitation link, you can d
## Creating a Project

- Option 1:
- Click on Dashboard in the navigation bar.
- Click on "Dashboard" in the navigation bar.
- Click on "Create new project".
- Option 2:
- Click on Calendar in the navigation bar.
- Click on "Calendar" in the navigation bar.
- Click on "Create new project".
- Option 3:
- Go to the detail page of a course (see [Course Details](#course-details)).
Expand All @@ -82,23 +82,23 @@ If you only want to make your course available via an invitation link, you can d
![projects list](../assets/en/project-list.png)

- Option 1:
- Click on Dashboard in the navigation bar.
- Click on "Dashboard" in the navigation bar.
- At the top of the page, there is a "Current Projects" section.
::: info
- Here are all the projects with a deadline within the next 7 days on the left and all projects on the right.
- Use the toggle button at the top to view projects with expired deadlines.
:::
- Option 2:
- Click on Calendar in the navigation bar.
- Click on "Calendar" in the navigation bar.
- On the calendar, an indication of the number of deadlines on a specific day is given using a red circle.
- Select a day with projects and click on the desired project.
- Option 3:
- Click on Dashboard in the navigation bar.
- Click on "Dashboard" in the navigation bar.
- Scroll to the "My Courses" section.
- Click on the course of the desired project.
- Under the "Current Projects" section, you will see all projects for this specific course.
- Option 4:
- Click on Projects in the navigation bar.
- Click on "Projects" in the navigation bar.
- You will see an overview of all your projects.

::: info Project Card Explanation
Expand All @@ -113,12 +113,12 @@ The card is divided as follows:
- Status of the tests performed for these submissions.
:::

## Searching for and Editing Course Instructors
## Searching and Editing Course Instructors
- Go to the detail page of the course (see [Course Details](#course-details)).
- Scroll to the "Instructors Linked to This Course" section.
- Here you will find a list of the instructors for this course.

::: info
- Via the edit button, you can add (or remove) instructors to this course.
- Via the trash can icon, you can remove instructors from this course. (only if there is more than one remaining instructor)
- Via the edit button, you can add/remove instructors to/from this course.
- Via the trash can icon, you can remove instructors from this course (only if there is more than one remaining instructor).
:::
2 changes: 1 addition & 1 deletion docs/nl/admin-examples.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# admin help pagina
# Admin help pagina

Deze pagina beschrijft hoe u als administrator met Ypovoli interageert.

Expand Down
38 changes: 5 additions & 33 deletions docs/nl/assistant-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,28 +35,10 @@ Deze pagina beschrijft hoe u als assistent met Ypovoli interageert.

![modus keuze knop](../assets/assistant/nl/modus-change.png)

## Aanmaken vak
- Druk in de navigatiebalk op Dashboard.
- Scrol naar de sectie "Mijn vakken".
- Klik op de + knop.

![vak aanmaak knop](../assets/teacher/nl/course-create-button.png)

:::info
Wilt u u vak enkel beschikbaar plaatsen via een uitnodigingslink kan u dat via deze knop.
![vak aanmaak knop](../assets/teacher/nl/private-course-button.png)

:::danger
- Activeer deze link via de share knop. (maximum geldigheid is 28 dagen)
<div style="display: flex; align-items: center;">
<img src="../assets/teacher/course-share-button.png" alt="vak deel knop" style="width: auto; height: 75px; margin-right: 10px;">
</div>
:::

## Vak details
- Druk in de navigatiebalk op Dashboard.
- Druk in de navigatiebalk op "Dashboard".
- Scrol naar de sectie "Mijn vakken".
- Klik op de details knop bij het gekozen vak.
- Klik op de "Details" knop bij het gekozen vak.

![vak kaart](../assets/course-card.png)

Expand All @@ -67,10 +49,10 @@ Wilt u u vak enkel beschikbaar plaatsen via een uitnodigingslink kan u dat via d
## Aanmaken project

- Optie 1
- Druk in de navigatiebalk op Dashboard.
- Druk in de navigatiebalk op "Dashboard".
- Druk op "Creëer nieuw project".
- Optie 2
- Druk in de navigatiebalk op Kalender.
- Druk in de navigatiebalk op "Kalender".
- Druk op "Creëer nieuw project".
- Optie 3
- Ga naar detail pagina van een vak (zie [Vak details](#vak-details)).
Expand All @@ -82,7 +64,7 @@ Wilt u u vak enkel beschikbaar plaatsen via een uitnodigingslink kan u dat via d
![projecten lijst](../assets/nl/project-list.png)

- Optie 1:
- Druk in de naviegatiebalk op Dashboard.
- Druk in de naviegatiebalk op "Dashboard".
- Bovenaan de pagina staat een sectie "Lopende projecten".
::: info
- Hier staan links alle projecten met een deadline binnen de 7 dagen en rechts alle projecten.
Expand Down Expand Up @@ -112,13 +94,3 @@ De kaart is als volgt ingedeeld:
- Balk met de voortgang van alle studenten, met hierbij het aantal indieningen en het aantal groepen.
- Status van de uitgevoerde testen voor deze indieningen.
:::

## Lesgevers van een vak opzoeken en aanpasen
- Ga naar de detail pagina van het vak (zie [Vak details](#vak-details)).
BramMeir marked this conversation as resolved.
Show resolved Hide resolved
- Scrol naar de sectie "Lesgevers gelinkt aan dit vak".
- Hier vindt u een lijst van de lesgevers voor dit vak.

::: info
- Via de knop bewerken kan u lesgevers toevoegen aan (of verwijderen van) dit vak.
- Via het vuilbak icoontje kan u lesgevers verwijderen van dit vak. (enige resterende lesgever kan onmogelijk verwijderd worden)
:::
4 changes: 2 additions & 2 deletions docs/nl/student-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Deze pagina beschrijft hoe u als student met Ypovoli interageert.
- Bevestig met de knop uitschrijven.

## Vak details
- Druk in de navigatiebalk op Dashboard.
- Druk in de navigatiebalk op "Dashboard".
- Scrol naar de sectie "Mijn vakken".
- Klik op de details knop bij het gekozen vak.

Expand All @@ -78,7 +78,7 @@ Deze pagina beschrijft hoe u als student met Ypovoli interageert.
![projecten lijst](../assets/nl/project-list.png)

- Optie 1:
- Druk in de naviegatiebalk op Dashboard.
- Druk in de naviegatiebalk op "Dashboard".
- Bovenaan de pagina staat een sectie "Lopende projecten".
::: info
- Hier staan links alle projecten met een deadline binnen de 7 dagen en rechts alle projecten.
Expand Down
16 changes: 8 additions & 8 deletions docs/nl/teacher-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,25 +35,25 @@ Deze pagina beschrijft hoe u als professor met Ypovoli interageert.
![modus keuze knop](../assets/teacher/nl/modus-change.png)

## Aanmaken vak
- Druk in de navigatiebalk op Dashboard.
- Druk in de navigatiebalk op "Dashboard".
- Scrol naar de sectie "Mijn vakken".
- Klik op de + knop.

![vak aanmaak knop](../assets/teacher/nl/course-create-button.png)

:::info
Wilt u u vak enkel beschikbaar plaatsen via een uitnodigingslink kan u dat via deze knop.
Wilt u uw vak enkel beschikbaar plaatsen via een uitnodigingslink, kan u dat via deze knop.
![vak aanmaak knop](../assets/teacher/nl/private-course-button.png)

:::danger
- Activeer deze link via de share knop. (maximum geldigheid is 28 dagen)
- Activeer deze link via de share knop (maximum geldigheid van 28 dagen).
<div style="display: flex; align-items: center;">
<img src="../assets/teacher/course-share-button.png" alt="vak deel knop" style="width: auto; height: 75px; margin-right: 10px;">
</div>
:::

## Vak details
- Druk in de navigatiebalk op Dashboard.
- Druk in de navigatiebalk op "Dashboard".
- Scrol naar de sectie "Mijn vakken".
- Klik op de details knop bij het gekozen vak.

Expand All @@ -69,7 +69,7 @@ Wilt u u vak enkel beschikbaar plaatsen via een uitnodigingslink kan u dat via d
- Druk in de navigatiebalk op Dashboard.
- Druk op "Creëer nieuw project".
- Optie 2
- Druk in de navigatiebalk op Kalender.
- Druk in de navigatiebalk op "Kalender".
- Druk op "Creëer nieuw project".
- Optie 3
- Ga naar detail pagina van een vak (zie [Vak details](#vak-details)).
Expand All @@ -81,7 +81,7 @@ Wilt u u vak enkel beschikbaar plaatsen via een uitnodigingslink kan u dat via d
![projecten lijst](../assets/nl/project-list.png)

- Optie 1:
- Druk in de naviegatiebalk op Dashboard.
- Druk in de naviegatiebalk op "Dashboard".
- Bovenaan de pagina staat een sectie "Lopende projecten".
::: info
- Hier staan links alle projecten met een deadline binnen de 7 dagen en rechts alle projecten.
Expand Down Expand Up @@ -112,12 +112,12 @@ De kaart is als volgt ingedeeld:
- Status van de uitgevoerde testen voor deze indieningen.
:::

## Lesgevers van een vak opzoeken en aanpasen
## Lesgevers van een vak opzoeken en aanpassen
- Ga naar de detail pagina van het vak (zie [Vak details](#vak-details)).
- Scrol naar de sectie "Lesgevers gelinkt aan dit vak".
- Hier vindt u een lijst van de lesgevers voor dit vak.

::: info
- Via de knop bewerken kan u lesgevers toevoegen aan (of verwijderen van) dit vak.
- Via het vuilbak icoontje kan u lesgevers verwijderen van dit vak. (enige resterende lesgever kan onmogelijk verwijderd worden)
- Via het vuilbak icoontje kan u lesgevers verwijderen van dit vak (enige resterende lesgever kan onmogelijk verwijderd worden).
:::