Docs: Remove obsolete Semgrep transition steps, simplify translation
What does this MR do?
- Remove some very-old content about activating Semgrep-based scanning early
- Now it's on by default so this is not important.
- Simplify the description of which vulns are translated, since we have a lot more analyzers to discuss now, but the details are actually hard to understand anyway.
- Seems better to just say "we try, and here are reasons it may not work".
Related issues
- Update "Transition to Semgrep-based scanning" s... (#382156 - closed) • Connor Gilbert • 17.2
- Explain how findings are handled when Semgrep-b... (#412795 - closed) • Connor Gilbert • 17.2
Also relevant to https://gitlab.com/gitlab-com/gitlab-OKRs/-/issues/8023+.
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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