Skip to content

Docs: Clarify merge train requirement for GitLab repo

Kaitlyn Chappell requested to merge docs-clarify-train-external into master

What does this MR do?

We mention the need for a GitLab repository and not an external CI/CD only mirror in the pipelines for Merge Requests docs, but not on the pages for Merge Trains or Pipelines for Merged Results. While it could be inferred, it's not particularly easy to see that requirement, causing confusion based on a support ticket I worked and some issues I found. I've copied the requirement from the Pipelines for Merge Requests to the other two pages so it's more clearly stated.

Related issues

I had a customer ask about the Merge Train requirement in this (internal only link) Zendesk ticket.

That led me to find these two issues complaining about the Pipelines for Merged Results page:

#296024

#295501 (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.

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 Kaitlyn Chappell

Merge request reports