Skip to content

Rulesets documentation is weird in places #43918

@AlekSi

Description

@AlekSi

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:

This means that any pull requests merged into the branch or tag

What does merging a pull request into the tag even mean?..

The repository settings UI has a similar problem:
Image

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the team

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions