carpentries / carpentries/instructor-training

Standardize formatting in Suggested Lesson Tables

Open
#1,428 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
189
Forks
301
Avg merge
2d 12h
Merged PRs (30d)
9

Description

Clean up minor inconsistencies in [suggested lessons](https://carpentries.github.io/instructor-training/demo_lessons/index.html) including:
* consistent phrasing, capitalization, and punctuation for explanations (e.g. "none" vs. "No episodes"; "Avoid all episodes.", etc)
* consistent language use in the Spanish lessons (one note in English, rest in Spanish)
* Consistent decision to use unordered lists (`*`) or line breaks (`
`) to separate rows in good/avoid lessons cells (ex: SC R Gapminder uses rows while most use lists)

Additionally, I suggest we consider using lists (`*`) in all good/avoid lesson cells, even when it's just one item for consistency.

Contributor guide

Open the contributing guide

Research direction

Start from the linked Suggested Lessons page and locate the source for its lesson tables. Review the explanations, Spanish notes, and good/avoid lesson cells for the stated wording, language, punctuation, and separator inconsistencies. Done means the tables follow one consistent convention and the resulting page has no remaining inconsistencies.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.