Skip to content
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

Update adding-a-new-ssh-key-to-your-github-account.md #1683

Merged
merged 3 commits into from
Dec 2, 2020

Conversation

ealmonte32
Copy link
Contributor

Specifying that the SSH key to copy is the public one.

Why:

Because when giving instructions about something that deals with cybersecurity and as important as SSH keys, we must not forget that being very detailed and specific goes a long way to prevent issues.
I believe when you are telling someone to copy their SSH key, you need to be very specific and mention "public" in that instruction, even if its obvious.

What's being changed:

Just adding the word public to the SSH and CPG keys instruction page.

Check off the following:

  • All of the tests are passing.
  • I have reviewed my changes in staging. (look for the deploy-to-heroku link in your pull request, then click View deployment)
  • For content changes, I have reviewed the localization checklist
  • For content changes, I have reviewed the Content style guide for GitHub Docs.

Specifying that the SSH key to copy is the public one.
@welcome
Copy link

welcome bot commented Nov 29, 2020

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.

@janiceilene
Copy link
Contributor

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

@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team core labels Dec 1, 2020
Copy link
Contributor

@hubwriter hubwriter left a comment

Choose a reason for hiding this comment

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

@ealmonte32 - Many thanks for this contribution to the docs.
Thanks also for the rationale for the change - it's an important point, I agree.
We really appreciate you taking the time to help improve GitHub documentation. Thanks again! 👏

@hubwriter hubwriter merged commit 1756da8 into github:main Dec 2, 2020
@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2020

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants