-
Notifications
You must be signed in to change notification settings - Fork 67.2k
Rulesets documentation is weird in places #43918
Copy link
Copy link
Open
Labels
InactiveWill be closed automatically by a stall check if no activity is detected.Will be closed automatically by a stall check if no activity is detected.contentThis issue or pull request belongs to the Docs Content teamThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the teamDo not begin working on this issue until triaged by the team
Description
Metadata
Metadata
Assignees
Labels
InactiveWill be closed automatically by a stall check if no activity is detected.Will be closed automatically by a stall check if no activity is detected.contentThis issue or pull request belongs to the Docs Content teamThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the teamDo not begin working on this issue until triaged by the team
Type
Fields
Give feedbackNo fields configured for issues without a type.
Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets and adjusted pages. Also, text descriptions in repository settings.
What part(s) of the article would you like to see updated?
There are many places where text refers to things weirdly or just incorrectly.
The most obvious problem is where branches, tags, and refs are mixed together. For example, https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-linear-history says:
What does merging a pull request into the tag even mean?..
The repository settings UI has a similar problem:
It says "refs", which is slightly better, but it is still very unclear how one can push a merge commit into a tag.
Additional information
No response