-
Notifications
You must be signed in to change notification settings - Fork 65.4k
Add the preface step as step 1 instead. #13686
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
|
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. |
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
|
|
@scott-lydon |
This comment has been minimized.
This comment has been minimized.
ethanpalm
left a comment
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.
Hi @scott-lydon, thanks for creating a PR and clearly explaining your process. ⚡
For procedural articles like this one, we put all the prerequisites and conceptual information before the actual procedure, not inside the procedural steps. The goal here is to make sure people have the right context for a procedure or that they've had the chance to see other articles that relate to the procedure that they're about to do. You can see more about how we document prerequisites in the GitHub docs style guide and content model.
So, for this PR, I think we can highlight that these steps are prerequisites by adding a "Prerequisites" header and a header for the procedure itself.
After incorporating these changes, this PR should be ready to merge. Please let me know if you have any questions and thanks for taking the time to contribute to the GitHub docs! 🚀
| * [Generating a new SSH key and adding it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) | ||
|
|
||
| After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." | ||
|
|
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.
| ## Prerequisites | |
| Before adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you should have: | |
| * [Checked for existing SSH keys](/articles/checking-for-existing-ssh-keys) | |
| * [Generated a new SSH key and added it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) | |
| After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." |
This adds a header to more clearly label the prerequisites.
| 1. [Check if you already have the SSH key you want to use](/articles/checking-for-existing-ssh-keys) and [generate a new SSH key and add it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) if you don't. | ||
|
|
||
| After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." | ||
|
|
||
| 2. Copy the SSH public key to your clipboard. |
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.
| 1. [Check if you already have the SSH key you want to use](/articles/checking-for-existing-ssh-keys) and [generate a new SSH key and add it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) if you don't. | |
| After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." | |
| 2. Copy the SSH public key to your clipboard. | |
| 1. Copy the SSH public key to your clipboard. |
| 1. [Check if you already have the SSH key you want to use](/articles/checking-for-existing-ssh-keys) and [generate a new SSH key and add it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) if you don't. | ||
|
|
||
| After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." | ||
|
|
||
| 2. Copy the SSH public key to your clipboard. |
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.
| 1. [Check if you already have the SSH key you want to use](/articles/checking-for-existing-ssh-keys) and [generate a new SSH key and add it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) if you don't. | |
| After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." | |
| 2. Copy the SSH public key to your clipboard. | |
| 1. Copy the SSH public key to your clipboard. |
| 1. [Check if you already have the SSH key you want to use](/articles/checking-for-existing-ssh-keys) and [generate a new SSH key and add it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) if you don't. | ||
|
|
||
| After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." | ||
|
|
||
| 2. Copy the SSH public key to your clipboard. |
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.
| 1. [Check if you already have the SSH key you want to use](/articles/checking-for-existing-ssh-keys) and [generate a new SSH key and add it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) if you don't. | |
| After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." | |
| 2. Copy the SSH public key to your clipboard. | |
| 1. Copy the SSH public key to your clipboard. |
| After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." | ||
|
|
||
| {% data reusables.ssh.key-type-support %} | ||
|
|
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.
| ## Adding an SSH key to your account on {% data variables.product.product_name %} |
This adds a new header to show where the procedure starts.
|
A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days. |
Why:
Closes 13683
When I encounter this tutorial, my first reaction is "darn" they have a bunch of stuff for me to read before jumping into the steps that I can act on. I run a calculation, "are these paragraphs going to distract me and waste my time?" Or should I just jump into the steps. I usually try to just jump in, to keep the momentum going. So I look at step 1, and instead of it being the first step, it suggests copying the SSH but doesn't tell you where to get it. So its not really a first step at all. Being that a requisite step needs to come before it. So this is really a second step. This made me wonder, is the "how to add an SSH key hiding on another page?" This is when my frustration started to peak. And this is the introduction to the docs and the kind of thing that makes me groan in fear and pain every time I have to refresh my SSH keys with GitHub.
What's being changed:
It shifts the "preface" to being the first step which would really clear up the confusion I get every time I encounter the docs.
Check off the following:
Writer impact (This section is for GitHub staff members only):