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

Jump to bottom

Confusing headings in "Configuring the private fork policy for a repository" #15265

Open
1 task done
oraclown opened this issue Feb 8, 2022 · 8 comments
Open
1 task done

Confusing headings in "Configuring the private fork policy for a repository" #15265

oraclown opened this issue Feb 8, 2022 · 8 comments
Labels
content good first issue help wanted
Projects
Docs open source board

Comments

@oraclown
Copy link

@oraclown oraclown commented Feb 8, 2022 •
edited by felicitymay

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks

What part(s) of the article would you like to see updated?

The picture under Step 4 "Under Fork pull request workflows, select your options. For example:" contains an option to make repository secrets available to fork PR workflows, when this is no longer an option. Confusing.

Additional information

Here is another doc that makes clear this is no longer an option.

I stumbled on this confusing mismatch because tests are failing since the secrets aren't available for a contributor's PR.

Update from a maintainer

After discussion (see comments below), we realized that the article is correct but that the headings are confusing.

Recommended updates to the article

  1. Change heading "Configuring required approval for workflows from public forks" to "Controlling changes from forks to workflows in public repositories".
  2. Change heading "Enabling workflows for private repository forks" to "Enabling workflows for forks of private repositories"
  3. Change heading "Configuring the private fork policy for a repository" to "Configuring the fork policy for a private repository"
@oraclown oraclown added the content label Feb 8, 2022
@welcome
Copy link

@welcome welcome bot commented Feb 8, 2022

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage label Feb 8, 2022
@github-actions github-actions bot added this to Triage in Docs open source board Feb 8, 2022
@ramyaparimi ramyaparimi added waiting for review and removed triage labels Feb 9, 2022
@ramyaparimi
Copy link
Collaborator

@ramyaparimi ramyaparimi commented Feb 9, 2022

Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

@felicitymay
Copy link
Contributor

@felicitymay felicitymay commented Mar 7, 2022

@oraclown - many thanks for reporting this bug in the docs. It sounds as if we overlooked this article the last time the UI was revised. I'm going to check our internal issues to see whether any other articles are affected before recommending steps to fix this problem.

@felicitymay
Copy link
Contributor

@felicitymay felicitymay commented Mar 9, 2022

@oraclown - I asked about this and discovered that the procedure you mention is only available for private repositories and not public repositories. The repository you link to is a public repository, so I think this is why you don't see these options.

The section of that article that describes the options for public repositories is: Configuring required approval for workflows from public forks.

I think that the headings in this article are confusing because it's not clear that we're talking about the visibility of the parent repository and not the fork.

I suggest we update the article as follows:

  1. Change heading "Configuring required approval for workflows from public forks" to "Controlling changes from forks to workflows in public repositories".
  2. Change heading "Enabling workflows for private repository forks" to "Enabling workflows for forks of private repositories"
  3. Change heading "Configuring the private fork policy for a repository" to "Configuring the fork policy for a private repository"

@oraclown
Copy link
Author

@oraclown oraclown commented Mar 9, 2022

Thanks for the info, and I think those edits would help!

@felicitymay
Copy link
Contributor

@felicitymay felicitymay commented Mar 9, 2022

Great - I'll update the issue summary accordingly and add a help wanted label.

@felicitymay felicitymay changed the title Update outdated picture for "Configuring the private fork policy for a repository" Confusing headings in "Configuring the private fork policy for a repository" Mar 9, 2022
@felicitymay felicitymay added good first issue help wanted and removed waiting for review labels Mar 9, 2022
@felicitymay
Copy link
Contributor

@felicitymay felicitymay commented Mar 9, 2022

@oraclown - thank you for raising this issue to highlight the confusing headings in this article ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
content good first issue help wanted
Projects
Docs open source board
Triage
Milestone
No milestone
Development

No branches or pull requests
4 participants
@felicitymay @ramyaparimi @oraclown and others