docs icon indicating copy to clipboard operation
docs copied to clipboard

Docs unclear about custom-named SSH Keys

Open Allyson04 opened this issue 3 years ago • 3 comments

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

What part(s) of the article would you like to see updated?

The documentation explains how to create SSH Keys and adding to Github, problem is it didn't explain a case where the user already has a default-named key (such as "id_rsa" for RSA keys or "id_ed25519" for ed25519 keys). If the user tries to create a new SSH Key, ssh-keygen may ask to rewrite a previously created key, which is quite problematic, as rewriting another key will effectively delete it without possibility of undoing it. That way, the option of telling the user how to create custom-named SSH key and advising that trying to create a key by the default name can be a problem.

Additional information

No response

Allyson04 avatar Jul 20 '22 12:07 Allyson04

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Jul 20 '22 12:07 welcome[bot]

@Allyson04 Thanks for opening an issue and PR!

cmwilson21 avatar Jul 20 '22 13:07 cmwilson21

A stale label has been added to this issue becuase it has been open for 60 days with no activity. To keep this issue open, add a comment within 3 days.

github-actions[bot] avatar Sep 18 '22 16:09 github-actions[bot]