Skip to content

SAST Docs: Point to analyzers instead of upstream projects

Connor Gilbert requested to merge connorgilbert/sast-languages-table into master

What does this MR do?

We've seen cases where people go to upstream projects for documentation or support. This is confusing for users and upstream projects, and reduces the visibility of things we spend effort maintaining, like CHANGELOGs for each analyzer. It also hides some of the value that GitLab provides, for example by maintaining a supported set of Semgrep rules.

Linking to analyzers instead of upstream makes it clearer that we are packaging and supporting analyzers, not using open-source projects directly off-the-shelf.

Adding "with GitLab-managed rules" to Semgrep rows in the table clarifies that Semgrep/r2c are not responsible for rules. We have seen rule issues reported upstream in some cases and wish to both clarify the value GitLab provides and reduce the effort Semgrep contributors spend redirecting to GitLab.

List of changes:

  • Add language detection and scanning to the features-by-tier table
  • Change links from upstream project websites/repos to GitLab analyzer projects
  • Change "Semgrep" to "Semgrep with GitLab-managed rules"
  • Change table column headers
  • Format table whitespace/adjust alignment
  • Remove mention of package managers, which aren't relevant to SAST—this may be an unintentional copy from Dependency Scanning
  • Edit intro text for the language support table

Related issues

I can gather some but don't have them immediately at hand.

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 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 Connor Gilbert

Merge request reports