Rewrite content based on Vale linting: group_managed_accounts.md
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 group_managed_accounts.md file:
group_managed_accounts.md
16:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
24:26 warning Avoid using future tense: gitlab.FutureTense
"will be"
25:68 warning Avoid using future tense: gitlab.FutureTense
"will require"
33:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
33:97 warning Avoid using future tense: gitlab.FutureTense
"will lose"
35:12 warning Avoid using future tense: gitlab.FutureTense
"will be"
35:66 warning Avoid using future tense: gitlab.FutureTense
"will no"
36:31 warning Use "for example" instead of gitlab.LatinTerms
"e.g.", but consider rewriting
the sentence.
36:60 warning Avoid using future tense: gitlab.FutureTense
"will remain"
52:1 suggestion Avoid words like "Currently" gitlab.CurrentStatus
that promise future changes.
100:1 warning Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
104:304 warning Avoid using future tense: gitlab.FutureTense
"will apply"
113:59 warning Avoid using future tense: gitlab.FutureTense
"will:"
115:119 suggestion Use "that's" instead of "that gitlab.Contractions
is", 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.