carpentries / instructor-training

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

Add content to the teaching demo tips in instructor-notes.md #1623

Closed ragamouf closed 10 months ago

ragamouf commented 12 months ago

I offer 2 key changes here. Firstly, to share a template for a teaching demo etherpad. I can't believe I haven't done this before!

Secondly, the language around the tips is awkwardly passive. I have done a bit of grammatical fiddling to simplify how the tips are introduced.

github-actions[bot] commented 12 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/instructor-training/compare/md-outputs..md-outputs-PR-1623

The following changes were observed in the rendered markdown documents:

 instructor-notes.md | 10 +++++-----
 md5sum.txt          |  2 +-
 2 files changed, 6 insertions(+), 6 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 2023-12-21 00:05:04 +0000