Skip to content

Restructure continuous scanning

What does this MR do?

Restructure documentation of continuous scanning.

Briefly, the proposal is to have a page that describes continuous vulnerability scanning. This page is to describe methods by which security scanning is triggered, other than manually (in a CI/CD pipeline and by policy). As it is, only one such method exists, that used by CCS and CDS. That page will then link to the individual pages for CCS and CDS.

In bullet-point form:

  • Create new CVS page, to describe the what, why, and how, of CVS.
  • Split the current detailed CVS page into 2 separate pages - one for CCS and one for CDS.
  • Mention CVS in the "Detect" page, which describes the various ways in which security scans are triggered.

Note: I'm still a little uncertain about splitting the existing CVS content into 2 separate pages, because it's likely to be almost identical. However, I'll go ahead and try it and see if it works.

Related issues

[meta] Feature name: Continuous Vulnerability S... (#477593)

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

Merge request reports

Loading