Skip to content

Improve SAST configuration content

Russell Dickenson requested to merge russell/improve-sast-configuration into master

What does this MR do?

  • Improves the structure of the Security Configuration page
    • Removed screenshot as it was unnecessary. It would otherwise have had to be updated to match changes in 13.3.
    • Removed the Overview title to comply with current content style guidelines.
    • Added a little more structure to the page by adding the View Security Configuration title and content.
  • Improves on the SAST Configuration using the UI content
    • Removed the Overview title to comply with current content style guidelines.
    • Removed the configuration instructions since these are duplicated in the Configuration section, and as task instructions, should not be located in the topic's introduction.
    • Corrected several instances of language issues flagged by Vale.
    • Restructured the Configuration section to list the available options and link to the relevant docs.
    • Edited the SAST Configuration UI instructions for improved clarity and detail.

Related issues

This MR builds on work done in !39085 (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. 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.

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 Russell Dickenson

Merge request reports