Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce Vale #609

Open
olblak opened this issue Dec 13, 2022 · 0 comments
Open

Introduce Vale #609

olblak opened this issue Dec 13, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@olblak
Copy link
Member

olblak commented Dec 13, 2022

Summary

It would be great to start using Vale to catch documentation style guide issues

Basic example

An example of a vale run

vale content/en/docs/plugins/autodiscovery/*

 content/en/docs/plugins/autodiscovery/dockerfile.adoc
 18:5     error       Did you really mean             Vale.Spelling       
                      'Dockerfile'?                                       
 18:50    error       Did you really mean             Vale.Spelling       
                      'dockerfile'?                                       
 19:77    suggestion  Spell out 'FROM', if it's       Google.Acronyms     
                      unfamiliar to the audience.                         
 26:38    suggestion  In general, use active voice    Google.Passive      
                      instead of passive voice ('be                       
                      tuned').                                            
 26:207   error       Did you really mean             Vale.Spelling       
                      'Autodiscovery'?                                    
 30:5     error       Did you really mean             Vale.Spelling       
                      'dockerfile'?                                       
 30:16    error       Did you really mean             Vale.Spelling       
                      'autodiscovery'?                                    
 34:39    warning     Avoid using 'will'.             Google.Will         
 34:83    error       Did you really mean             Vale.Spelling       
                      'dockerfile'?                                       
 36:38    error       Did you really mean 'dryrun'?   Vale.Spelling       
 37:2     error       Use 'Updatecli' instead of      Vale.Terms          
                      'updatecli'.                                        
 41:15    suggestion  In general, use active voice    Google.Passive      
                      instead of passive voice ('is                       
                      provided').      

Motivation

Executed from the CI, it would improve the quality of the documentation

@olblak olblak added the enhancement New feature or request label Dec 13, 2022
@olblak olblak added this to updatecli Dec 13, 2022
@olblak olblak moved this to Todo in updatecli Dec 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Todo
Development

No branches or pull requests

1 participant