Skip to content

Commit

Permalink
Merge pull request #331 from dodona-edu/enhance/draft-doc
Browse files Browse the repository at this point in the history
Add draft to exercise config reference
  • Loading branch information
jorg-vr authored Oct 26, 2023
2 parents b9fd652 + 049d59d commit 6a64afb
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 4 deletions.
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?
Every newly added activity is considered a draft activity until they are published.

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

## 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.
4 changes: 2 additions & 2 deletions en/references/exercise-config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The structure for a reading activity is identical to that of an exercise. There
{
"type": "exercise",
"programming_language": "python",
"access": "public",
"access": "private",
"description": {
"names": {
"nl": "Voorbeeld oefening",
Expand Down Expand Up @@ -81,7 +81,7 @@ The structure for a reading activity is identical to that of an exercise. There
}
},
"type": "content",
"access": "public",
"access": "private",
"labels": ["test", "intro"]
}
```
Expand Down
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 conceptactiviteit?
Elke nieuw toegevoegde activiteit wordt beschouwd als een conceptactiviteit totdat deze wordt gepubliceerd.

Het idee is dat een activiteit in conceptmodus blijft totdat de maker deze handmatig goedkeurt met behulp van Dodona.

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

### Verwarring vermijden
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 centrale database aanwezig zijn.

### Minder valspositieve foutmeldingen
De Dodona-beheerders worden op de hoogte gebracht van interne fouten tijdens de uitvoering van een oplossing. Wanneer een lesgever 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, krijgen de Dodona-beheerders geen melding van interne fouten.

### Verbeterde vindbaarheid
Wanneer je een nieuwe oefening aan Dodona toevoegt, is het niet altijd gemakkelijk om die oefening te vinden en zelf te proberen. Alle jouw conceptoefeningen staan op de startpagina vermeld, waardoor deze gemakkelijker te vinden zijn.
4 changes: 2 additions & 2 deletions nl/references/exercise-config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ De structuur voor een leesactiviteit is identiek aan deze van een oefening. Er z
{
"type": "exercise",
"programming_language": "python",
"access": "public",
"access": "private",
"description": {
"names": {
"nl": "Voorbeeld oefening",
Expand Down Expand Up @@ -81,7 +81,7 @@ De structuur voor een leesactiviteit is identiek aan deze van een oefening. Er z
}
},
"type": "content",
"access": "public",
"access": "private",
"labels": ["test", "intro"]
}
```
Expand Down

0 comments on commit 6a64afb

Please sign in to comment.