You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
Summary
It would be great to start using Vale to catch documentation style guide issues
Basic example
An example of a vale run
Motivation
Executed from the CI, it would improve the quality of the documentation
The text was updated successfully, but these errors were encountered: