Skip to content

Improve SAST report description

Russell Dickenson requested to merge rd/sast-improve-report-description into master

What does this MR do?

Improve SAST report description:

  • Link to the "View SAST results" topic instead of listing a subset of the information. This ensures we have a single source of truth.
  • Rename the main topic "Output" instead of "Reports JSON format" because JSON is a technical detail, and not a likely search term.
  • Include link to the download topic in the introduction, instead of "For information", as it's not a concept but instead a task the user may want to complete.

Related issues

https://gitlab.com/gitlab-org/technical-writing/-/issues/936

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