-
Notifications
You must be signed in to change notification settings - Fork 63k
Make it more understandable #5385
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
The original text could be quite confusing: ``` Open your ~/.ssh/config file, then modify the file, replacing ~/.ssh/id_ed25519 if you are not using the default location and name for your id_ed25519 key. Host * AddKeysToAgent yes UseKeychain yes IdentityFile ~/.ssh/id_ed25519 ``` 1. It said "Open your ~/.ssh/config file, then modify the file, replacing ~/.ssh/id_ed25519" -- I was thinking, open that file, and then modify it, BUT HOW? AND THEN, replacing the file content of ~/.ssh/id_ed25519 ? By what content? 2. And then it said, "if you are not using the default location and name for your id_ed25519 key"... location and name? What location of name? It turned out it meant the "path" and the "filename"... and "if you are using"? It actually meant "if you used" in the previous steps.
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
@KennethKinLum Thanks so much for opening a PR! I'll get this triaged for review ⚡ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👋🏼 @KennethKinLum, thanks for this PR! I agree that this language is quite confusing and I appreciate you taking the time to improve it. I made one small change just to keep the language consistent with some other GitHub docs. I'll merge this PR as soon as all the checks are passing. The changes will be live within 24 hours.
You have a great analysis of the problem and identified a nice solution. Please check out the help wanted issues if you are interested in contributing again!
Thanks for helping make our docs better! ✨ 🚀
@@ -91,7 +91,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav | |||
$ touch ~/.ssh/config | |||
``` | |||
|
|||
* Open your `~/.ssh/config` file, then modify the file, replacing ` ~/.ssh/id_ed25519` if you are not using the default location and name for your `id_ed25519` key. | |||
* Open your `~/.ssh/config` file, then modify the file to contain the following lines. Replace the path and filename ` ~/.ssh/id_ed25519` below if you did not use the default path and filename for your `id_ed25519` key. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Open your `~/.ssh/config` file, then modify the file to contain the following lines. Replace the path and filename ` ~/.ssh/id_ed25519` below if you did not use the default path and filename for your `id_ed25519` key. | |
* Open your `~/.ssh/config` file, then modify the file to contain the following lines. If your SSH key file has a different name or path than the example code, modify the filename or path to match your current setup. |
This change makes the step similar to the procedure in "Adding a new SSH key to your GitHub account." Since not everyone will have to do this step, I think starting the sentence with "If your SSH key file has a different name or path" can help people know a bit more quickly if they need to do the step or not.
…ey-and-adding-it-to-the-ssh-agent.md
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
The original text could be quite confusing:
~/.ssh/id_ed25519
on the last line, use the proper one if you did not use the default one.Why:
Closes [issue link]
What's being changed:
Check off the following: