Skip to content

Restructure the secret detection documentation

Proposal

Format the secret detection documentation according to the structure documented in Security Products Documentation Overhaul (gitlab-com&2375)

The desired structure is as follows (per gitlab-com&2375 (comment 1949937207)):

  • Introduction (Describes what it is, why you’d use it, and who it’s a good fit for) - introduction.md
  • Getting started - getting_started.md
  • Configuration - configuration.md
  • Understanding the results - understanding_results.md
  • Optimization (including rule tuning etc) - optimization.md
  • Rollout - rollout.md
  • FAQ - faq.md (Note: Filename to be confirmed because the docs style guide states that the term "FAQ" is not to be used.)

Who can address the issue

Anyone in the Secret Detection group.

Other links/references

Security Products Documentation Overhaul (gitlab-com&2375)