carpentries / instructor-training

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

Fix typo in cutting call out #1643

Closed brownsarahm closed 2 weeks ago

brownsarahm commented 4 months ago

attempts to fix #1642

I did something slightly different than the suggestion, but i agree there was a typo in the box.

I think leaving it at the top actually makes sense for two reasons:

  1. in theory, trainees are coming back to this page as a reference after the workshop more often than reading it when they would not know what we mean by cutting, and having a warning at the top of the episode that the version they saw in their workshop may have been truncated
  2. it serves as an additional reminder to trainers that this episode is a good place to make up time if needed. While a trainer would see the entirety of the episode while preparing, I think at the top it is more likely to catch & support in real time a new trainer who might be nervous; that is the note to cut from this episode and reassurance that others cut here too, could help prevent someone from speeding up instead of cutting, but for that to work, the reminder has to be before the content that would be cut.

If others 1) agree with that rationale 2) think it is worth making more findable, we could put a (shortend; edited for clarity) version of that justification in the box too.

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/instructor-training/compare/md-outputs..md-outputs-PR-1643

The following changes were observed in the rendered markdown documents:

 18-preparation.md | 12 ++++++++++--
 md5sum.txt        |  2 +-
 2 files changed, 11 insertions(+), 3 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-06-04 15:56:46 +0000

brownsarahm commented 4 months ago

That is a good point, actually with instructor view, maybe we do audience specific versions approximately like:

ndporter commented 3 weeks ago

@brownsarahm what do you think of the changes I proposed in response to your suggestion?

brownsarahm commented 2 weeks ago

I like it, thanks! @ndporter