Improve the Epics 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: technical-writing#231

Further details

As an example, here's the output from a Vale test on the epics/index.md file:

The numbers represent rows and columns, so for example 18:1 means "line 18, character no. 1".

Sentence length

13:1    warning     Shorter sentences improve       gitlab.SentenceLength
                    readability (max 25 words).
67:1    warning     Shorter sentences improve       gitlab.SentenceLength
                    readability (max 25 words).
75:1    warning     Shorter sentences improve       gitlab.SentenceLength
                    readability (max 25 words).
111:1   warning     Shorter sentences improve       gitlab.SentenceLength
                    readability (max 25 words).
113:1   warning     Shorter sentences improve       gitlab.SentenceLength
                    readability (max 25 words).
141:1   warning     Shorter sentences improve       gitlab.SentenceLength
                    readability (max 25 words).
148:1   warning     Shorter sentences improve       gitlab.SentenceLength
                    readability (max 25 words).
156:1   warning     Shorter sentences improve       gitlab.SentenceLength
                    readability (max 25 words).
159:1   warning     Shorter sentences improve       gitlab.SentenceLength
                    readability (max 25 words).

Future tense

73:42   warning     Avoid using future tense:       gitlab.FutureTense
                    "will be"
77:7    warning     Avoid using future tense:       gitlab.FutureTense
                    "will appear"
111:62  warning     Avoid using future tense:       gitlab.FutureTense
                    "will automatically"
113:71  warning     Avoid using future tense:       gitlab.FutureTense
                    "will set"
128:44  warning     Avoid using future tense:       gitlab.FutureTense
                    "will scan"
129:7   warning     Avoid using future tense:       gitlab.FutureTense
                    "will set"
130:42  warning     Avoid using future tense:       gitlab.FutureTense
                    "will set"
142:35  warning     Avoid using future tense:       gitlab.FutureTense
                    "will reflect"
142:68  warning     Avoid using future tense:       gitlab.FutureTense
                    "will propagate"
178:39  warning     Avoid using future tense:       gitlab.FutureTense
                    "will be"
179:35  warning     Avoid using future tense:       gitlab.FutureTense
                    "will start"

Other

25:127  suggestion  Avoid words like "currently"    gitlab.CurrentStatus
                    that promise future changes.
103:68  suggestion  Avoid words like "currently"    gitlab.CurrentStatus
                    that promise future changes.
112:43  suggestion  Avoid words like "currently"    gitlab.CurrentStatus
                    that promise future changes.
114:25  suggestion  Avoid words like "currently"    gitlab.CurrentStatus
                    that promise future changes.

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!

Edited by Marcin Sedlak-Jakubowski