Rename secret "post-processing" to "automatic response"
What does this MR do?
Update the title and introductory content of the "Post-processing and revocation" page for Category:Secret Detection.
Thoughts behind this:
- This term is familiar to us, but it describes more of what the system is doing versus what the actual user-facing result is: they leak a secret and we immediately respond. It seems odd to expect users to know what "post-processing" means.
- "Revocation" is not actually the response that is done for all partners. Some partners apply different kinds of mitigations rather than immediately revoking the secret.
This docs change mirrors a previous change to the marketing site: gitlab-com/www-gitlab-com!119911 (merged).
I have not yet:
- Updated the page path. This way we don't have to immediately figure out redirects or update links everywhere. This would be particularly troublesome while a release post is being prepared.
- Changed a link from the main Secret Detection page. That link is edited separately in !118380 (merged).
Related issues
Update description and name of automatic Secret... (gitlab-com/www-gitlab-com!119911 - merged)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.