Skip to content

Docs: Improve DS with SBOM user doc

What does this MR do?

Update the DS with SBOM user documentation to:

  • Explain how this feature works
  • List various enablement options

This is particularly relevant as we announce Dependency Scanning support for Cargo, Conda, Cocoapods and Swift in the Dependency Scanning CI template using the new DS analyzer.

I ultimately think we need to extract dependency detection to its own page, or the DS analyzer at least. I've tried to keep it concise and did not follow the same detailed enablement instructions we have on the legacy DS feature page (ADO, pre-configured MR, SEP, manually, CI/CD component)...

Here the recommended enablement approach is via the DS CI template, as we've decided in our rollout strategy and as advertised in the migration guide.

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.
Edited by Olivier Gonzalez

Merge request reports

Loading