Require CS tool change if docs heading changed
What does this MR do?
This MR adds some comments to the Container Scanning docs explaining that if the headings are changed, the code in the GitLab Container Scanning tool must also be changed to reference the new headings.
Background
Additional error handling code was added to the GitLab Container Scanning tool in gitlab-org/security-products/analyzers/klar!29 (merged). This new error handling references specific headings in the Container Scanning docs.
In order to ensure that the headings referenced by the GitLab Container Scanning tool do not become out of date with the docs, it was suggested in this discussion to add a comment to the headings in the container scanning docs explaining that the container scanning tool must be updated if the headings are changed.
Related issues
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
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
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.