Skip to content

Docs: Edit Secret Detection intro, clarify detection scope

What does this MR do?

Update the introductory framing of Secret Detection to:

  • Simplify some sentences.
  • Remove emphasis on passwords, which are not the focus of our current detection capability.
  • De-emphasize the underlying scan engine, which has confused people about the source of rules and the scope of our support responsibility.
  • Highlight Ultimate-only features.
  • Remove an out-of-date screenshot. I could replace it but didn't feel it was providing a ton of value.
  • Fix the name of the CI/CD job (secret_detection, not secret-detection).

Those changes were along the way to the main event, which was an update to the section addressing what secrets we detect. I've changed this section by:

  • Explaining what well-identifiable secrets are (though not using that specific term, since it isn't widely adopted).
  • Noting that we only search for passwords in specific places, not everywhere.
  • Moving the "if you want to contribute" text to a separate section and updating it to not point to a closed issue, and also cross-promoting our partner program for automatic response.

Related issues

I started the MR because of an uptick in questions about why we aren't detecting passwords when people are trying to test Secret Detection. See Slack (team members only).

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