Skip to content

Docs: Fix Vale issues with the Conan Repository 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 Conan Repository 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.

23:43    warning     Avoid using future tense:       gitlab.FutureTense         
                      "will be"                                                  
 34:14    warning     Avoid using future tense:       gitlab.FutureTense         
                      "will cover"                                                                   
 72:11    warning     If possible, use "repository"   gitlab.SubstitutionWarning 
                      instead of "repo".                                         
 72:11    warning     Spelling check: "repo"?         gitlab.Spelling            
 83:11    warning     Avoid using future tense:       gitlab.FutureTense         
                      "will create"                                              
 94:28    warning     Avoid using future tense:       gitlab.FutureTense         
                      "will generate"                                                               
 98:92    warning     Avoid using future tense:       gitlab.FutureTense         
                      "will need"                                                
 98:138   warning     Avoid using future tense:       gitlab.FutureTense         
                      "will need"                                                
 118:5    warning     Avoid using future tense:       gitlab.FutureTense         
                      "will need"                                                                                                    
 136:88   warning     Avoid using future tense:       gitlab.FutureTense         
                      "will automatically"                                           
 139:116  warning     Avoid using future tense:       gitlab.FutureTense         
                      "will request"                                                
 139:225  warning     Avoid using future tense:       gitlab.FutureTense         
                      "will need"                                                                              
 157:105  warning     Avoid using future tense:       gitlab.FutureTense         
                      "will not"                                                                                         
 160:145  warning     Avoid using future tense:       gitlab.FutureTense         
                      "will not"                                                 
 194:20   warning     Avoid using future tense:       gitlab.FutureTense         
                      "will extend"                                              
 194:136  warning     Avoid using future tense:       gitlab.FutureTense         
                      "will allow"                                                                                                                          
 226:86   warning     Avoid using future tense:       gitlab.FutureTense         
                      "will happen"                                              
 239:84   warning     Avoid using future tense:       gitlab.FutureTense         
                      "will only"                                                
 243:16   warning     Avoid using future tense:       gitlab.FutureTense         
                      "will remove"                                                                                        
 259:26   warning     Avoid using future tense:       gitlab.FutureTense         
                      "will include"                                                                                        
 263:26   warning     Avoid using future tense:       gitlab.FutureTense         
                      "will return"                                              


### Proposal

<!-- Further specifics for how can we solve the problem. -->

### Who can address the issue

<!-- What if any special expertise is required to resolve this issue? -->

### Other links/references

<!-- E.g. related GitLab issues/MRs -->