Skip to content

Update index to clarify enabling of setting Merge commit

Izzy Fee requested to merge izzyfee-master-patch-24303 into master

What does this MR do?

Adding in a small update to clarify Merge method setting of Merge commit that needs to be enabled for merge trains to work, since the other two options do not yet work for merge trains. This is based on a Support ticket that came in where customer was trying to get merge trains to work using the other two options (semi-linear history or FF).

Please feel free to adjust as needed.

Related issues

#34515 (closed) #35628 (closed) #282442 (closed)

(Not sure if we want to also include anything in the documentation to clarify that semi-linear history or FF merge commits are not yet supported?)

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 Izzy Fee

Merge request reports