Skip to content

Commit

Permalink
Merge pull request #358 from BTWS2/main
Browse files Browse the repository at this point in the history
Creating exercises docs feedback
  • Loading branch information
niknetniko authored Nov 17, 2023
2 parents 64dc030 + a255e33 commit f9b519f
Show file tree
Hide file tree
Showing 18 changed files with 67 additions and 50 deletions.
2 changes: 1 addition & 1 deletion en/faq/activities/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Exercises and reading activities
## What is a draft activity? <Badge type="tip" text="teacher" />
A draft is an exercise or reading activity that has not been published yet. Draft activities are only visible for repository owners and course admins and are used to create and test activities before they are published. When you add a new exercise to Dodona, it will automatically be in draft mode until you publish it.

On the home page of Dodona, you can find all your drafts. This gives you an overview of all the activities you are still working on. Once the exercise is ready, you can publish it. To do this, navigate to the activity and click "Publish" at the top of the page.
On the home page of Dodona, you can find all your drafts under _Draft exercises_. This gives you an overview of all the activities you are still working on. Once the exercise is ready, you can publish it. To do this, navigate to the activity and click "Publish activity" at the top of the page.

## How do I create new exercises? <Badge type="tip" text="teacher" />
As a teacher, you can use the hundreds of exercises that are available in Dodona, but you can also create new exercises yourself. You can follow [this guide](/en/guides/exercises/creating-exercises/introduction) for this.
2 changes: 1 addition & 1 deletion en/faq/api-tokens/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Follow the steps below to create an API token on Dodona:
1. **Go to your profile page**: Navigate to your profile page by clicking on the appropriate link in the drop down menu. You can also go directly to [dodona.be/profile](https://dodona.be/en/profile).
![My Profile](./my-profile.png)

2. **Generate a new token**: Once you're on your profile page, scroll to the middle of the page and click the '+' button to generate a new token. You will need to enter a description for your token (e.g. "pycharm"). This description will help you identify the purpose of the token in the future.
2. **Generate a new token**: Once you're on your profile page, scroll to the middle of the page and click the `+` button to generate a new token. You will need to enter a description for your token (e.g. "pycharm"). This description will help you identify the purpose of the token in the future.
![Create a token](./create-new-token.png)

3. **Copy the token**: Once the token is generated, copy and paste it into the authentication dialog of the application you want to authorise, e.g. the PyCharm plugin or the VS Code extension.
Expand Down
6 changes: 3 additions & 3 deletions en/faq/ide-plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Here's how to install the Dodona extension for Visual Studio Code:
![settings](./vs-market.png)
Alternatively, you can install the extension directly from the VS Code Marketplace. Just go to the [Dodona plugin page](https://marketplace.visualstudio.com/items?itemName=thepieterdc.dodona-plugin-vscode) and click the green `Install` button.

3. **Insert API token**: After installing the extension, you need to insert the API token you created earlier. To do this, click on the gear icon in the bottom left corner of VS Code and select 'Settings' (or use the shortcut `Ctrl+,`). Then click on 'Extensions' and select 'Dodona'. Paste the API token you have created into the text box.
3. **Insert API token**: After installing the extension, you need to insert the API token you created earlier. To do this, click on the gear icon in the bottom left corner of VS Code and select 'Settings' (or use the shortcut <kbd>Ctrl</kbd>+<kbd>,</kbd>). Then click on 'Extensions' and select 'Dodona'. Paste the API token you have created into the text box.
![API token](./vs-token.png)

## How can I use the VS Code extension?
Expand All @@ -73,9 +73,9 @@ To use the Dodona VS Code extension, follow these steps:
return i;
}
```
Do not remove this line as VS Code uses it to send you to the correct exercise. If you press `ctrl` (or `cmd` on a Mac) while clicking on the URL, the exercise description will open in a new browser window.
Do not remove this line as VS Code uses it to send you to the correct exercise. If you press <kbd>ctrl</kbd> (or <kbd>cmd</kbd> on a Mac) while clicking on the URL, the exercise description will open in a new browser window.

2. **Submit your solution:** Once you've solved the exercise, you can easily submit your solution by using the 'Submit to Dodona' command. You can do this by opening the command palette with `Ctrl-Shift-P`, typing (part of) `Submit to Dodona` and pressing `Enter`. You can also create a shortcut for this command. This command will submit your code to Dodona and trigger an automatic test.
2. **Submit your solution:** Once you've solved the exercise, you can easily submit your solution by using the 'Submit to Dodona' command. You can do this by opening the command palette with <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>, typing (part of) `Submit to Dodona` and pressing <kbd>Enter</kbd>. You can also create a shortcut for this command. This command will submit your code to Dodona and trigger an automatic test.
![Submit](./vs-submit.png)
3. **Check the result:** After a few seconds, a popup should appear in the bottom right corner showing the result of your submission. Clicking the 'View results' button will open the result in a new browser window. You can submit your solution as many times as you like by repeating the same command.
Expand Down
2 changes: 1 addition & 1 deletion en/references/tested/dsl/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ For example, you cannot check that an assertion error or exception happened.

Specifies the expected return value.

Depening on the value, this attribute is interpreted as:
Depending on the value, this attribute is interpreted as:

- If an untagged string, the string uses the same Python syntax as for [expressions and statements](#expressions-and-statements).
- If it is an untagged object, it is seen as the advanced output for an oracle.
Expand Down
2 changes: 1 addition & 1 deletion en/references/tested/json/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,7 @@ A string with constant value `value`.

#### `.options`

The *GenericValuePracle* does not support any options at the moment.
The *GenericValueOracle* does not support any options at the moment.

### GenericTextOracle

Expand Down
2 changes: 1 addition & 1 deletion nl/faq/accounts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ Dodona krijgt automatisch je naam en e-mailadres van de inlogprovider (bv. Smart

## Ik krijg een waarschuwing dat mijn tijdzone verkeerd is, wat moet ik doen?

Alle deadlines op Dodona worden weergegeven in je lokale tijd. Hiervoor moet Dodona een tijdzone aan je account koppelen. Als we detecteren dat de tijdzone van je browser afwijkt van de tijdzone van je account, geven we een waarschuwing. Je kunt je tijdzone wijzigen in je [Accountinstellingen] (https://dodona.ugent.be/en/profile).
Alle deadlines op Dodona worden weergegeven in je lokale tijd. Hiervoor moet Dodona een tijdzone aan je account koppelen. Als we detecteren dat de tijdzone van je browser afwijkt van de tijdzone van je account, geven we een waarschuwing. Je kunt je tijdzone wijzigen in je [accountinstellingen](https://dodona.ugent.be/nl/profile).
2 changes: 1 addition & 1 deletion nl/faq/activities/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Oefeningen en leesactiviteiten
## Wat is een concept? <Badge type="tip" text="lesgever" />
Een concept is een oefening of leesactiviteit die nog niet is gepubliceerd. Concepten zijn alleen zichtbaar voor de eigenaars van de repository en cursusbeheerders en worden gebruikt om oefeningen te maken en te testen voordat ze worden gepubliceerd. Als je een nieuwe oefening aan Dodona toevoegt, dan zal die automatisch in conceptmodus staan tot je ze publiceert.

Op de startpagina van Dodona kan je al jouw concepten terugvinden. Zo krijg je een overzicht van alle oefeningen die je nog aan het opstellen bent. Eenmaal de oefening klaar is, kan je ze publiceren. Navigeer hiervoor naar de oefening en klik bovenaan de pagina "Publiceren".
Op de startpagina van Dodona kan je al jouw concepten terugvinden onder _Ongepubliceerde oefeningen_. Zo krijg je een overzicht van alle oefeningen die je nog aan het opstellen bent. Eenmaal de oefening klaar is, kan je ze publiceren. Navigeer hiervoor naar de oefening en klik bovenaan de pagina op "Deze oefening publiceren".

## Hoe maak ik nieuwe oefeningen aan? <Badge type="tip" text="lesgever" />
Als lesgever kan je gebruikmaken van de honderden oefeningen die in Dodona aanwezig zijn, maar je kan ook zelf nieuwe oefeningen aanmaken. Je kan hiervoor [dit stappenplan](/nl/guides/exercises/creating-exercises/introduction) volgen.
4 changes: 2 additions & 2 deletions nl/faq/api-tokens/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Volg de onderstaande stappen om een API token aan te maken op Dodona:
1. **Ga naar je profielpagina**: Navigeer naar je profielpagina door op de juiste link in het navigatiemenu bovenaan de pagina te klikken. Je kunt ook direct naar [dodona.be/profile](https://dodona.be/nl/profile) gaan.
![Mijn profiel](./my-profile-nl.png)

22. **Genereer een nieuw token**: Als je op je profielpagina bent, scroll je naar het midden van de pagina en klik je op de knop '+' om een nieuw token te genereren. Je moet een beschrijving invoeren voor je token (bijvoorbeeld "pycharm"). Deze beschrijving kan je in later helpen om een specifiek token te identificeren.
22. **Genereer een nieuw token**: Als je op je profielpagina bent, scroll je naar het midden van de pagina en klik je op de knop `+` om een nieuw token te genereren. Je moet een beschrijving invoeren voor je token (bijvoorbeeld "pycharm"). Deze beschrijving kan je in later helpen om een specifiek token te identificeren.
![Maak een token aan](./create-new-token-nl.png)

3. **Kopieer het token**: Eenmaal het token is aangemaakt, kan je het kopiëren in het dialoogvenster van de toepassing die je toegang wil geven tot je Dodona-account, bijvoorbeeld de PyCharm-plugin
3. **Kopieer het token**: Eenmaal het token is aangemaakt, kan je het kopiëren in het dialoogvenster van de toepassing die je toegang wil geven tot je Dodona-account, bijvoorbeeld de PyCharm-plugin.
![Token generated](./token-generated-nl.png)

::: tip
Expand Down
8 changes: 4 additions & 4 deletions nl/faq/ide-plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Volg de onderstaande stappen om de Dodona plugin voor PyCharm te installeren:

2. **Installeer de plugin**: De Dodona plugin kan direct vanuit PyCharm worden geïnstalleerd. Open het menu 'Bestand' en klik op 'Settings...'.
![Open het voorkeurenmenu](./pc-settings.png)
Selecteer in het menu 'Plugins' de tab 'Marketplace' en zoek naar Dodona. Klik ten slotte op 'Installeren' en 'Opnieuw opstarten'.
Selecteer in het menu 'Plugins' de tab 'Marketplace' en zoek naar Dodona. Klik ten slotte op 'Install' en 'Restart'.
![De plugin installeren](./pc-install.png)
Je kunt de plugin ook rechtstreeks vanaf de JetBrains website installeren. Ga gewoon naar https://plugins.jetbrains.com/plugin/11166-dodona en klik op de blauwe 'Get' knop.

Expand Down Expand Up @@ -56,7 +56,7 @@ Zo installeer je de Dodona-extensie voor Visual Studio Code:
![instellingen](./vs-market.png)
Je kunt de extensie ook rechtstreeks vanuit de VS Code Marketplace installeren. Ga naar de [Dodona plugin pagina](https://marketplace.visualstudio.com/items?itemName=thepieterdc.dodona-plugin-vscode) en klik op de groene 'Install' knop.

3. **API token invoeren**: Na het installeren van de extensie moet je het API-token invoeren dat je eerder hebt aangemaakt. Klik hiervoor op het tandwielpictogram linksonder in VS Code en selecteer 'Settings' (of gebruik de sneltoets `Ctrl+,`). Klik vervolgens op 'Extensions' en selecteer 'Dodona'. Plak het API-token dat je hebt gemaakt in het tekstvak.
3. **API token invoeren**: Na het installeren van de extensie moet je het API-token invoeren dat je eerder hebt aangemaakt. Klik hiervoor op het tandwielpictogram linksonder in VS Code en selecteer 'Settings' (of gebruik de sneltoets <kbd>Ctrl</kbd>+<kbd>,</kbd>). Klik vervolgens op 'Extensions' en selecteer 'Dodona'. Plak het API-token dat je hebt gemaakt in het tekstvak.
![API-token](./vs-token.png)

## Hoe kan ik de VS Code extensie gebruiken?
Expand All @@ -72,9 +72,9 @@ Volg deze stappen om de Dodona VS Code extensie te gebruiken:
return i;
}
```
Verwijder deze regel niet, want VS Code gebruikt hem om je oplossing naar de juiste oefening te sturen. Als je op `ctrl` (of `cmd` op een Mac) drukt terwijl je op de URL klikt, wordt de beschrijving van de oefening in een nieuw browservenster geopend.
Verwijder deze regel niet, want VS Code gebruikt hem om je oplossing naar de juiste oefening te sturen. Als je op <kbd>ctrl</kbd> (of <kbd>cmd</kbd> op een Mac) drukt terwijl je op de URL klikt, wordt de beschrijving van de oefening in een nieuw browservenster geopend.

2. **Stuur je oplossing in:** Als je de oefening hebt opgelost, kun je je oplossing eenvoudig insturen met het 'Submit to Dodona' commando. Je kunt dit doen door het opdrachtenpalet te openen met `Ctrl-Shift-P`, (een deel van) `Submit to Dodona` in te typen en op `Enter` te drukken. Je kunt ook een snelkoppeling maken voor dit commando. Deze opdracht stuurt je code naar Dodona en activeert een automatische test.
2. **Stuur je oplossing in:** Als je de oefening hebt opgelost, kun je je oplossing eenvoudig insturen met het 'Submit to Dodona' commando. Je kunt dit doen door het opdrachtenpalet te openen met <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>, (een deel van) `Submit to Dodona` in te typen en op <kbd>Enter</kbd> te drukken. Je kunt ook een snelkoppeling maken voor dit commando. Deze opdracht stuurt je code naar Dodona en activeert een automatische test.
![Submit](./vs-submit.png)

3. **Controleer het resultaat:** Na een paar seconden zou er rechtsonder een popup moeten verschijnen met het resultaat van je oplossing. Als je op de knop 'View results' klikt, wordt het resultaat in een nieuw browservenster geopend. Je kunt je oplossing zo vaak als je wilt insturen door hetzelfde commando te herhalen.
Expand Down
28 changes: 22 additions & 6 deletions nl/guides/exercises/creating-exercises/exercise/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,35 @@ Als je in de vorige stap van de handleiding de _template repository_ gebruikt he
Hier zullen we nu zelf nog een oefening toevoegen.
De bestaande oefening kan uiteraard als voorbeeld dienen.

::: info Bestanden en mappen maken
1. Selecteer de map waarin je het bestand of de map wil aanmaken.
2. Gebruik de icoontjes bovenaan om een bestand of map aan te maken. Rechtsklikken op de map en kiezen voor `New File...` of `New Folder...` kan ook.
2. Typ de naam van het bestand (inclusief extensie) of map. Kies bij voorkeur een naam zonder spaties.
3. Bevestig met <kbd>Enter</kbd>.
:::

<!--@include: ../../examples/_common.md-->

## 5. Wijzigingen opslaan

Nu de oefening klaar is, moeten we de wijzigingen opslaan in de repository (dat wil zeggen de wijzigingen committen in de repo).
Nu de oefening klaar is, moeten we de wijzigingen opslaan in de repository (dat wil zeggen de wijzigingen _committen_ in de repo).
Doe dit als volgt:

![commit window](./commit.png)

1. Klik aan de linkerkant op het icoontje voor _source control_.
2. Klik op de knop met "+" om alle bestanden klaar te zetten.
3. Kies een _commit message_. Hierin beschrijf je wat je gedaan hebt, zoals "Voeg mijn eerste oefening toe".
4. Klik op de knop _Commit & Push_.
1. Klik aan de linkerkant op het icoontje voor _Source Control_.
2. Klik bovenaan de lijst met wijzigingen op de knop met `+` om alle bestanden klaar te zetten (_Stage All Changes_).
3. Kies bovenaan een _commit message_. Hierin beschrijf je wat je gedaan hebt, zoals "Voeg mijn eerste oefening toe".
4. Klik op de knop `Commit & Push`.

Als alles goed gegaan is, werd dit venster leeg.
Je oefening is nu klaar om te gebruiken op Dodona!

## 6. Oefening testen

De oefening die je daarnet gemaakt hebt, kan je terugvinden in [jouw oefeningenrepository](https://dodona.be/nl/repositories/) op Dodona. Test de oefening. Is alles naar wens? Dan kan je bovenaan de oefening publiceren (_Deze oefening publiceren_). Je oefening is nu klaar om te gebruiken op Dodona!

![Minimum oefening](./minimum.png)

::: tip
Laat je oefening eens oplossen door iemand anders. Zo ontdek je vaak nog gaten in het testplan, en kan je de oefening verder verfijnen.
:::
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 2 additions & 3 deletions nl/guides/exercises/creating-exercises/management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,10 @@ next: false
Nu je een oefening hebt die je kan gebruiken op Dodona, zijn er tal van dingen die je nog kan doen.
Hieronder enkele suggesties voor volgende stappen:

- Los je oefening zelf eens op in Dodona.
- Laat je oefening eens oplossen door iemand anders. Zo ontdek je vaak nog gaten in het testplan, en kan je de oefening verder verfijnen.
- [Maak een cursus aan](/nl/guides/teachers/creating-a-course/).
- [Gebruik je oefening in een cursus](/nl/guides/teachers/exercise-series-management/).
- [Gebruik je oefening in een oefeningenreeks van een cursus](/nl/guides/teachers/exercise-series-management/).
- Maak nog andere soorten oefeningen.
- Maak [leesactiviteiten](/nl/references/exercise-config/) met extra informatie of kleine stukken theorie.

Veel plezier met het gebruik van Dodona!
Zoals steeds, als je vragen hebt of iets is niet duidelijk, aarzel dan niet om [ons te contacteren](https://dodona.be/nl/contact/).
Loading

0 comments on commit f9b519f

Please sign in to comment.