From 5c804e038761ee08d8fb2e86d8cfcffcb704a887 Mon Sep 17 00:00:00 2001 From: Pete Lumbis Date: Mon, 17 Apr 2023 13:34:34 -0400 Subject: [PATCH] Add more information about vale error and warning policy Signed-off-by: Pete Lumbis --- content/contribute/vale.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/content/contribute/vale.md b/content/contribute/vale.md index 1a1b331c..d9dee9b5 100644 --- a/content/contribute/vale.md +++ b/content/contribute/vale.md @@ -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. +{{}} +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.