Improve the Secret Detection documentation
Unless you're a Tichtov student, please do not take this issue, or create an MR for it.
Problem to solve
The Vale linter is used to support grammar linting in GitLab documentation. As Vale was implemented after many of the GitLab documents were written, we have many documentation pages that do not meet the linting standards created by the GitLab Technical Writing team for Vale.
Further details
As an example, here's the output from a Vale test on the Secret Detection index.md file:
index.md
43:27 suggestion Avoid words like "currently" gitlab.CurrentStatus
that promise future changes.
80:31 warning Avoid using future tense: gitlab.FutureTense
"will ignore"
82:78 warning Avoid using future tense: gitlab.FutureTense
"won't be"
113:81 warning Avoid using future tense: gitlab.FutureTense
"will be"
167:238 warning Avoid using future tense: gitlab.FutureTense
"will also"
185:29 suggestion Use "you're" instead of "you gitlab.ContractionsKeep
are", for a friendly, informal
tone.
Each of these messages point to a specific line:column in the noted file.
Proposal
Consider each error message, and see if you can rewrite the noted file with a solution.
Who can address the issue
Anyone with an understanding of basic written US English. Ideally, that person should also have some domain expertise in the subject area.
Additional notes
We appreciate any help that you can provide. If you cannot resolve some of the issues, that is OK, your contributions are still appreciated. And thank you!