Added an exercise/top tips for collaboration

[anenadic]

Added a 20 minute exercise to reflect on best practices for collaborating on a lesson development project. This means we need to check if this addition fits within the schedule or something needs to be cut down.

Fixes #233.

Noticed some issue with lists within solution div not being renderred as expected. Bullet point lists without a empty like between points is renderred as one big block of text. Numbered lists are not showing numbers. Maybe it is just me missing some knowledge.

[github-actions]

Thank you!

Thank you for your pull request 😃

🤖 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:

• 🎯 correct output
• 🖼️ correct figures
• ❓ new warnings
• ‼️ new errors

Rendered Changes

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

The following changes were observed in the rendered markdown documents:

 md5sum.txt  |  2 +-
 wrap-up3.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 47 insertions(+), 2 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.

⏱️ Updated at 2023-09-19 13:49:10 +0000

[anenadic]

Tagging @jt14den to check/review this too as it was his suggestion to include some kinds of top tips.

[sstevens2]

Will review shortly. I've had issues with numbered/bulleted lists in that they require a blank line before they start so something like

This list contains 3 things...
1. item 1
2. item 2
3. item 3

Would not work but...

This list contains 3 items...

1. item 1
2. item 2
3. item 3

does render.

I've not seen this issue with solution block lists though. Curious, what happens if you force break the lines with extra spaces at the end?

[sstevens2]

This looks like a wonderful addition @anenadic!

I've left a couple of small comments and a suggestion for some rearrangement of the end challenge.
As for time, perhaps the updates you made to the collaboration section with the removal of the project boards will make time already? Would love to hear what others think.

[anenadic]

Will review shortly. I've had issues with numbered/bulleted lists in that they require a blank line before they start so something like

This list contains 3 things...
1. item 1
2. item 2
3. item 3

Would not work but...

This list contains 3 items...

1. item 1
2. item 2
3. item 3

does render.

I've not seen this issue with solution block lists though. Curious, what happens if you force break the lines with extra spaces at the end?

Will try- thank you!

[tobyhodges]

I agree with @sstevens2's assessment.

In the medium term, I believe it could be better to move this set of tips earlier in the curriculum, as an introduction to the Collaboration Skills episodes, and follow it with some specific demonstrations and deeper dives as needed for each item. (This is what I meant in #233 (comment) though my explanation was not very clear.) But for now, I think it is good in the wrap-up.

[anenadic]

Will review shortly. I've had issues with numbered/bulleted lists in that they require a blank line before they start so something like

This list contains 3 things...
1. item 1
2. item 2
3. item 3

Would not work but...

This list contains 3 items...

1. item 1
2. item 2
3. item 3

does render.
I've not seen this issue with solution block lists though. Curious, what happens if you force break the lines with extra spaces at the end?

Will try- thank you!

Even with @tobyhodges's fix for the list - it still did not render nicely for me within the solution block. Since we moved the list out of the solution block, this is now a non-issue for us but I'll mention it on the lesson template repo.

[anenadic]

Hopefully have addressed all the requested changes via 35e6912. Re-requesting review @sstevens2 @tobyhodges .

[anenadic]

I cannot merge this PR for some reason - it appears some requested changes by @sstevens2 have not been addressed but when I try to see what they are and to address them - they appear as already resolved. Have you seen this @tobyhodges ? Think Sarah may need to approve/re-approve this.

[tobyhodges]

That's right: because she requested changes, @sstevens2 must re-review before this can be merged

[sstevens2]

Looks good to me! Thanks Aleks!