Skip to content

Update gh CLI steps in adding-a-new-ssh-key-to-your-github-account.md#11722

Merged
lecoursen merged 7 commits intogithub:mainfrom
michelleN:patch-3
Nov 12, 2021
Merged

Update gh CLI steps in adding-a-new-ssh-key-to-your-github-account.md#11722
lecoursen merged 7 commits intogithub:mainfrom
michelleN:patch-3

Conversation

@michelleN
Copy link
Copy Markdown
Contributor

Why:

The GitHub CLI does not allow you to add an ssh key unless you are authenticated with your GitHub account. The gh auth login command not only authenticates you but also gives prompts to add your ssh key to your account. This PR amends the GitHub CLI portion with the gh auth login path. This may be useful to someone coming to this page for the first time who has not already installed the gh CLI and will do so as part of this flow and will then need to authenticate.

Closes #11721

What's being changed:

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")

The GitHub CLI does not allow you to add an ssh key unless you are authenticated with your GitHub account. The `gh auth login` command not only authenticates you but also gives prompts to add your ssh key to your account. This PR amends the GitHub CLI portion with the `gh auth login` path. This may be useful to someone coming to this page for the first time who has not already installed the gh CLI and will do so as part of this flow and will then need to authenticate.
@welcome
Copy link
Copy Markdown

welcome Bot commented Nov 5, 2021

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.

@michelleN michelleN changed the title Update adding-a-new-ssh-key-to-your-github-account.md Update gh CLI steps in adding-a-new-ssh-key-to-your-github-account.md Nov 5, 2021
@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Nov 5, 2021
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 5, 2021

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

@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 and removed triage Do not begin working on this issue until triaged by the team labels Nov 8, 2021
@ramyaparimi
Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Member

@lecoursen lecoursen left a comment

Choose a reason for hiding this comment

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

Thanks @michelleN. Since the focus of this article is on adding an SSH key, let's mention the prerequisite of authenticating but link out for further details rather than including them here. I'll apply a suggestion to do that and then merge. 🎉

lecoursen
lecoursen previously approved these changes Nov 12, 2021
@lecoursen lecoursen merged commit 0caa91b into github:main Nov 12, 2021
@github-actions
Copy link
Copy Markdown
Contributor

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

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 waiting for review Issue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

update gh CLI steps in "Adding a new SSH key to your GitHub account"

3 participants