17-ssh-instructions

[lyashevska]

This PR improves ssh and other setup instructions.
Some of the instructions are clarified and made self-contained.
Fixes #17 #18 #30

[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/esciencecenter-digital-skills/git-lesson/compare/md-outputs..md-outputs-PR-31

The following changes were observed in the rendered markdown documents:

 md5sum.txt |   2 +-
 setup.md   | 163 ++++++++++++++++++++++++++++++++++++++++++++++++++-----------
 2 files changed, 136 insertions(+), 29 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-10-21 14:29:12 +0000

[sjvrijn]

Should we include a note here about passphrases? We could flat-out recommend not using one unless requiring the extra security.

Otherwise I think we should at least indicate that if they decide to use a non-empty passphrase, they'll have to enter it every time they use the SSH key?

[ClaireDons]

I added some simple instruction for git in MacOS. If we are not already, perhaps we could point to github's guide on installing git for additional information? https://github.com/git-guides/install-git

[ClaireDons]

Most versions of MacOS will have git preinstalled, you can check by running git version in the terminal. If it is not available, you can install git through homebrew by running:
brew install git