Skip to content

Docs: Update CI documentation for shared runner settings

Mireya Andres requested to merge update-ci-runners-docs into master

What does this MR do?

This MR updates the instructions for enabling/disabling the shared runner settings. The button has been replaced with a toggle.

The current documentation can be found here: Enable Shared Runners.

Related issues

This relates to the following issues:

The issue pertains to changing the shared runners button into a toggle for better UX.

The feature change is already merged. It is enabled in staging and the project mgandres1/test-ci-project in production. It is currently gated by the vueify_shared_runners_toggle feature flag.

Some screenshots of the feature change being described in the docs:

Before After
Before After

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 Mireya Andres

Merge request reports

Loading