Skip to content

Improve overriding stages example

What does this MR do?

Updates a troubleshooting entry that corresponds to errors running security jobs when the test stage name is missing.

For the default security jobs, the current examples appear dated for situations where the test stage is undefined. It is also lacking example names to use for all the (currently, 4) types of includes available.

This change adds a more complete example on how to override the stage name for every one of the included jobs, in a copy-paste-able form.

The updated job names used in the change are derived from the template files, using the highest inherited definitions so it can influence all jobs that arrive through the include statement.

Related issues

Customer ticket (Zendesk, internal link)

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