Skip to content

Update documentation: doc/push_rules/push_rules.md

Steve Graham requested to merge docs-update-push-rules-sgrahamgl into master

What does this MR do?

Adding a new section for the end of our push rules page that provides examples that can be used to create a few different types of Prohibited file names.

Also adding some clarification to the Prohibited file names row in the options table to reflect that these rules apply to new files, ones that do not already exist in the repository, and adding a link to the new section at the end of the page.

Related issues

Docs feedback: Add examples of Prohibited file name rules to end of push rules page

Closes #254984 (closed)

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.
    • Ensure docs metadata are present and up-to-date.
    • Ensure Technical Writing and documentation are added.
    • Add the corresponding docs:: scoped label.
    • Add twdoing when starting work on the MR.
    • Add twfinished if Technical Writing team work on the MR is complete but it remains open.

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 Steve Graham

Merge request reports