Docs: Standardize the introduction to patterns detected by secret detection
Problem to solve
We have two methods of detecting secrets during the development life cycle:
- pipeline secret detection (PSD)
- secret push protection (SPP).
We also have client-side secret detection which detects secrets in issue/MR descriptions and comments.
The PSD documentation includes a detected secrets section that describes briefly the conditions and caveats that apply. SPP has no such page, which means users are unaware of any caveats that apply.
Proposal
Standardize the documentation of conditions and caveats that apply to PSD and SPP.
- Include a separate section on each feature's "home" page that describes, perhaps in bullet points, any conditions and caveats that apply.
- Introduce and link to the "Detected secrets" pages of each feature.
Note: Documentation of conditions and caveats that apply to client-side secret detection should be addressed separately from this issue, in Document patterns used by client-side secret de... (#471390 - closed).
Who can address the issue
Anyone.
Other links/references
Issue Provide a single reference of patterns detected... (#470127 - closed) aims to provide a central reference of the patterns of secrets detected by PSD and SPP. The improvements suggested for this issue may overlap, but can probably be dealt with separately.