Skip to content

Reformat SAST analyzers page to comply with CTRT structure

Russell Dickenson requested to merge russell/ctrt-sast-analyzers into master

What does this MR do?

Reformat and edit the SAST analyzers page to comply with CTRT structure.

Included:

  • Standardize on use of analyzer and scanner instead of generic terms. Link to terminology reference to provide more detail about these concepts.
  • Reorder content so that it flows from least specific to most specific.
  • Ensure all titles are in sentence case and use infinitive verb form.
  • Added high-level topic "Customize analyzers" to collect related content under a single heading.
  • Edited all content, resulting in a reduction of Flesch-Kincaid grade from 14.03 to 10.16.

Before

https://docs.gitlab.com/ee/user/application_security/sast/analyzers.html

After

http://main-ee-85565.35.193.151.162.nip.io/ee/user/application_security/sast/analyzers.html

Related issues

technical-writing#531 (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 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

Loading