Skip to content

Clarify access level needed for secrets in web interface - #2330

Merged
hubwriter merged 4 commits into
github:mainfrom
muru:patch-1
Mar 4, 2021
Merged

Clarify access level needed for secrets in web interface#2330
hubwriter merged 4 commits into
github:mainfrom
muru:patch-1

Conversation

@muru

@murumuru commented Dec 25, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

Why:

Closes#1087

What's being changed:

I changed the initial text of "Creating encrypted secrets for a repository" and also added a note at the end of that section:

  • Including a mention of "web interface" lead to (IMO) too much duplication in text, so I rephrased it to be more like the permissions-statement-secrets-api reusable.

  • I considered changing the permissions-statement-secrets-repository reusable to include a reference to the API, but then I noticed that the other place using it ("Enabling debug logging") already mentioned the API, so instead I added a note.

  • Screenshot of "Creating encrypted secrets for a repository", with the unchanged parts snipped:

    screenshot showing the initial paragraph and final note with the unchanged middle omitted

  • Screenshot of "Enabling debug logging":

    screenshot showing entire list of permission requirements with change highlighted

Check off the following:

  • I have reviewed my changes in staging. (look for the deploy-to-heroku link in your pull request, then click View deployment)
  • For content changes, I have reviewed the localization checklist
  • For content changes, I have reviewed the Content style guide for GitHub Docs.
    • The style guide says "do not include [...] permissions," however I feel that this note might be acceptable as "useful information or reminders for the user" since it describes a relaxation in permissions compared to the preceding text.

@muru
Clarify access level needed for secrets in web interface
980ebc9
Closesgithub#1087
I considered changing the `permissions-statement-secrets-repository`
reusable to include a reference to the API, but then I noticed that the
other place using it (["Enabling debug logging"][1]) already mentioned
the API, so instead I added a note. Including a mention of "web
interface" lead to (IMO) too much duplication in text, so I rephrased it
to be more like the `permissions-statement-secrets-api` reusable.
[1]: https://docs.github.com/en/free-pro-team@latest/actions/managing-workflow-runs/enabling-debug-logging
@welcome

welcomeBot commented Dec 25, 2020

Copy link
Copy Markdown

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.

loy8888
loy8888 previously approved these changes Dec 28, 2020
View reviewed changes
@janiceilene

janiceilene commented Dec 28, 2020

Copy link
Copy Markdown
Contributor

Thanks so much for opening a PR @muru! I'll get this triaged for the team to take a look when they're back from the holidays 💖

@janiceilenejaniceilene added content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team labels Dec 28, 2020
@github-actions

github-actionsBot commented Jan 4, 2021

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actionsgithub-actionsBot added the stale There is no recent activity on this issue or pull request label Jan 4, 2021
@janiceilenejaniceilene removed the stale There is no recent activity on this issue or pull request label Jan 5, 2021
@janiceilene

janiceilene commented Jan 5, 2021

Copy link
Copy Markdown
Contributor

Thanks for your patience! Our small team is working our way through reviewing all of the amazing contributions ✨

@github-actions

github-actionsBot commented Jan 16, 2021

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actionsgithub-actionsBot added the stale There is no recent activity on this issue or pull request label Jan 16, 2021
@shati-patelshati-patel removed the stale There is no recent activity on this issue or pull request label Jan 19, 2021
@github-actions

github-actionsBot commented Jan 26, 2021

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actionsgithub-actionsBot added the stale There is no recent activity on this issue or pull request label Jan 26, 2021
@janiceilenejaniceilene removed the stale There is no recent activity on this issue or pull request label Jan 26, 2021
@janiceilenejaniceilene added the waiting for review Issue/PR is waiting for a writer's review label Feb 5, 2021
@muru

muru commented Feb 15, 2021•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Is the closure intentional? Should I amend the PR?

@janiceilene

janiceilene commented Feb 16, 2021

Copy link
Copy Markdown
Contributor

I'm so sorry about that @muru! No amendments needed. It looks like our new action inadvertently closed this 🙃 Reopening and triaging this for review 💛

@github-actionsgithub-actionsBot removed the waiting for review Issue/PR is waiting for a writer's review label Feb 17, 2021
@chiedochiedo added the waiting for review Issue/PR is waiting for a writer's review label Feb 17, 2021
@abitmoreabitmore mentioned this pull request Feb 18, 2021
Closed
hubwriter
hubwriter reviewed Mar 3, 2021
View reviewed changes

@hubwriterhubwriter 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.

@muru - Many thanks for raising this PR.

I like the note that you added, with the link to the secrets API page, that's useful, thanks.

I think we should stick with the current reusable text. IMO it makes a clearer distinction between what you need to create a secret for a user account repo and what you need to create a secret for an organization repo.

Comment threaddata/reusables/github-actions/permissions-statement-secrets-repository.md Outdated
@hubwriter
Update data/reusables/github-actions/permissions-statement-secrets-re…
e7445c6
…pository.md
I'm going to go ahead and change this back.
@hubwriter
hubwriter dismissed stale reviews from ghost and loy8888 via e7445c6March 3, 2021 17:15
hubwriter
hubwriter previously approved these changes Mar 3, 2021
View reviewed changes

@hubwriterhubwriter 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.

@muru - As this PR has been waiting for our attention for so long I'm going to go ahead and merge the modified version (without the change to the reusable text).

Many thanks again for taking the time to help improve our docs. It's much appreciated. 👍

Of course if you disagree with my comments please get back in touch.
All the best.

@hubwriter
hubwriter enabled auto-merge (squash) March 3, 2021 17:20
@muru

muru commented Mar 3, 2021

Copy link
Copy Markdown
ContributorAuthor

@hubwriter that's fine by me! Thanks for reviewing!

@hubwriter
hubwriter merged commit 5659485 into github:mainMar 4, 2021
@snyk-botsnyk-bot mentioned this pull request Jan 6, 2023
Open
This was referenced Feb 3, 2023
Open
Open
@kavirmusickavirmusic mentioned this pull request Sep 4, 2023
Open
@Z-byte-progZ-byte-prog mentioned this pull request Sep 10, 2023
Closed
@RhinosF1RhinosF1 mentioned this pull request Nov 5, 2023
Open
@Z-byte-progZ-byte-prog mentioned this pull request Nov 18, 2023
Closed
@sisamiulsisamiul mentioned this pull request Mar 28, 2024
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hubwriterhubwriterhubwriter approved these changes
+1 more reviewer
@loy8888loy8888loy8888 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@hubwriterhubwriter

Labels

contentThis issue or pull request belongs to the Docs Content teamecosystemThis issue or pull request should be reviewed by the Docs Ecosystem teamwaiting for reviewIssue/PR is waiting for a writer's review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Clarify permission level needed to access secrets

6 participants

@muru@janiceilene@hubwriter@loy8888@chiedo@shati-patel