Skip to content

Tier badges for Push Rules h3s w/ no badging for attributes

Craig Norris requested to merge docs-push-rules-tier into master

What does this MR do?

To better surface that the sections in the Push Rules for the Projects API apply only to the Starter tier and up, this MR adds the tier badges to the h3s in the Push Rules section, and removes the **(STARTER)** notation from the attributes in that section, as it's duplicate info. I know that the Push Rules h2 has the Starter tier badge, but putting it on the three h3s helps with clarity (and for people that jump straight to that section), and is more obvious than the icons on each of the attributes. Plus, it reduces some technical debt, considering the number of tier codes it removes from the page.

This shouldn't represent any change in functionality, but I'm sending it along for review. Only the h3 subsections of the Push Rules section were changed, and only in the manner described above.

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcin Sedlak-Jakubowski

Merge request reports

Loading