Docs: Fix Vale issues with the Markdown doc
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 Markdown topic, which is in the docs here.
You don't need to fix all of these issues; fix as many as you can.
The first number is the line number in the doc file where you can find the issue.
82:4 warning Avoid using future tense: gitlab.FutureTense
"will flag"
86:9 warning Avoid using future tense: gitlab.FutureTense
"will display"
90:63 warning Avoid using future tense: gitlab.FutureTense
"will need"
140:32 warning Avoid using future tense: gitlab.FutureTense
"will be"
266:72 warning Avoid using future tense: gitlab.FutureTense
"will fall"
368:45 warning Avoid using future tense: gitlab.FutureTense
"won't render"
386:39 warning Avoid using future tense: gitlab.FutureTense
"will be"
387:85 warning Avoid using future tense: gitlab.FutureTense
"will be"
417:81 warning Avoid using future tense: gitlab.FutureTense
"will turn"
423:5 warning Avoid using future tense: gitlab.FutureTense
"will recognize"
449:100 warning Avoid using future tense: gitlab.FutureTense
"will be"
450:97 warning Avoid using future tense: gitlab.FutureTense
"will be"
451:113 warning Avoid using future tense: gitlab.FutureTense
"will be"
493:4 warning Avoid using future tense: gitlab.FutureTense
"will appear"
517:48 warning Avoid using future tense: gitlab.FutureTense
"will point"
594:48 warning Avoid using future tense: gitlab.FutureTense
"will be"
615:33 warning Avoid using future tense: gitlab.FutureTense
"will still"
830:37 warning Avoid using future tense: gitlab.FutureTense
"will be"
1021:52 warning Avoid using future tense: gitlab.FutureTense
"will usually"
1053:48 warning Avoid using future tense: gitlab.FutureTense
"will work"
1071:48 warning Avoid using future tense: gitlab.FutureTense
"will work"
1076:54 warning Avoid using future tense: gitlab.FutureTense
"will work"
1140:9 warning Avoid using future tense: gitlab.FutureTense
"will you"
1154:14 warning Avoid using future tense: gitlab.FutureTense
"will be"
1154:48 warning Avoid using future tense: gitlab.FutureTense
"will start"
1156:64 warning Avoid using future tense: gitlab.FutureTense
"will be"
1173:73 warning Avoid using future tense: gitlab.FutureTense
"will be"
1188:81 warning Avoid using future tense: gitlab.FutureTense
"will create"
1260:1 warning Avoid using future tense: gitlab.FutureTense
"will point"
1264:5 warning Avoid using future tense: gitlab.FutureTense
"will auto"
1288:79 warning Avoid using future tense: gitlab.FutureTense
"will be"
1290:69 warning Avoid using future tense: gitlab.FutureTense
"will use"
1384:15 warning Avoid using future tense: gitlab.FutureTense
"will appear"
1441:90 warning Avoid using future tense: gitlab.FutureTense
"will eventually"
1445:58 warning Avoid using future tense: gitlab.FutureTense
"will affect"
1468:72 warning Avoid using future tense: gitlab.FutureTense
"will paste"
Proposal
Who can address the issue
Other links/references
Edited by Suzanne Selhorn