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

Add draft to exercise config reference #331

Merged
merged 6 commits into from
Oct 26, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
24 changes: 24 additions & 0 deletions en/faq/activities/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Activities
---

# FAQ: Activities

[[toc]]

## What is a draft activity?
A draft activity is an activity where the draft flag (boolean) is set to true. This boolean is tracked in both the [exercise config file](/en/references/exercise-config) as well as the database. For all new exercises, the draft state is automatically set to true (similar to the key that is added to the internals). For existing exercises, the draft flag is set to false in the database, but this value isn't added to the config file.

The idea is that an activity stays in draft mode until its creator greenlights it manually using the Dodona UI or the config file.

## What is the effect of a draft activity?
The concept of draft activities serves several goals.

### Prevent clutter
Draft activities are only visible for repository owners and course admins for courses with the activity. This prevents that multiple copies of our example exercises are present in the global database for everyone to see.

### Reduce false-positive error messages
The Dodona admins are notified of severe errors (`internal error`) during the execution of a submission. When a teacher is creating a new exercise and experimenting with adding tests, these errors are quite common. Because of this, the Dodona admins often ignore these messages, causing real issues to be unnoticed. When an exercise is still in draft mode, we will no longer notify the Dodona admins.

### Improve discoverability
When you add a new exercise to Dodona, it is not always easy to find that exercise and try it yourself. We will now list all draft exercises of a user on the home page, making these easier to find.
24 changes: 24 additions & 0 deletions nl/faq/activities/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Activiteiten
---

# FAQ: Activiteiten

[[toc]]

## Wat is een concept activiteit?
jorg-vr marked this conversation as resolved.
Show resolved Hide resolved
jorg-vr marked this conversation as resolved.
Show resolved Hide resolved
Een concept activiteit is een activiteit waarvan de 'draft' vlag (boolean) op true staat. Deze boolean wordt zowel bijgehouden in het [configuratiebestand van de oefening](/nl/references/exercise-config) als in de database. Voor alle nieuwe oefeningen wordt de conceptstatus automatisch op true gezet (vergelijkbaar met de sleutel die aan de interne gegevens wordt toegevoegd). Voor bestaande oefeningen wordt de conceptvlag op false gezet in de database, maar deze waarde wordt niet toegevoegd aan het configuratiebestand.

Het idee is dat een activiteit in conceptmodus blijft totdat de maker deze handmatig goedkeurt met behulp van de Dodona UI of het configuratiebestand.
jorg-vr marked this conversation as resolved.
Show resolved Hide resolved

## Wat is het doel van concept activiteiten?
Concept activiteiten dienen verschillende doelen.

### Klutter vermijden
jorg-vr marked this conversation as resolved.
Show resolved Hide resolved
Concept activiteiten zijn alleen zichtbaar voor repository-eigenaren en cursusbeheerders voor cursussen met de activiteit. Dit voorkomt dat er meerdere kopieën van onze voorbeeldoefeningen in de wereldwijde database aanwezig zijn.
jorg-vr marked this conversation as resolved.
Show resolved Hide resolved

### Reduceer vals-positieve foutmeldingen
jorg-vr marked this conversation as resolved.
Show resolved Hide resolved
De Dodona-beheerders worden op de hoogte gebracht van ernstige fouten (`interne fout`) tijdens de uitvoering van een inzending. Wanneer een leraar een nieuwe oefening maakt en experimenteert met het toevoegen van tests, komen deze fouten vaak voor. Hierdoor negeren de Dodona-beheerders deze berichten vaak, waardoor echte problemen onopgemerkt blijven. Wanneer een oefening nog in conceptmodus is, zullen we de Dodona-beheerders niet langer op de hoogte stellen.
jorg-vr marked this conversation as resolved.
Show resolved Hide resolved

### Verbeterde vindbaarheid
Wanneer je een nieuwe oefening aan Dodona toevoegt, is het niet altijd gemakkelijk om die oefening te vinden en zelf te proberen. We zullen nu alle conceptoefeningen van een gebruiker op de startpagina vermelden, waardoor deze gemakkelijker te vinden zijn.
jorg-vr marked this conversation as resolved.
Show resolved Hide resolved