Modifies examples to include a single heading and changes md symbol used for listing items

[dpshelio]

As per @tobyhodges comment on #1003 (review)

But it also includes title to make the files consistent with their filenames. (diffs were also updated accordingly)

Update (brought from #1012)
This is something that I always forget and only remember when I'm teaching it and encountered as recently @krishnakumarg1984 reminded me.

Markdown accepts either - or * however, in this material, the -
causes confusion when looking at diffs as you'd get things like:

 - avocado
-- lemon
+- lime

making the - from the diff misunderstood with the - of the list.

[dpshelio]

Since the heading sections is something that's got already "semi-approved" I'm also pushing here the content from #1012 as it will produce conflicts otherwise.

[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/swcarpentry/git-novice/compare/md-outputs..md-outputs-PR-1013

The following changes were observed in the rendered markdown documents:

 02-setup.md                          |  12 +-
 03-create.md                         |  88 +++++----
 04-changes.md                        | 246 ++++++++++++++-----------
 05-history.md                        | 342 +++++++++++++++++++++--------------
 06-ignore.md                         | 100 +++++-----
 07-github.md                         |  86 +++++----
 08-collab.md                         |  45 +++--
 09-conflict.md                       | 250 +++++++++++++++----------
 12-citation.md                       |  28 ++-
 13-hosting.md                        |   3 +-
 14-supplemental-rstudio.md           |   8 +-
 discuss.md                           | 130 ++++++-------
 fig/git-freshly-made-github-repo.svg |   4 +-
 fig/git_staging.svg                  |   2 +-
 fig/github-add-collaborators.png     | Bin 100892 -> 232665 bytes
 fig/github-collaboration.svg         |  10 +-
 fig/github-repo-after-first-push.svg |   6 +-
 index.md                             |   8 +-
 instructor-notes.md                  |   8 +-
 md5sum.txt                           |  28 +--
 20 files changed, 793 insertions(+), 611 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 2024-08-14 16:32:51 +0000