Skip to content

Add Review App route map

Evan Read requested to merge eread/add-review-app-route-map-docs into master

What does this MR do?

Adds a Review App route map for documentation, per: https://docs.gitlab.com/ee/ci/review_apps/#route-maps.

Basically the same one we use in gitlab: https://gitlab.com/gitlab-org/gitlab/-/blob/057b01c1e567fa8b17e21de2977fccb149a07787/.gitlab/route-map.yml

I edited a documentation topic to get the review app to be required.

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.

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 Evan Read

Merge request reports