Skip to content

WIP: Mention that "Docs:" prefix in MR titles skips non-docs CI jobs

Katrin Leinweber requested to merge docs-mention-ci-skip into master

What does this MR do?

This pushes some advice seen in Slack & issues comments how to speed up CI runs for changes that only affect documentation / non-code to the foreground / moment when it makes a difference.

Related issues

Author's checklist

Not relevant, because this is not for a documentation file, but an issue template.

  • [-] If applicable, update the permissions table.
  • [-] Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the documentation label.

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.
Edited by Katrin Leinweber

Merge request reports