Skip to content

Adjust wording on troubleshooting step for Code Quality docs

Caleb Williamson requested to merge calebw-master-patch-91247 into master

What does this MR do?

The troubleshooting section of this doc uses "default" rather than "target" when stating that the Code Quality widget may not appear if the target branch does not have any Code Quality artifacts.

This can (and has) led users to believe that the default branch requires previous Code Quality jobs with artifacts present in order for the widget to load, even if the default branch isn't the target for the merge request. However, its the target branch for the MR that needs to have these jobs present, which isn't always the default branch.

This MR simply adjusts the wording to use "target" rather than "default" on this line.

Related issues

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.

Merge request reports

Loading