Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
- https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key
- https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account
What part(s) of the article would you like to see updated?
Maintainer edit: updates required
I had a look into this and followed the instructions using GPG Suite for Mac. I also noticed a slightly different output, but I suspect this depends on the GPG software you use, because my output was also different to yours. I don't think the risk of confusion to users is too great, so I would recommend we keep the output as it is.
As for step 11 in https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account, the UI has indeed changed. I think we should update as follows:
- Before step 4, add a new step saying:
In the "Title" field, type a name for your GPG key. - In step 4, remove the screenshot, as this is not a difficult field for the user to find.
- Also remove the screenshot in step 5.
- Change step 6 to
To confirm the action, authenticate to your {% data variables.product.prodname_dotcom %} account.
I'll add the help wanted label to this issue, and you or anyone else is welcome to create a PR to make the fix outlined above 🚀
Original post
Step 11 lists an example output of the gpg --list-secret-keys --keyid-format=long shell command.
This output, however, seems to no longer be completely accurate, at least when using Gpg4win as the GPG software.
The command now outputs the following (I'm using wrong characters to avoid any accidental matches):
$ gpg --list-secret-keys --keyid-format=long
/c/Users/Someone/.gnupg/pubring.gpg
-----------------------------------
sec rsa4096/=ABCD1234ABCD123 2023-02-22 [SC]
=ABCD1234ABCD1234ABCD1234ABCD1234ABCD123
uid [ultimate] Someone (A GPG Key) <someone@example.com>
ssb rsa4096/4321DCBA4321DCBA 2023-02-22 [E]The above also applies to the example in https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key
Step 4 displays an outdated image. The current modal is having a "Title" summary field which the screenshot is not displaying.
Additionally does step 6 only mention to "enter your GitHub password" while Users with GitHub Mobile may use the app to authorize the action.
Additional information
No response