docs icon indicating copy to clipboard operation
docs copied to clipboard

Remove 'your key must use RSA' for generating new GPG key

Open Zhong-z opened this issue 3 years ago • 8 comments
trafficstars

Why:

In the reusables.gpg.supported-gpg-key-algorithms section, it shows Github support more than RSA. However when generating a new key, we 'must' use RSA, which seems contradicts each other.

The purposed change assumes reusables.gpg.supported-gpg-key-algorithms is the source of truth.

Closes #20379

What's being changed (if available, include any code snippets, screenshots, or gifs):

Removed Your key must use RSA sentence.

Check off the following:

  • [x] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [x] 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")

Zhong-z avatar Sep 03 '22 02:09 Zhong-z

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.

welcome[bot] avatar Sep 03 '22 02:09 welcome[bot]

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 Preview Production What Changed
authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE

github-actions[bot] avatar Sep 03 '22 02:09 github-actions[bot]

@Zhong-z Thanks for opening a PR and linking it to your issue! ✨

I'll get this triaged for review ⚡

cmwilson21 avatar Sep 06 '22 12:09 cmwilson21

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert :eyes:

github-actions[bot] avatar Sep 13 '22 06:09 github-actions[bot]

في الخميس، ٢٧ أكتوبر ٢٠٢٢, ٠٤:٥٣ chupapimunyanyl @.***> كتب:

AnT1nG82#1 https://github.com/AnT1nG82/docs/issues/1

— Reply to this email directly, view it on GitHub https://github.com/github/docs/pull/20380#issuecomment-1292860052, or unsubscribe https://github.com/notifications/unsubscribe-auth/A3YVF67DUM7EJIE5TI6F5H3WFHODJANCNFSM6AAAAAAQDWQVEM . You are receiving this because you are subscribed to this thread.Message ID: @.***>

Ameralkashaan avatar Oct 27 '22 01:10 Ameralkashaan

Why:

In the reusables.gpg.supported-gpg-key-algorithms section, it shows Github support more than RSA. However when generating a new key, we 'must' use RSA, which seems contradicts each other.

The purposed change assumes reusables.gpg.supported-gpg-key-algorithms is the source of truth.

Closes #20379

What's being changed (if available, include any code snippets, screenshots, or gifs):

Removed Your key must use RSA sentence.

Check off the following:

  • [x] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [x] 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")

artur-666 avatar Nov 05 '22 17:11 artur-666

Remove 'your key must use RSA' for generating new GPG key #20380

japui-coder avatar Nov 05 '22 20:11 japui-coder

This pull request impacts the contribution experience

japui-coder avatar Nov 05 '22 20:11 japui-coder

This is a gentle bump for the docs team that this PR is waiting for technical review.

github-actions[bot] avatar Dec 10 '22 16:12 github-actions[bot]

This is a gentle bump for the docs team that this PR is waiting for technical review.

github-actions[bot] avatar Jan 10 '23 16:01 github-actions[bot]

This is a gentle bump for the docs team that this PR is waiting for technical review.

github-actions[bot] avatar Feb 08 '23 16:02 github-actions[bot]

Hi @Zhong-z, you are right that this appears to be a contradiction in the article. I suspect the fix may need to be slightly more complex in the context of the procedure; we also say that Your key must be at least 4096 bits., but, at least with the GPG software I was using, only the RSA algorithm could generate a key of this length. We'll need to clarify our requirements and recommendations here, so I'll reach out to someone internally and get back to you when I hear back.

isaacmbrown avatar Mar 01 '23 13:03 isaacmbrown

Needs help with me

akingatwork avatar Mar 09 '23 05:03 akingatwork

This is a gentle bump for the docs team that this PR is waiting for technical review.

github-actions[bot] avatar Apr 06 '23 16:04 github-actions[bot]

Hi @Zhong-z, thanks for your patience while I looked into this internally! 🙇

I can confirm that the algorithms listed at the top of the article are supported, so you are correct to be removing Your key must use RSA.

If you're still up for it, could you also update this PR to remove Your key must be at least 4096 bits.? It looks like this restriction on key length doesn't exist either. I'll approve once that's done so we can get this merged 🚀

isaacmbrown avatar Apr 24 '23 15:04 isaacmbrown

@isaacmbrown Thanks for getting back me 😃. Deleted the key length sentence, please have another look. 👨🏼‍💻

Zhong-z avatar Apr 25 '23 11:04 Zhong-z

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 :zap:

github-actions[bot] avatar Apr 25 '23 13:04 github-actions[bot]