Skip to content

Docs: Fix Vale issues with the Container Registry 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 Container Registry topic, which is in the docs here.

The first number is the line number in the doc file where you can find the issue.

                                                                                                                                                                                           
 52:28   warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will have"                                                                                                                                                                                                       
 67:11   warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will:"                                                                                                                                                                                                           
 74:24   warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will be"                                                                                                                                                                                                         
 82:11   warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will:"                                                                                                                                                                                                           
 90:46   warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will navigate"                                                                                                                                                                                                                                                                                                                                                                                                   
 136:38  warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will need"                                                                                                                                                                                                                                                                                                                                                                                                         
 161:12  warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will be"                                                                                                                                                                                                         
 178:1   warning     Shorter sentences improve                                                                                                                                                              gitlab.SentenceLength      
                     readability (max 25 words).                                                                                                                                                                                                                                                                                                                                                                                            
 195:54  warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will be"                                                                                                                                                                                                                                                                                                                                                                                                            
 238:3   warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will fill"                                                                                                                                                                                                       
 279:51  warning     Use "for example" instead of                                                                                                                                                           gitlab.LatinTerms          
                     "e.g.", but consider rewriting                                                                                                                                                                                    
                     the sentence.                                                                                                                                                                                                                                                                                                                                                                                                   
 355:1   warning     Shorter sentences improve                                                                                                                                                              gitlab.SentenceLength      
                     readability (max 25 words).                                                                                                                                                                                       
 376:69  warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "won't find"                                                                                                                                                                                                      
 377:49  warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will be"                                                                                                                                                                                                                                                                                                                                                                                                                     
 555:52  warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will expire"                                                                                                                                                                                                     
 556:52  warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will be"                                                                                                                                                                                                                                                                                                                                                                     
 612:72  warning     Shorter sentences improve                                                                                                                                                              gitlab.SentenceLength      
                     readability (max 25 words).                                                                                                                                                                                       
 612:88  warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "going to run"                                                                                                                                                                                                    
 613:15  warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will remove"                                                                                                                                                                                                                                                                                                                                                                                   
 614:54  warning     Shorter sentences improve                                                                                                                                                              gitlab.SentenceLength      
                     readability (max 25 words).                                                                                                                                                                                                                                                                                                                                                                                                 
 616:18  warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will be"                                                                                                                                                                                                         
 632:58  warning     Shorter sentences improve                                                                                                                                                              gitlab.SentenceLength      
                     readability (max 25 words).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
 643:25  warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will have"                                                                                                                                                                                                       
 645:1   warning     Avoid using future tense:                                                                                                                                                              gitlab.FutureTense         
                     "will not"                                                                                                                                                                                                        
 661:37  warning     If possible, use                                                                                                                                                                       gitlab.SubstitutionWarning 
                     "administrator" instead of 

Proposal

Who can address the issue

Other links/references