Skip to content

Clean up Dependency Scanning docs

Russell Dickenson requested to merge rd/dependency-scanning-cleanup into master

What does this MR do?

Clean up Dependency Scanning docs:

  • Remove warning re: Docker because (1) the Docker version mentioned is more than 2 years old, (2) details of the issue with that version of Docker are already contained in the Troubleshooting section.
  • Remove warning re: a feature introduced in GitLab 13.0. The warning is still factually correct, but as the change was made more than 2 years ago, it's no longer required.
  • Remove Google survey link because we are no longer seeking user input on the feature.

Regarding the survey, Sara Meadzinger (Composition Analysis PM) noted in Slack:

There have been a total of 2 responses 🙂. 1 response in Oct 2021, 1 in Feb 2022. I think it's safe for us to remove this from the docs.

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 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 Russell Dickenson

Merge request reports