Skip to content

Docs: Simplify SAST requirements, remove Docker 19.03.00 warning

Connor Gilbert requested to merge connorgilbert/docs-simplify-runner-reqs into master

What does this MR do?

  • Remove warning about Docker 19.03.0 (#13830 (comment 211354992)) from the main SAST and SD docs pages.
    • This version is from 2019 (19.x) and seems to have been resolved nearly immediately afterward (19.03.01).
    • The relevant troubleshooting content also remains in SAST and DS documentation.
    • So, essentially the change is to stop including this "by default" when people look at the requirements.
  • Change the structure of the SAST requirements section to match SD's section, which covers the "you can only use amd64" requirement more elegantly.

Related issues

Relates to 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