Skip to content

Conversation

@scott-lydon
Copy link

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:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@welcome
Copy link

welcome bot commented Jan 3, 2022

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.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 3, 2022

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 that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You 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.

Source Staging Production What Changed
content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md Modified Original

@github-actions github-actions bot temporarily deployed to docs-13686--patch-2 January 3, 2022 22:14 Inactive
@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review labels Jan 4, 2022
@ramyaparimi
Copy link
Contributor

@scott-lydon
Thanks so much for opening a PR! I'll get this triaged for review ⚡

@Samuelgha

This comment has been minimized.

Copy link
Contributor

@ethanpalm ethanpalm left a 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)."

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## 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.

Comment on lines +25 to +29
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Comment on lines +65 to +69
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Comment on lines +105 to +109
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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 %}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Adding an SSH key to your account on {% data variables.product.product_name %}

This adds a new header to show where the procedure starts.

@ramyaparimi ramyaparimi removed the waiting for review Issue/PR is waiting for a writer's review label Mar 8, 2022
@github-actions
Copy link
Contributor

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.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Mar 15, 2022
@github-actions github-actions bot closed this Mar 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content This issue or pull request belongs to the Docs Content team stale There is no recent activity on this issue or pull request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve the first step.

4 participants