Skip to content

Improve Monorepo doc based on Vale warnings

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

Here's the output from a Vale test on the monorepo.md file. This file lives here in the documentation.

                          
 17:6   warning  Avoid using future tense:       gitlab.FutureTense         
                 "will have"                                                
 20:10  warning  Avoid using future tense:       gitlab.FutureTense         
                 "will walk"                                                                                   
 47:37  warning  Avoid using future tense:       gitlab.FutureTense         
                 "will need"                                                
 48:57  warning  Avoid using future tense:       gitlab.FutureTense         
                 "will need"                                                                               
 51:65  warning  Avoid using future tense:       gitlab.FutureTense         
                 "will need"                                                
 56:19  warning  Avoid using future tense:       gitlab.FutureTense         
                 "will be"                                                                                
 59:34  warning  Avoid using future tense:       gitlab.FutureTense         
                 "will just"                                                
 67:9   warning  Avoid using future tense:       gitlab.FutureTense         
                 "will be"                                                          
 69:15  warning  Avoid using future tense:       gitlab.FutureTense         
                 "will be"                                                                              
 80:60  warning  Avoid using future tense:       gitlab.FutureTense         
                 "will publish"           

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.

Additional notes

We appreciate any help you can provide. If you cannot resolve some of the issues, that is OK, your contributions are still appreciated. And thank you!

Edited by Mike Jang