Improve the labels 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.
Related issue: technical-writing#231 (closed)
Further details
As an example, here's the output from a Vale test on the labels.md file:
The numbers represent rows and columns, so for example
18:1
means "line 18, character no. 1".
Sentence length
81:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
90:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
128:34 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
169:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
177:23 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
180:27 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
193:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
203:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
208:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
Future tense
55:33 warning Avoid using future tense: gitlab.FutureTense
"going to the"
86:126 warning Avoid using future tense: gitlab.FutureTense
"will be"
86:55 warning Avoid using future tense: gitlab.FutureTense
"will not"
93:76 warning Avoid using future tense: gitlab.FutureTense
"will all"
94:82 warning Avoid using future tense: gitlab.FutureTense
"will also"
98:21 warning Avoid using future tense: gitlab.FutureTense
"will be"
111:31 warning Avoid using future tense: gitlab.FutureTense
"going to the"
121:74 warning Avoid using future tense: gitlab.FutureTense
"will belong"
128:43 warning Avoid using future tense: gitlab.FutureTense
"will show"
129:46 warning Avoid using future tense: gitlab.FutureTense
"will add"
155:86 warning Avoid using future tense: gitlab.FutureTense
"will cause"
191:51 warning Avoid using future tense: gitlab.FutureTense
"will be"
205:12 warning Avoid using future tense: gitlab.FutureTense
"will be"
Other
18:3 warning Use a comma before the last gitlab.OxfordComma
"and" or "or" in a list of
four or more items.
Proposal
Consider each or some error messages, 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 all of the issues, that is also OK, your contributions are still appreciated. And thank you!