Skip to content

doc: additional note in README(.md) informing users that it is advise… - #32655

Closed
haqer1 wants to merge 4 commits into
nodejs:masterfrom
haqer1:signing-key-fixup-alternative-approach-2-part-2-alternative
Closed

doc: additional note in README(.md) informing users that it is advise…#32655
haqer1 wants to merge 4 commits into
nodejs:masterfrom
haqer1:signing-key-fixup-alternative-approach-2-part-2-alternative

Conversation

@haqer1

@haqer1haqer1 commented Apr 4, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

…d to import the full set of trusted release keys (rather than an individual key)

Additional README.md update

Fixes: #32559

Checklist
Note

This is part 2 (alternative) to simplify closure of part 1 in PR #32591 (this PR is mutually exclusive with PR #32654 (which the OP personally prefers to this PR))

@haqer1
doc: additional note in README(.md) informing users that it is advise…
9bd6618
…d to import the full set of trusted release keys (rather than an individual key)
Additional README.md update
Fixes: nodejs#32559
@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 4, 2020
This was referenced Apr 4, 2020
Closed
Closed
Trott
Trott reviewed Apr 8, 2020
View reviewed changes
Comment threadREADME.md Outdated
@haqer1@Trott
doc: apply suggestion from code review
2e103ed
This leaves a bit more between the lines, but makes the verbiage shorter.
Co-Authored-By: Rich Trott <rtrott@gmail.com>
@haqer1

haqer1 commented Apr 9, 2020

Copy link
Copy Markdown
ContributorAuthor

IMHO, perhaps a little too much emphasis on keeping the number of words to a minimum (could make one feel as if one was working on translating a holy book (if that's an appropriate thing to say)). But anyway, if the suggested shortened verbiage just committed is not explicit enough, somebody will make it known (before or after landing)...

MylesBorins
MylesBorins reviewed Apr 14, 2020
View reviewed changes
Comment threadREADME.md Outdated
Comment on lines +568 to +569
To avoid nuances involved in verification of a sub-key possibly used to sign a
release, import the full set of trusted release keys:

@MylesBorinsMylesBorinsApr 14, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

To import the full set of trusted release keys (including subkeys used to sign releases):

I think the current test has a bit too much editorialization. I think suggested text above accomplishes the intention while keeping things succinct.

LMK if you have alternative suggestions

@haqer1haqer1Apr 15, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

To import the full set of trusted release keys (including subkeys used to sign releases):

IMHO, there is a need to mention something like "nuance"s or "pitfall"s, to make sure that users get an idea that if they choose to not import all the keys following (assuming #32654 is not going to land), they might (well) run into something they aren't expecting. My motivation was to prevent confusion & misuse of time (which happened to me).
So between this suggestion & the current version, i'd prefer the current version (because it's more informative, etc.).

P.S. It seems there is an agreement on a need for change, & hopefully there will be an agreement on the wording w/o spending too much time on it. For me, the current wording committed is better that the status quo.

@BridgeARBridgeARMay 25, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ping @Trott@MylesBorins

@MylesBorinsMylesBorinsMay 27, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I stand by my original review. I think the current text is too editorialized and prefer the proposed text I suggested. I'm open to reviewing alternative suggestions

@BridgeAR
BridgeARforce-pushed the master branch 2 times, most recently from 8ae28ff to 2935f72CompareMay 31, 2020 12:18
@jasnelljasnell added the stalled Issues and PRs that are stalled. label Jul 3, 2020
@aduh95aduh95 added stalled Issues and PRs that are stalled. and removed stalled Issues and PRs that are stalled. labels Oct 19, 2020
@github-actions

github-actionsBot commented Oct 19, 2020

Copy link
Copy Markdown
Contributor

This issue/PR was marked as stalled, it will be automatically closed in 30 days. If it should remain open, please leave a comment explaining why it should remain open.

@haqer1

haqer1 commented Oct 26, 2020

Copy link
Copy Markdown
ContributorAuthor

OK, not descriptive enough IMHO, but since there is that much effort to keep it very very short, would this be accepted?
To import the full set of trusted release keys (including subkeys possibly used to sign releases):

P.S. At least "possibly" makes it clear that subkeys aren't always used, but they might be...

@MylesBorins

MylesBorins commented Oct 26, 2020

Copy link
Copy Markdown
Contributor

That seems much better to me. If you update the PR I would sign off on that copy

@haqer1
doc: additional note in README(.md) informing users that it is advise…
945cce5
…d to import the full set of trusted release keys (rather than an individual key) (reconciled with another suggestion from code review)
The OP finds his original suggestion more descriptive & more user-friendly, but prefers to move on since that suggestion is stalled in favor of much shorter verbiage
Co-Authored-By: Myles Borins <mylesborins@google.com>
Fixes: nodejs#32559
@haqer1
doc: additional note in README(.md) informing users that it is advise…
69d81a9
…d to import the full set of trusted release keys (rather than an individual key) (reconciled with another suggestion from code review)
The OP finds his original suggestion more descriptive & more user-friendly, but prefers to move on since that suggestion is stalled in favor of much shorter verbiage. This version also splits the line at 80 characters to comply with lint-md.
Co-Authored-By: Myles Borins <mylesborins@google.com>
Fixes: nodejs#32559
MylesBorins
MylesBorins approved these changes Oct 28, 2020
View reviewed changes

@MylesBorinsMylesBorins left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@aduh95aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed stalled Issues and PRs that are stalled. labels Nov 8, 2020
aduh95 pushed a commit that referenced this pull request Nov 9, 2020
@haqer1@aduh95
doc: advise users to import the full set of trusted release keys
888900b
PR-URL: #32655Fixes: #32559
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@aduh95

aduh95 commented Nov 9, 2020

Copy link
Copy Markdown
Contributor

Landed in 888900b

@aduh95aduh95 closed this Nov 9, 2020
danielleadams pushed a commit that referenced this pull request Nov 9, 2020
@haqer1@danielleadams
doc: advise users to import the full set of trusted release keys
99cb362
PR-URL: #32655Fixes: #32559
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@danielleadamsdanielleadams mentioned this pull request Nov 9, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Dec 9, 2020
@haqer1@BethGriggs
doc: advise users to import the full set of trusted release keys
9958392
PR-URL: #32655Fixes: #32559
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
BethGriggs pushed a commit that referenced this pull request Dec 10, 2020
@haqer1@BethGriggs
doc: advise users to import the full set of trusted release keys
66bd12e
PR-URL: #32655Fixes: #32559
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@BethGriggsBethGriggs mentioned this pull request Dec 10, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Dec 15, 2020
@haqer1@BethGriggs
doc: advise users to import the full set of trusted release keys
cddcfcd
PR-URL: #32655Fixes: #32559
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@BridgeARBridgeARBridgeAR left review comments
@jasnelljasnelljasnell approved these changes
@TrottTrottTrott approved these changes
+1 more reviewer
@MylesBorinsMylesBorinsMylesBorins approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

7 participants

@haqer1@MylesBorins@aduh95@jasnell@Trott@BridgeAR@nodejs-github-bot