Skip to content

Migrating guide for students from dodona-docs #72

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

Merged
merged 95 commits into from
Sep 5, 2020
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
95 commits
Select commit Hold shift + click to select a range
18ef13f
Converted the for students guide page. Still need to split this over …
LucianosLionakis Aug 12, 2020
89e11e4
Added style for a guilabel
LucianosLionakis Aug 12, 2020
3c86849
Fixed typo
LucianosLionakis Aug 12, 2020
401e44c
Split the guide for students in four parts the introduction, login + …
LucianosLionakis Aug 12, 2020
2374419
Added translation of for-students page, but still need to add the links
LucianosLionakis Aug 14, 2020
8e2893a
Started translating setting and login for students
LucianosLionakis Aug 14, 2020
d71c520
Fully translated login and settings for students guide
LucianosLionakis Aug 14, 2020
dbce58e
Some small grammatical corrections
LucianosLionakis Aug 14, 2020
dc02d02
Added all the required images and made some corrections
LucianosLionakis Aug 14, 2020
aa6a4ae
Started translation, after meeting we concluded that translation shou…
LucianosLionakis Aug 14, 2020
76a86ce
Updated information about were the courses can be found. Removed part…
LucianosLionakis Aug 14, 2020
3f63f8a
Corrected outdated infor in the courses guide for students
LucianosLionakis Aug 17, 2020
f8b6ee7
Removed outdated info from exercises guide for students
LucianosLionakis Aug 17, 2020
bdc41e1
Added all links of exerises guide for students
LucianosLionakis Aug 17, 2020
28bd671
Fixed links for courses guide for students
LucianosLionakis Aug 17, 2020
d62f2d7
Update nl/guides/exercises-for-students/README.md
LucianosLionakis Aug 18, 2020
44049e9
Update nl/guides/exercises-for-students/README.md
LucianosLionakis Aug 18, 2020
fc1da15
Moved files as suggested by @rien
LucianosLionakis Aug 18, 2020
e0f1100
Turned next page on in settings and added custom next pages were needed
LucianosLionakis Aug 18, 2020
925f541
Added dutch in the english version (comment everything that was alrea…
LucianosLionakis Aug 21, 2020
8874ba4
Corrected wrong links
LucianosLionakis Aug 21, 2020
1d01ab8
Cleaned up uneeded images. Changed links from absolute paths to relat…
LucianosLionakis Aug 21, 2020
c776678
Fixed some more links
LucianosLionakis Aug 21, 2020
021f03d
Fixed some more links
LucianosLionakis Aug 21, 2020
5b7811b
Updated the course exercise status and submissions icons in the for s…
LucianosLionakis Aug 24, 2020
c1cfa63
Updated images and links to those images in the corresponding readme …
LucianosLionakis Aug 27, 2020
d9a6947
Added two missing images
LucianosLionakis Aug 27, 2020
a5ee987
Modified most new images to beter versions
LucianosLionakis Aug 28, 2020
4cbf630
Fixed all links to empty h1 anchors and updated wrong_timezone image …
LucianosLionakis Aug 28, 2020
db54abd
Made title consistent
LucianosLionakis Aug 28, 2020
182547a
Made the title of getting started guide more consistent with the for …
LucianosLionakis Aug 28, 2020
fe89841
Updated title of both for student and getting started guides
LucianosLionakis Aug 28, 2020
41613b4
Added link to student guide and updated text of link to getting start…
LucianosLionakis Aug 28, 2020
4b00923
Correction of mistakes in some titles, added what is dodona paragraph…
LucianosLionakis Aug 28, 2020
8af3b23
Added the login-and-settings, exercises and courses guides to the sid…
LucianosLionakis Aug 28, 2020
3b14ed6
Added main title and a sentence summarizing the content
LucianosLionakis Aug 28, 2020
19ed003
Removed guilabel style and replaced all its accurences using backticks
LucianosLionakis Aug 28, 2020
c854cc2
Removed nextlink option and update some parts in the en copies of the…
LucianosLionakis Aug 28, 2020
72fbdfe
Added table of content to login and settings guide
LucianosLionakis Aug 28, 2020
8b8ae66
Restructured and rewrote the login paragraphs and removed all bold wo…
LucianosLionakis Aug 28, 2020
de8025a
Update nl/guides/for-students/login-and-settings/README.md
LucianosLionakis Aug 31, 2020
32fe959
Update nl/guides/for-students/login-and-settings/README.md
LucianosLionakis Aug 31, 2020
8c699df
Update nl/guides/for-students/login-and-settings/README.md
LucianosLionakis Aug 31, 2020
b903a52
Update nl/guides/for-students/login-and-settings/README.md
LucianosLionakis Aug 31, 2020
03f4949
Removed last guilabel, replaced all 'druk(ken)' by 'klik(ken)' and li…
LucianosLionakis Sep 1, 2020
9f6c097
Rephrased the first sentence of 'Aanmelden'
LucianosLionakis Sep 1, 2020
55ca4e9
Removed tip about changing accounts
LucianosLionakis Sep 1, 2020
2507939
Update nl/guides/for-students/login-and-settings/README.md
LucianosLionakis Sep 1, 2020
f04134d
Update nl/guides/for-students/login-and-settings/README.md
LucianosLionakis Sep 1, 2020
29d59ff
Merge branch 'move-guide-for-students' of https://github.com/dodona-e…
LucianosLionakis Sep 1, 2020
d009358
Removed tip about navigating to homepage and integrated it to the pre…
LucianosLionakis Sep 1, 2020
51468f6
Added table of contents to all the pages and corrected or made titles…
LucianosLionakis Sep 1, 2020
f01e005
Removed tip about downloading pdf of exercise
LucianosLionakis Sep 1, 2020
37232c7
Reworked 'Navigeren naar een cursus section'
LucianosLionakis Sep 1, 2020
3d6b82c
Mentioned that you can hand in as many times as you want and that onl…
LucianosLionakis Sep 1, 2020
f618237
Made explanation about IDE less verbose
LucianosLionakis Sep 1, 2020
2d4e768
Removed 'wachtrij' anchor
LucianosLionakis Sep 1, 2020
ee58b16
Removed note canceling the evaluation of a solution
LucianosLionakis Sep 1, 2020
a9c8841
Corrected some grammatical mistakes
LucianosLionakis Sep 1, 2020
95b78ab
Removed tip about being able to submit as much as you want and integr…
LucianosLionakis Sep 1, 2020
44ddb26
Removed links to 'startpagina' anchor since this title was removed
LucianosLionakis Sep 1, 2020
27ffbf1
Removed links to 'gebruikersmenu' anchor since it was removed
LucianosLionakis Sep 1, 2020
1496f08
Reformated items to bullet points
LucianosLionakis Sep 1, 2020
35cbc02
Removed some anchors and integrated detail to the previous point abou…
LucianosLionakis Sep 1, 2020
b0b28f0
Rewrote the first part of the 'Navigeren naar een oplossing' section
LucianosLionakis Sep 1, 2020
f25aed3
Corrected some grammatical errors
LucianosLionakis Sep 1, 2020
26c64ae
Changed title and removed details about checking if you are registere…
LucianosLionakis Sep 1, 2020
41d223a
Fixed a two wrong links in exercises readme
LucianosLionakis Sep 1, 2020
38fa7a6
Big refactor of for student courses guide
LucianosLionakis Sep 1, 2020
d664e49
Removed empty links and filled some to link to the courses guide for …
LucianosLionakis Sep 1, 2020
15ff986
Fixed some more links that broke because of the reformating of the co…
LucianosLionakis Sep 1, 2020
6cefaeb
Apply suggestions from code review
LucianosLionakis Sep 2, 2020
a00b984
Apply suggestions from code review for courses guide
LucianosLionakis Sep 2, 2020
d70cff0
Changed order of courses and exercise guides
LucianosLionakis Sep 2, 2020
fa28d84
Used a screenshot that fits
LucianosLionakis Sep 2, 2020
19e1954
Removed deadline subtitle
LucianosLionakis Sep 2, 2020
82184c3
Corrected a typo
LucianosLionakis Sep 2, 2020
85d862a
Removed Menu title and changed paragraphs to an unorderd list
LucianosLionakis Sep 2, 2020
4d7cde6
Update nl/guides/for-students/courses/README.md
LucianosLionakis Sep 2, 2020
e322947
Merge branch 'move-guide-for-students' of https://github.com/dodona-e…
LucianosLionakis Sep 2, 2020
23c5574
Removed 'statistieken' section and 'indienstatus' subtitle.
LucianosLionakis Sep 2, 2020
137bcef
Apply suggestions from code review for login and settings guide
LucianosLionakis Sep 2, 2020
50b89ea
Changed configto make sidebar better but wasn't able to solve highlig…
LucianosLionakis Sep 2, 2020
679b81f
Removed all links in exercise that didn't seem needed
LucianosLionakis Sep 2, 2020
a04af88
Removed links from tip and moved text in tip to the main text
LucianosLionakis Sep 2, 2020
7ade3f2
Updated registration screenshots so that they actually look like scre…
LucianosLionakis Sep 3, 2020
a566c32
Updated the english version (that are actually in dutch), added a war…
LucianosLionakis Sep 3, 2020
1b8a013
Updated registation message screenshot in english version
LucianosLionakis Sep 3, 2020
b7b9392
Updated images containing the profiler for english and dutch version
LucianosLionakis Sep 3, 2020
cd9daf1
Fixed broken links
LucianosLionakis Sep 3, 2020
f949f37
Updated sing in page screenshot
LucianosLionakis Sep 3, 2020
317ee84
Moved screenshots of icons out of the guides so that there aren't any…
LucianosLionakis Sep 4, 2020
41f0a1c
update main and sign in
bmesuere Sep 5, 2020
e8cf9dc
update course page
bmesuere Sep 5, 2020
c33329b
finish exercises page
bmesuere Sep 5, 2020
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
4 changes: 4 additions & 0 deletions .vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,10 @@ function getGuidesSidebar(lang, groupTitle, FirstItem) {
sidebarDepth: 2,
children: [
['', FirstItem],
'for-students/',
'login-and-settings-for-students/',
'courses-for-students/',
'exercises-for-students/',
'getting-started/',
'pycharm-plugin/',
'new-exercise-repo/',
Expand Down
10 changes: 10 additions & 0 deletions .vuepress/styles/index.styl
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,13 @@

.home .hero img
max-width 450px!important

.guilabel
border 1px solid #7fbbe3
background #e7f2fa
font-size 80%
font-weight 700
border-radius 4px
padding 2.4px 6px
margin auto 2px
white-space nowrap
12 changes: 12 additions & 0 deletions en/guides/courses-for-students/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Course guide for students
description: "Tutorial: course guide for students"
---

## Navigating to a course

Course managers can build [courses]() out of [exercises]() grouped in [exercise series](). If you are [registered]() for a course it is possible to submit solutions for exercises belonging to that course. There are different places you can select a course:

- On the left side of your homepage, there are cards for all the courses you are registered in, grouped by academic year. Use the search bar at the top of the homepage to search for a specific course by searching for the name of the course, the teacher, or the academic year. Select a course by clicking on the colored title bar on the card of the course or by clicking on <span class="guilabel">GO TO THIS COURSE</span> at the bottom of the course card.

- If you have pending registration requests for courses, then you can find these courses in the panel <span class="guilabel">Awaiting approval</span> in the right column of your homepage. You can select one of these courses by clicking on its name.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions en/guides/for-students/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Starting with Dodona as a student
description: "Tutorial: starting with Dodona as a student"
---

# Dodona for students

As a student, you can [register]() for one or more courses. Every course has [exercises]() that are grouped in [series](). For each [exercise]() an arbitrary amount of [solutions]() can be [submitted](). These submissions will automatically be judged and annotated with [feedback](). All the actions mentioned require you to have an [account]() and that you are [logged in]() on Dodona.

## Get in touch

If you have any questions about the way Dodona works or any interesting ideas that you want to share about the extension or enhancement of the platform, don't hesitate to contact us. Any comments and/or suggestions are more than welcome. Contacting us can be done by navigating to the **contact page** by clicking on the <span class="guilabel">Contact</span> button in the **footer** (at the bottom of every page).

![image](./contact.en.png)

Fill the information in the panel <span class="guilabel">Get in touch</span> and when you are ready press on the send button in the upper right corner of the panel.
Binary file added en/guides/for-students/contact.en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
110 changes: 110 additions & 0 deletions en/guides/login-and-settings-for-students/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
title: Sign-in and user settings
description: "Tutorial: sign-in and user settings"
---

## Selecting a language

In Dodona, you have two **languages** to choose from, Dutch and English. To change your language use the **language menu** on the right side of the **navigation bar** (which can be found at the top of each page).

![image](./choose_language.en.png)

If you select a [language]() while you are logged in, it will be set as your preferred language in your [user settings]().

::: details Note

The language used for fixed components of Dodona (menubar, course structure, notifications, ...) are shown is fully controlled by the platform. These components are always shown in the selected [language]().

The name and description of a [course]() are fixed, as are names and descriptions of [exercise series]() within a course. These components do not depend on the selected [language](). The language of these components falls entirely under the control of the course administrators that created the course.

The name and description of an [exercise]() depend on the selected [language](). If a translation of the name and description was provided in the selected language when creating the exercise, theses components of the exercise will also be displayed in that language.

The language of feedback on a submitted solution for an exercise is completely under the control of the judge with which the exercise is associated. The judge can make the language of this feedback depend on the language selected at the time the solution is submitted.
:::

## Sign-in

To be able to sign-in you need a user account on Dodona. In the associated user profile, you can set your personal preferences on your user profile to personalize your experience. All the actions you perform &mdash; like registering for a course or submitting a solution &mdash; are linked with your user account.

::: tip Important

Sign-in on Dodona can be done by selecting your educational institution on the login page. As a High School student, you can also use your Smartschool, Office 365, or G Suite account provided by your school.

:::

Press on <span class="guilabel">Sign in</span> on the right side of the navigation bar or navigate to the homepage and press on <span class="guilabel">Sign in</span> that can be found in the center of the homepage.

![image](./login.en.png)


::: tip

You can only log in if you aren't already logged in. You can see that you are logged out if you can see the <span class="guilabel">Sign in</span> button on the right side of the [navigation bar](). If you are logged in, the name of your account can be seen at the same place. This is the [user menu]().
:::

Select your educational or research institution on the login page. If you are a High School student you can select the Smartschool, Office 365, or G Suite options. After selecting your preferred login, follow the specified log in procedure.

![image](./institution.en.png)

::: tip Important

A few educational or research institutions explicitly ask for your permission to send some personal data to Dodona. Mostly you only need to give these permissions once per computer you use to log in. Dodona uses the personal data only for the internal management of your user profile and never exchanges this information with third parties.
:::

::: details Note

The authentication of user accounts from external educational or research institutions, Dodona supports both [SAML](https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language) and [OAuth](https://en.wikipedia.org/wiki/OAuth). Ask an IT administrator or teacher from your educational or research institution to contact us if you would like to give access to all the user accounts of your institution to Dodona. This service is free.
:::

If this is the first time you log in on Dodona, a new user account will automatically be created using the personal data sent by your external educational or research institution. In the user profile of this user account, you can set personal preferences for the language and time zone used by Dodona.

::: tip Important

If you have user accounts from different educational or research institutions, each one will correspond to a separate user account on Dodona.
:::

::: tip

If you want to change to another user account than the one you are currently logged in with, then you need to log out and log in with the other user account.
:::

If you are logged in the **user menu** with your user name will be visible on the right side of the navigation bar. The user menu is at the place where the <span class="guilabel">Sign in</span> button was before you logged in.

![image](./student.user_menu.en.png)

When logged in the homepage will change to a personalized page with an overview of all the courses for which you are registered, their exercise series with a deadline, and your progress on submitting solutions for the exercises. This makes it easy to recognize if you are logged in or not.

::: tip

You can navigate to your homepage or to the neutral homepage (if you aren't logged in) from any page by clicking on the <span class="guilabel">Dodona</span> button on the left side of the navigation bar.
![image](./student.navigate_to_homepage.en.png)
:::

If this is your first time you log in on Dodona you won't be registered in any courses and you won't have any submitted solutions. Because of this your homepage will seem a bit empty.

![image](./student.homepage.en.png)

## Setting your personal preferences

Choose <span class="guilabel">My profile</span> in the [user menu]() on the right side of the [navigation bar](#selecteren-van-de-taal) to navigate to your **profilepage**.

On your profile page, you can see your **personal data** (first name, family name, user name, and e-mail address) and a few **personal preferences** that together form your profile page. Dodona uses the user profile to personalize your user experience.

![image](./student.user_menu_my_profile.en.png)

Press on the edit button on the upper right corner of your profile page to edit your user profile. You can't edit your personal data. It gets automatically changed based on the personal data sent to Dodona by the external educational or research institution that was used during the login.

![image](./student.edit_profile.en.png)

In your user profile, you can set the timezone that should be used for all the time indications on the platform (for example the time at which your solution was submitted or the deadline for a series of exercises).

![image](./student.edit_timezone.en.png)

::: tip

If the timezone of your user profile doesn't match with the local timezone as the timezone detected by your browser, then you will get a notification indicating that all time indications on the platform do not correspond to the local timezone.

![image](./student.wrong_timezone.en.png)

You can only remove this notification by setting the timezone in your user profile to the local timezone. Notice that the notification contains a link that will directly send you to your profile page.
:::
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions nl/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ sidebarDepth: 0
Hier vind je enkele handleidingen, vooral gericht op lesgevers.

## In het Nederlands
* [Dodona voor studenten](for-students)
* [Van start met Dodona](getting-started)
* [Dodona PyCharm plugin](pycharm-plugin)
* [Een nieuwe repository met oefeningen maken](new-exercise-repo)
Expand Down
Loading