Skip to content

Put docs branch naming back into guidelines

Marcel Amirault requested to merge docs-branch-naming into master

What does this MR do?

The docs branch naming convention no longer applies to MRs in the main GitLab repo, so the guidelines for this were removed in !16528 (merged), BUT they still apply for the other repos.

This adds the guidelines back, in regards to the Runner, Omnibus and Charts repos, so that everyone knows they can get a fast pipeline with the proper branch name in those repos.

Author's checklist

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

  • Optional: 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.

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.

Merge request reports