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

Conversation

LucianosLionakis
Copy link
Contributor

@LucianosLionakis LucianosLionakis commented Aug 12, 2020

  • Converted rst to md
  • Split content in to multiple pages
    • Introduction links fix
    • Login + Information links fix
    • Exercise links fix
    • Course links fix
  • Translate in to english (Should be done later when the dutch version is acceptable)
    • Introduction
    • Login + Information
    • Exercise
    • Course
  • Add the new pages in the left side bar
  • Update images (see Add Curling exercise and update some screenshot #81 for remaining images to be updated):
    • in the course guide to show that the hamburger menu contains "Mijn vakken" heading instead of the user menu (student.my_courses.nl.png)
    • submissionicons

@LucianosLionakis LucianosLionakis marked this pull request as ready for review August 17, 2020 12:23
@LucianosLionakis LucianosLionakis requested a review from rien August 17, 2020 12:24
Copy link
Member

@rien rien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 'for students' guide is now split into multiple pages, but this breaks the natural flow between these tutorial pages. Is it possible to create the following directory structure:

guides/
  for-students/
    README.md
    login-and-settings/
      README.md
    exercises/
      README.md
    courses/
      README.md

Thereby "grouping" the pages in this tutorial.

The page guides/for-students/README.md could then contains the introduction and a small table of contents. On the bottom of each page we could also place a link to the next page (maybe this is possible to do automatically?).

I've also noticed a bug where you have to click twice on a link to a <h1 id=... />, any idea what might cause this problem?

@LucianosLionakis
Copy link
Contributor Author

I've also noticed a bug where you have to click twice on a link to a <h1 id=... />, any idea what might cause this problem?

No, and I couldn't find a solution to this problem...

Copy link
Member

@bmesuere bmesuere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm tired of reviewing and will continue later. I read up to indienstatus. You can already remove all other links from the page except if they are useful.

@LucianosLionakis
Copy link
Contributor Author

  • On the "van start met Dodona als student" page, the item isn't highlighted in the sidebar

@bmesuere I am not sure how to solve this problem without changing the structure of the documentation. I tried many different things but nothing got the highlighting working. I also didn't find anything relevant to the issues of vuepress (or the internet). I fear that the nested structure of the for-students guide is the cause of the problem.

A possible solution would be to split the guides at a higher level, and for example, create a guides-for-students and a guides-for-teachers (and maybe a guides-for-admins) which would get rid of the nesting in the for-student guide.

Copy link
Member

@bmesuere bmesuere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tests fail, but this is because of a link to https://dodona.ugent.be/profile which will start working if we deploy the next dodona release

@bmesuere bmesuere merged commit 4a3d1c6 into main Sep 5, 2020
@bmesuere bmesuere deleted the move-guide-for-students branch September 5, 2020 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants