Skip to content

Refactor the Dependency Scanning docs

Achilleas Pipinellis requested to merge docs/ds-auto-remediation into master

What does this MR do?

After a discussion in the chat, we found out that the Solutions (auto-remediation) feature wasn't listed in the Dependency Scanning docs. I added that and while there, I fixed some other things:

Notably:

  • Merge the use cases with the opening paragraph of DS
  • Add link to the auto-remediation section in the main index page
  • Add auto remediation to the title of solutions for better SEO
  • Move the JSON reports section below the other more important sections
  • Remove Container Scanning from the list of supported scanners in solutions
  • Fix some "introduced in" sentences so that they can be properly parsed

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • 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

  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 and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcia Ramos

Merge request reports