carpentries / carpentries/workshop-template

Syllabus may lead to wrong lesson

Open
#648 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
270
Forks
531
Avg merge
5d 6h
Merged PRs (30d)
1

Description

In the end of the syllabus section of the workshop page a link to the lesson page is provided for each part of the course (e.g., unix, python, R...). Where there are several lessons for the same course part (for example, python), this link may lead to the *wrong* reference page (for example, for python it by default leads to https://swcarpentry.github.io/python-novice-inflammation/reference/, but the instructors may have chosen the alternative lesson http://swcarpentry.github.io/python-novice-gapminder/reference/).

It is not straight forward to see that this link needs to be checked/replaced. The contents of the reference pages of alternatives lessons may be comparable or identical, so one does not necessarily notice when double-checking the course homepage. But when they click on subsequent links, students/teachers may end up in the wrong lesson. In my home institution, several alternative lessons are used frequently. I've seen this link leading to the wrong page several times.

Proposed solution:
Add a note in the customisation instructions that the reference links need to be checked/replaced and what part of the lesson page (.../reference) they should lead to.
Even better would be the possibility to specify in the header which lesson(s) are used, and then the reference links would be updated automatically. Like that, one could even steer which sections should show up in the schedule/syllabus and prevent frequent mistakes (as it says in index.md).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.