search

carpentries / lesson-development-training

Collaborative Lesson Development Training curriculum
https://carpentries.github.io/lesson-development-training/
Other
10 stars 18 forks source link

Formalise use of Lesson Design Notes document #361

Closed tobyhodges closed 4 months ago

tobyhodges commented 4 months ago

Resolves #335 by prompting use of the Lesson Design Notes document in various exercises. I also adjusted the structure and content of the LDN template doc to better align with the curriculum.

github-actions[bot] commented 4 months ago

Thank you!

Thank you for your pull request :smiley:

:robot: This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

Rendered Changes

:mag: Inspect the changes: https://github.com/carpentries/lesson-development-training/compare/md-outputs..md-outputs-PR-361

The following changes were observed in the rendered markdown documents:

 audience.md   | 18 ++++++++----------
 md5sum.txt    |  6 +++---
 narrative.md  |  7 +++++--
 objectives.md |  3 ++-
 4 files changed, 18 insertions(+), 16 deletions(-)
What does this mean? If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

:stopwatch: Updated at 2024-05-13 11:38:31 +0000