lesson-example

lesson-example copied to clipboard

Following carpentries/styles#310, the use of the `relative_root_path` variable should be documented.

fmichonneau

Use submodules to easy bootstrap new lesson

6

@jduckles was talking with me about using Git submodules to easy bootstrap new lessons. For a example, see https://github.com/coderefinery/git-intro. [GitHub Pages supports submodule](https://help.github.com/articles/using-submodules-with-pages/)! > If your GitHub Pages site repository...

rgaiacs

The diagram should mention the Python script to initialise the lesson.

rgaiacs

Callout icon legend

2

@ChristinaLK wrote > Suggestion: create a default page somewhere in the template that describes what each icon in the callout boxes stands for. > > From instructor training issue https://github.com/swcarpentry/instructor-training/issues/292....

rgaiacs

One thing we've talked about is have a lesson status, so we can know when lessons are being actively taught or retired, or in development. A similar idea came up...

tracykteal

Some text seems missing

2

Just before Point 7, there is a sentence that just ends `and` with no further info or full stop and then it goes straight on to the point. Can this...

weaverbel

Use correct dash character

3

In https://github.com/swcarpentry/python-novice-inflammation/pull/478, @cleary3 asked to use the correct dash. This is something that doesn't bother me too much but I know it does for others. If we decide to use...

rgaiacs

Related with https://github.com/swcarpentry/lesson-example/issues/175. This need to be implemented at https://github.com/swcarpentry/lesson-example/blob/gh-pages/bin/lesson_check.py. We should parse the Markdown file looking for ~~~ [click here]() ~~~ on it and raise a error if found.

rgaiacs

When to use backticks

1

We should answer @gcapes's question, https://github.com/swcarpentry/shell-novice/pull/522#issuecomment-283280606, on the example that at the moment is our style guide.

rgaiacs

GitHub screenshot

1

On #67, @timtomch uses his own user for the screenshots. Can we use @swcarpentry user for the screenshots? This will enable more people to take the screenshots and avoid to...

rgaiacs