Skip to content

GitLab Advisory Database Documentation

claromes requested to merge gitlab-community/gitlab:docs-glad into master

What does this MR do?

Outline of the GLAD documentation.

Questions:

  • In addition to the filled topics, "Standardization" aim to emphasize how these items (CVE, CVSS, CWE) are related to GLAD.
    • If it is advisable to retain them, what should be the approach to each item?
    • Should NVD be added?
  • Should Trivy be mentioned as an open-source option for CS?
  • Could a topic on applicability/example of usage in text or visual format (infographic) be added?

Other references I used:

https://about.gitlab.com/blog/2022/02/16/a-community-driven-advisory-database/

https://www.youtube.com/playlist?list=PL05JrBw4t0Kpke91zoZQBB2a5acS6V3XK

Related issues

#419500 (closed)

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.

Merge request reports

Loading