Skip to content

SAST Docs: Remove Go proxy instructions, update precompilation

Connor Gilbert requested to merge connorgilbert/tweak-precompilation into master

What does this MR do?

  1. Update the pre-compilation section and the table entry for the COMPILE option to refer only to SpotBugs. (Previously it was applicable to SpotBugs and Gosec, but Gosec was removed in 15.4.)
  2. Remove a section that was relevant only to Gosec.

I believe this is OK under the guidelines for documenting product versions, because the docs are meant to reflect current state. I'm hoping to simplify the page as much as possible, in part due to the attached OKR.

Related issues

https://gitlab.com/gitlab-com/gitlab-OKRs/-/issues/8023

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

Loading