Merge pull request #384 from SELab-2/user_docs

User docs

docs/documentatie.md

@@ -0,0 +1,105 @@
+English version can be found [here](documentation.md)
+
+# Gebruikers handleiding
+
+## homepagina leerkracht / student
+
+Op deze pagina krijg je al jouw huidige projecten te zien. Dit is een snelle overview.
+Dit zijn niet gearchiveerde projecten, en ook projecten die al zichtbaar zijn voor de studenten.
+
+### student
+
+Als student krijg je hier ook een overzicht van al je deadlines gesorteerd op datum.
+
+## projecten pagina
+
+### student
+
+Hier krijg je al jouw projecten te zien. Je kan ook gearchiveerde projecten bekijken.
+
+### leerkracht
+
+Op de projecten pagina kan je al jouw projecten zien, dit zijnde dus de huidige, ge-archiveerde en de projecten
+die nog niet zichtbaar zijn voor de studenten.
+
+## project pagina
+
+### student
+
+Hier krijg je een overzicht van het project.
+
+Dit bevat namelijk de volgende data:
+- de naam van het project
+- de beschrijving van het project
+- jouw groepsleden
+- de deadline
+- de indieningstatus van het project
+- vereisten voor het project als die er zijn
+
+Dit is ook de plaats waar je een indiening kan doen.
+
+Als je nog eens wilt nakijken wat je ingediend hebt kan je ook de laatste
+indiening downloaden.
+
+
+### leerkracht
+
+Hier zie je zowel de huidige data van het project dat de studenten zien.
+En ook kan je de data aanpassen indien nodig.
+
+Verder kan de leerkracht hier ook de indieningen van de studenten bekijken,
+de statistieken om de status van de indieningen te zien.
+
+Op deze pagina staan ook de archiveer en zichtbaarheids knoppen.
+
+Zie [simple constraints](simple_constraints.md) voor meer uitleg hoe je basis bestands beperkingen kan instellen.
+
+Hier kan je ook een docker file uploaden voor jouw geautomatiseerde testen.
+Lees de documentatie van hoe deze werken op de [officiele docker site](https://docs.docker.com/reference/dockerfile/).
+
+## cursussen pagina
+
+Hier krijg je een oplijsting van al jouw cursussen.
+Ook van de reeds gearchiveerde cursussen.
+
+## cursus pagina
+
+### student
+
+Op deze pagina krijg je meer info over je cursus.
+
+Hier kan je al jouw professoren zien, en ook de assistenten.
+
+Daarnaast zie je ook alle projecten die je hebt voor dit vak.
+
+### leerkracht
+
+Hier beheer je vak als leerkracht.
+
+Deze volgende acties kan je doen:
+- de link naar je vak kopiëren. (om dan later te delen met je studenten)
+- een nieuw project aanmaken
+- andere professoren en assistenten toevoegen
+- het vak archiveren
+- het vak verlaten
+
+Verder kan je de volgende data ook zien:
+- de naam van het vak
+- de projecten die je hebt voor dit vak
+- de andere professoren en assistenten
+- de studenten die ingeschreven zijn voor dit vak
+
+## settings
+
+Hier kan je de taal van de website wijzigen. Momenteel is enkel Engels en Nederlands beschikbaar.
+
+Uitloggen doe je ook best via hier.
+
+En ten laatste is er ook een verwijzing naar deze documentatie.
+
+### leerkracht / admin
+
+Voor gebruikers die meerdere rollen hebben kunnen zij hier van rol wisselen.
+Om de website dan te gebruiken als deze nieuwe rol.
+Zo houden we het overzichtelijk. En is het moeilijker om opeens iets te doen dat je niet van plan was.
+

docs/documentation.md

@@ -0,0 +1,5 @@
+Nederlandse documentatie kan [hier](documentatie.md) gevonden worden.
+
+# User manual
+
+these docs still need to be translated please see the [dutch docs](documentatie.md).

docs/index.md

@@ -0,0 +1,5 @@
+# Docs
+
+
+## For english go [here](documentation) (these are incomplete please check the dutch docs, sorry for the inconvenience).
+## Voor nederlands navigeer naar [hier](documentatie).

docs/simple_constraints.md

@@ -0,0 +1,61 @@
+# Project Aanmaken: Simpele Structuur Beperkingen
+
+Docenten kunnen de volledige structuur van een opdracht vastleggen. Ze kunnen de studenten echter ook enige vrijheid bieden, indien gewenst.
+
+Een lesgever kan beslissen of de opdracht een enkel bestand moet zijn of een zip-archief met meerdere bestanden.
+
+## Een bestand als indiening
+
+Wanneer de indiening een enkel bestand betreft, moet de lesgever de naam van dit bestand vastleggen.
+
+![File indiening](images/file_indiening.png)
+
+## Een zip-archief als indiening
+
+Wanneer de indiening een zip-archief betreft, moet de lesgever ook de naam van dit archief vastleggen.
+
+![File indiening](images/zip_indiening.png)
+
+Naast de naam van het archief kan de volledige interne structuur worden vastgelegd. Er kan echter ook volledige vrijheid worden gegeven, of iets ertussenin.
+
+Door met de muis over het archief te slepen, kunnen er bestanden of mappen aan worden toegevoegd:
+
+![hover_zip](images/hover_zip.png)
+
+![map_bestand_lokaal](images/map_bestand_lokaal.png)
+
+Namen die vetgedrukt zijn, stellen mappen voor. Namen in normale tekst zijn bestanden.
+
+Lesgevers die nog meer controle willen over de indiening, kunnen met hun muis over de bestanden of mappen hoveren en op de drie puntjes klikken:
+
+![constraint_veranderen](images/constraint_veranderen.png)
+
+Door op `maak folder` te klikken, kan een bestand worden veranderd in een map, zoals `mijn_map`.
+
+`niet aanwezig` zorgt ervoor dat dit bestand niet aanwezig mag zijn in de map waarin de beperking is gedefinieerd (hier `archief_naam.zip`), maar mogelijk wel in andere mappen:
+
+![verboden](images/verboden.png)
+
+`extensie niet aanwezig` zorgt ervoor dat een bepaalde extensie niet aanwezig mag zijn in de map of het archief waarin de beperking is gedefinieerd:
+
+![extensie_verboden](images/extensie_verboden.png)
+
+`extensie enkel aanwezig` zal er voor zorgen dat enkel de gegeven extensie in de map aanwezig mag zijn:
+
+![alleen_extensie](images/alleen_extensie.png)
+
+## Globale voorwaarden
+
+Soms is het nodig om een beperking over de volledige indiening te definiëren. Dit kan in de sectie `globale voorwaarden`.
+
+![global](images/global.png)
+
+Men kan vastleggen welke bestanden of extensies niet aanwezig mogen zijn met `niet-aanwezig` en `extensie niet aanwezig`. Men kan ook afdwingen dat enkel een bepaalde extensie aanwezig mag zijn over het hele project (mappen niet meegerekend).
+
+## Voorbeeld
+
+![voorbeeld](images/voorbeeld.png)
+
+Dit is een zip-indiening waarbij er zeker een `verslag.pdf`, `src`, `src/frontend` en `src/backend` map aanwezig moet zijn. In de frontend map mag geen `node_modules` aanwezig zijn. De backend map mag enkel `*.py` bestanden bevatten.
+
+Globaal gezien mogen er nergens `.class` bestanden of een `malware.exe` aanwezig zijn.