Skip to content

Docs: Move SAST reference table below concepts and tasks

Connor Gilbert requested to merge connorgilbert/sast-analyzer-page-order into master

What does this MR do?

What: Within the SAST analyzers page, move the reference table below concepts and tasks without changing its contents.

Why: We often link to specific sections. However, if a user is browsing the documentation or lands on the overall analyzers page, I want to make sure that they see the concepts and tasks for customization and Semgrep transition.

I fear they won't notice that this content is below the large analyzers table. The table itself is both wide and tall, and it can cover a full screen (and even overlap with the table of contents links) at certain screen sizes.

Screenshot of overlapping table and TOC Screen_Shot_2022-05-18_at_9.46.32_AM

Related issues

N/A

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

Loading