crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add more information about vale error and warning policy 

Signed-off-by: Pete Lumbis <pete@upbound.io>
This commit is contained in:
Pete Lumbis 2023-04-17 13:34:34 -04:00
parent 58068b8480
commit 5c804e0387
No known key found for this signature in database
GPG Key ID: FDC6C20960060000
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
content/contribute/vale.md
View File

@ -11,6 +11,12 @@ Crossplane's Vale style definitions are in the
[utils/vale](https://github.com/crossplane/docs/tree/master/utils/vale)
directory.
{{< hint "important" >}}
The Crossplane community is updating existing content to pass Vale. Until the
community completes the project Vale errors are only enforced for new or changed
content. The community approves PRs with Vale errors in unmodified document sections.
{{< /hint >}}
## Install Vale
Follow the directions on the Vale website to
@ -50,6 +56,12 @@ Crossplane uses the following Vale styles:
customized terms and preventing corporate jargon.
* [write-good](https://github.com/errata-ai/write-good) - for higher quality writing.
{{<hint "warning" >}}
Crossplane maintainers consider Vale warnings the same as errors.
Error levels aren't changed to make Vale style maintenance easier.
{{< /hint >}}
### Ignore Vale rules
Vale can turn off specific rules or all rules inside a doc.