Skip to content

Docs: Clarify private CodeQuality runner builds directory configuration

drew stachon requested to merge update-cq-runner-docs into master

What does this MR do?

This MR clarifies what is required configuration for the builds directory in the private runner configuration and what is optional.

Someone pointed out that the entire exposure of the builds directory is currently described as optional, and that isn't true. We originally described the exposure of the builds directory as required and the setting of the particular builds directory as optional, but they accidentally condensed into a single point at some point in the review process.

Related issues

#267930 (closed) & !49788 (merged)

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. I (@drew) wrote this original documentation 👍

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 drew stachon

Merge request reports