carpentries / instructor-training

Instructor Training
https://carpentries.github.io/instructor-training/
Other
175 stars 290 forks source link

Lesson titles don't match table #1601

Open karenword opened 12 months ago

karenword commented 12 months ago

What is the problem?

In the "Lessons for Teaching Demonstrations" page, some titles listed don't match the apparent titles of the lessons.

e.g. Data Analysis and Visualization in R reads "R for Social Scientists" when you go to the lesson.

Location of problem (optional)

https://carpentries.github.io/instructor-training/demo_lessons.html

paulapappalardo commented 12 months ago

Me and Hao Ye identified two other cases of this issue, where the urls do not match the names of the Episodes:

1) With Data Carpentry R lesson: The Episode 02 "Introduction to R" has url https://datacarpentry.org/R-ecology-lesson/01-intro-to-r.html which can be confusing. And episode 1 "Before we start" has url https://datacarpentry.org/R-ecology-lesson/00-before-we-start.html.

2) With Software Carpentry lesson: The Summary and setup Episode for the "Programming with Python" lesson has url https://swcarpentry.github.io/python-novice-inflammation/. Even though they do not have number, the names of other episodes in the lesson do not quite match the name (e.g., Episode "Analyzing patient data" has link https://swcarpentry.github.io/python-novice-inflammation/02-numpy.html

I think having the names and link match can help when checking the episodes that are being chosen for the teaching demos. Thank you for considering the suggestion.

ndporter commented 11 months ago

There's 2 different issues showing up here and they would need to be addressed differently:

  1. The original example is a case when there are 2 titles for a lesson. This is in a number of DC workshops, I think, because as part of the workshop, there's not really a need to say "social science" in every lesson BUT as a standalone lesson or website, it's useful to have that label there. This does have the possibility to be confusing, but it's more of a branding decision (is consistency or contextuality of the names more important) than a technical one.
  2. When it comes to lesson numbers, these are artifacts of differences between old practices and sandpaper and how it builds lessons. A number of lessons have Before we start pages that give more background on the software and lesson than the Setup page people land on and they have historically been numbered Episode 0. But Sandpaper always labels the first episode 1 when it presents the lesson and goes from there. The create_episode_[...] functions in sandpaper don't number lessons in the names at all by default, so a new lesson wouldn't have the ##- prefix unless someone uses the make_prefix=TRUE option. If they do use make_prefix it will likely have the same issue though, because create_lesson automatically creates an introduction episode but prefix numbering starts at 01-.

All of which is to say that if this is an important issue (for the numbering), we could manually check each of the main lessons for this issue and make updates, but we would also need to do the same for Incubator lessons eventually, and possibly update sandpaper's defaults (for example, to use the auto-renumbering that I think is in there somewhere).