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

git / gpg integration link #7519

Merged
merged 3 commits into from
May 15, 2018
Merged

git / gpg integration link #7519

merged 3 commits into from
May 15, 2018

Conversation

mattam82
Copy link
Member

Kind: documentation

@mattam82 mattam82 requested a review from Zimmi48 as a code owner May 15, 2018 13:19
Actually there are more general instructions
@@ -111,7 +111,8 @@ The merge script passes option `-S` to `git merge` to ensure merge commits
are signed. Consequently, it depends on the GnuPG command utility being
installed and a GPG key being available. Here is a short tutorial to
creating your own GPG key:
<https://ekaia.org/blog/2009/05/10/creating-new-gpgkey/>
<https://ekaia.org/blog/2009/05/10/creating-new-gpgkey/>. To link it with
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we link some random blog instead of https://help.github.com/articles/generating-a-new-gpg-key/?

Copy link
Member

Choose a reason for hiding this comment

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

Because that's the doc recommended by Debian. But it feels like a good idea to change it to the link you gave. Especially since it includes "step 14: add the GPG key to your GitHub account".

Copy link
Member

@Zimmi48 Zimmi48 left a comment

Choose a reason for hiding this comment

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

So given @SkySkimmer's remark above and given that the link you added is the general summary page on GitHub and not the specific link https://help.github.com/articles/telling-git-about-your-gpg-key/ that you gave on Gitter, I would say that either the two links are redundant and we should only provide https://help.github.com/articles/signing-commits-with-gpg/, or we want to point to more specific things and in this case https://help.github.com/articles/generating-a-new-gpg-key/ + https://help.github.com/articles/telling-git-about-your-gpg-key/ seems like the right combination (and links to the other pages are at the bottom of these pages anyways).

@@ -111,7 +111,8 @@ The merge script passes option `-S` to `git merge` to ensure merge commits
are signed. Consequently, it depends on the GnuPG command utility being
installed and a GPG key being available. Here is a short tutorial to
creating your own GPG key:
<https://ekaia.org/blog/2009/05/10/creating-new-gpgkey/>
<https://ekaia.org/blog/2009/05/10/creating-new-gpgkey/>. To link it with
git & github, follow https://help.github.com/articles/signing-commits-with-gpg/.
Copy link
Member

Choose a reason for hiding this comment

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

The proper casing is GitHub.

@Zimmi48 Zimmi48 self-assigned this May 15, 2018
@Zimmi48 Zimmi48 added the kind: documentation Additions or improvement to documentation. label May 15, 2018
@Zimmi48 Zimmi48 added this to the 8.9+beta1 milestone May 15, 2018
@mattam82
Copy link
Member Author

I simplified, that should be good now

Copy link
Member

@Zimmi48 Zimmi48 left a comment

Choose a reason for hiding this comment

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

Thanks!

@Zimmi48 Zimmi48 merged commit 2ba954a into master May 15, 2018
Zimmi48 added a commit that referenced this pull request May 15, 2018
@Zimmi48 Zimmi48 deleted the mattam82-patch-1 branch May 15, 2018 21:24
@Zimmi48
Copy link
Member

Zimmi48 commented May 15, 2018

@mattam82 Be careful that by using GitHub edit feature, you actually created a new branch on the main repo instead of your fork.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: documentation Additions or improvement to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants