Skip to content

Docs: Fix Vale issues with the Releases topic

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 Releases 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.

226:1   warning     Avoid using future tense:       gitlab.FutureTense    
                     "will be"                                             
 231:45  warning     Avoid using future tense:       gitlab.FutureTense    
                     "will be"                                                                    
 268:8   warning     Avoid using future tense:       gitlab.FutureTense    
                     "will support"                                                                
 276:8   warning     Avoid using future tense:       gitlab.FutureTense    
                     "will always"                                                                
 281:49  warning     Avoid using future tense:       gitlab.FutureTense    
                     "will create"                                                                             
 305:79  warning     Avoid using future tense:       gitlab.FutureTense    
                     "will remain"                                         

Proposal

Who can address the issue

Other links/references

Edited by Suzanne Selhorn