Skip to content

Add Dependency Scanning migration guide

What does this MR do?

Add a migration guide to switch from the legacy Dependency Scanning feature based on the Gemnasium analyzer in the CI/CD pipeline to the new Dependency Scanning Analyzer and Dependency Scanning using SBOM.

The intent of this document is to give users of a given technology (language/package manager) a single place to look at to get a grasp of the impact and the required migration steps for this particular usage. This causes duplication and boilerplate content between the language specific sections, but this is on purpose. This guide is not meant to be read from top to bottom, but rather have a dedicated section per supported use case.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

refs #501087 (closed)

Edited by Olivier Gonzalez

Merge request reports

Loading