Repository navigation
Review on SSH chapter #61
Copy link
Copy link
Closed
Description
Hello @NeuroShepherd ! Here my thoughts/suggestions:
(working my way top to bottom)
- When working with a GitHub repository, you’ll often need to identify yourself to GitHub using your username and password. There are several ways to secure this connection further. Establishing a secure connection is mandatory since August 2021. --> change to "When working with a GitHub repository, you’ll often need to identify yourself to GitHub using your username and password. However, since August 2021, higher security standards for this connection have become mandatory. Therefore, we will use SSH ...
- The procedure below only needs to be executed
- Under generating an SSH key pair: In the command line .. add "In the command line of your terminal, type the following ....
- Under generating an SSH key pair: -C flag and -f is this critical information for non-developers?
- Under generating an SSH key pair: This is the prompt that will appear: -> Here I would also rearrange and say something like, next, you will see this prompt (image of prompt), then mention to press enter and that the default file loc is accepted.
- Under generating an SSH key pair: Passphrase: reminded me I need to remove it from my own keys
- Under creating the SSH config file: This file simply tells the SSH software --> This file tells the SSH software
- Under creating the SSH config file: this is new ..? Have not done this in almost two years, but looks unfamiliar!
- Under creating the SSH config file: Formatted the text in the config file should look like this -> perhaps mention that it can be found in the .ssh folder? And when you then say you can simply paste the above lines into the config file, I would be confused as a reader if both the Host github.com and/or also what follows # Add the following lines - perhaps put the "Formatted, the text .." bit after you mention to paste it into the config file?
- Under Adding a new SSH key to your GitHub account: Be careful etc: at this point, I think I would not know where I could copy my private key? Did I paste it to clipboard somewhere before? What am I missing? Putting below the cat command prompt
- Under adding your key to the ssh-agent: It is correct to say that only GNU/Linux do notwarrant this step? Did you want to specify that if you are using Windows/Mac (probably most users?) would need to follow this step? It is a little unclear at this point for whom this step is
- Under adding your key to the ssh-agent: Small thing about Capitals in the section title: you sometimes use them, sometimes not, just for consistency
- Under Testing Your Connection to GitHub: Great! I also remember the original instructions here being longer?
- Under Testing Your Connection to GitHub: Going forward, you can use the SSH clone URL etc: perhaps a step too far? I imagine a novice just having been successful in setting this up, a clone URL might be too much at this point? Clarify or mention what will be covered in the second tutorial without using this technical term
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels
Activity
MalikaIhle commentedon Aug 31, 2026
Hi both, I was reviewing my content for the summer school and noticed the SSH page significantly changed and then found this issue.
NeuroShepherd commentedon Aug 31, 2026
I made two substantive changes to the SSH chapter last week:
ssh-keygenis to overwrite the default file so if any of our summer school participants usessh-keygenin the future, they will inadvertently overwrite their GitHub SSH key (and likely not understand why they can no longer connect.) This will likely occur for many who attempt to connect to LRZ GitLab, for example.The rest of the tutorial I left alone.
MalikaIhle commentedon Aug 31, 2026
I removed the recommendation to add a password to the SSH key--> fine by me.I changed the SSH generation procedure to save the SSH key into a specific file rather than going into the default files.--> sure but maybe let's not make it optional in the main text (maybe only in the footnote) to not be overwhelming.MalikaIhle commentedon Sep 1, 2026
ok I reviewed all against our comment @SvonGrebmer - no need for you to review again - it's all addressed.