Improve GitHub Actions Fork Approval Documentation#40539
Improve GitHub Actions Fork Approval Documentation#40539SachinSingh008 wants to merge 3 commits intogithub:mainfrom
Conversation
|
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. |
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
|
@SachinSingh008 Thanks for opening a PR! I've been looking at this against the original, and while the changes you've made aren't sweeping, I'm not convinced the article is better. Why things happen as they do belongs in a reference article, not a how-to, so your change adds unnecessary information that's available elsewhere. Your formatting isn't really consistent with our style, and adds additional words that don't do anything except direct attention. It's longer without saying more, except where the "more" doesn't need to be said. The article introduction is already concise and easy to scan. If you want to work on an article that even an LLM can probably only improve, may I recommend About pull requests? That one is a mess. It has some versioning you'll probably have to work around manually, but the first section is a wall of text that desperately needs to be edited down and/or broken up. Keep in mind for "about" articles that we're trying to answer the question "why is this feature useful to me?" and trying to minimize technical details as much as possible. There are other "about" articles that need some attention if that one isn't to your taste. Most of them need attention, to be honest. For examples of how we would like them to look and read, you can see About forks and About discussions, which were updated recently. We're not going to accept this particular change, but I hope you'll find another article that needs work and see what you can do with that. 💛 |
|
Hi @Sharra-writes , thanks for the feedback and guidance. I’ll focus on improving an “About” article—starting with About pull requests—while reviewing the style of About forks and About discussions for reference. |
Description
This PR improves the clarity and accessibility of the "Approving workflow runs from forks" documentation by restructuring the content to be more user-friendly for both technical and non-technical audiences.
Comment
The original documentation was technically accurate but could be difficult to understand for users unfamiliar with GitHub Actions terminology. This revision maintains all technical details while making the content more accessible and scannable.
Why
Problem: The existing documentation used complex language and lacked clear structure, making it challenging for new users to understand when and why workflow approval is needed.
Solution: Restructured content with:
Closes: #[issue-number] (if applicable)
What's being changed
Before:
After:
Key Changes:
Check off the following:
Additional Notes