Skip to content

Docs: Split SAST Troubleshooting to separate page

Connor Gilbert requested to merge connorgilbert/split-sast-troubleshooting into master

What does this MR do?

Move SAST troubleshooting content to its own page to try and slim down the main page.

I noticed we had Troubleshooting topic type guidance:

If a page has more than five troubleshooting topics, put the content on a separate page that has troubleshooting information exclusively. Name the page Troubleshooting and in the left nav, use the word Troubleshooting only.

This page will still need to be added to the left nav, but we can't do that until the page exists.

Note: we link to docs in a failure log message (gitlab-org/security-products/analyzers/command!31 (diffs)). However, this link goes to the overall Application Security page, not the SAST-specific page.

Related issues

None, though we've had a long-standing general desire to make the main SAST page more approachable.

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

Merge request reports