Merge SSH keygen changes (Step 2) and troubleshooting to Main Branch#538
Merge SSH keygen changes (Step 2) and troubleshooting to Main Branch#538MSherren wants to merge 35 commits into
Conversation
2 new screenshots to demonstrate the new key for ssh documentation
Updating RMACC registry instructions to reflect the same instructions as the SSH authentication setup for AMC
b-reyes
left a comment
b-reyes
left a comment
There was a problem hiding this comment.
@MSherren Thank you so much for putting this together! I have some changes that I would like you to make so that the content follows some of the guidelines we have established in our documentation. Also, I suggested a small modification to your troubleshooting addition. If you have any questions on these changes, please let me know.
|
|
||
| SSH Key Generation for Windows Users: | ||
| - Using the command prompt, PowerShell, or Windows Terminal: <https://www.howtogeek.com/762863/how-to-generate-ssh-keys-in-windows-10-and-windows-11/> | ||
| ### SSH Key Generation for Windows Users: |
There was a problem hiding this comment.
Instead of using headings for the Windows/Mac/Linux portions, please use tabs.
For documentation on how to create tabs, please see the bullet/dropdown in CURC documentation guidelines.
An example of this type of tab usage can be seen in Terminal access for different operating systems
There was a problem hiding this comment.
Similarly, I do not think this was addressed.
Co-authored-by: Brandon <53541061+b-reyes@users.noreply.github.com>
|
I believe I have added all the right commits for both the registry cilogon instructions and the AMC ssh auth instructions. Please let me know if there are any other edits or feedback! |
Co-authored-by: Brandon <53541061+b-reyes@users.noreply.github.com>
b-reyes
left a comment
b-reyes
left a comment
There was a problem hiding this comment.
Hi @MSherren thank you for making those changes. In this round of review I identified a couple of issues. Please address these and apply all changes that were made in the AMC page to the general Uploading an SSH Key to CILogon Registry as well, if they are applicable.
| +---- [SHA256] -----+ | ||
| ``` | ||
|
|
||
| - NOTE for Mac users: There is a chance you need to create or alter your ssh config file `~/.ssh/config`. See more in the [Troubleshooting](#troubleshooting) section below. |
There was a problem hiding this comment.
Please put all notes in "note" admonitions. You can find guidance on how to do this in the Components portion of the following documentation: https://curc.readthedocs.io/en/latest/additional-resources/contrib_curc_docs.html#curc-documentation-guidelines
There was a problem hiding this comment.
I updated the format to follow "note" admonitions but it didn't seem to take. I will circle back on this
There was a problem hiding this comment.
From what I see the "note" admonition will apply in the readthedocs but not the github, so this should be alright. Please let me know if that is not the case
See line 102, attempt to add "Note" in official syntax form
Co-authored-by: Brandon <53541061+b-reyes@users.noreply.github.com>
Clarifying example output in a more readable format Co-authored-by: Brandon <53541061+b-reyes@users.noreply.github.com>
Co-authored-by: Brandon <53541061+b-reyes@users.noreply.github.com>
Changed all references of id_rsa to id_ed25519
Optional instructions added to rename the key should the user choose, so it doesn't result in the default
Co-authored-by: Brandon <53541061+b-reyes@users.noreply.github.com>
Separating password and passphrase troubleshooting to be more clear Co-authored-by: Brandon <53541061+b-reyes@users.noreply.github.com>
Updated registry CI logon instructions (Steps 1-3 and troubleshooting) to match the updates to the AMC ssh instructions
|
I believe all necessary changes have been made to both the amc_ssh_auth.md doc and the registrycilogon-instructions.md doc. I will note, the original registrycilogon-instructions.md document differs from the AMC ssh document as it doesn't have a Step 4 and the troubleshooting is shorter. I have kept these differences, so there is no Step 4 and the troubleshooting instructions are less for the registrycilogon-instructions.md document, though I did still update the troubleshooting sections that matched. |
Tab set for Windows vs Mac
2 participants
After discovering the instructions for ssh keygen (step 2) were slightly out of date, generating an rsa key, I have updated the documentation to generate a newer ssh key. Additionally, I have added a troubleshooting step for the issue certain Mac's have run into.