From f3f5795be35e8a01205ab8f7d5daf0362891cf7a Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 6 Mar 2024 15:18:44 -0700 Subject: [PATCH] docs: DOC-1096 DOC-1095 (#2364) (#2368) --- vale.ini | 6 +++++- vale/styles/spectrocloud/condescending.yml | 16 ++++++++++++++++ vale/styles/spectrocloud/plural-parantheses.yaml | 12 ++++++++++++ 3 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 vale/styles/spectrocloud/condescending.yml create mode 100644 vale/styles/spectrocloud/plural-parantheses.yaml diff --git a/vale.ini b/vale.ini index 8408a1a1a5..0385358852 100644 --- a/vale.ini +++ b/vale.ini @@ -19,4 +19,8 @@ mdx = md [*] Google.Headings = NO Google.Parens = NO -Google.Spacing = NO \ No newline at end of file +Google.Spacing = NO +Google.We = NO +Google.Acronyms = NO +Alex.Condescending = NO +Google.OptionalPlurals = NO diff --git a/vale/styles/spectrocloud/condescending.yml b/vale/styles/spectrocloud/condescending.yml new file mode 100644 index 0000000000..4dabb29f2a --- /dev/null +++ b/vale/styles/spectrocloud/condescending.yml @@ -0,0 +1,16 @@ +--- +extends: existence +message: Using '%s' may come across as condescending. +link: https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Simplicity-Assumption +level: error +ignorecase: true +tokens: + - obvious + - obviously + - simple + - simply + - easy + - easily + - of course + - clearly + - everyone knows diff --git a/vale/styles/spectrocloud/plural-parantheses.yaml b/vale/styles/spectrocloud/plural-parantheses.yaml new file mode 100644 index 0000000000..565a8a6412 --- /dev/null +++ b/vale/styles/spectrocloud/plural-parantheses.yaml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't use plurals in parentheses such as in '%s'. Write the plural form of the word instead." +link: "https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Parentheses" +level: error +nonword: true +action: + name: edit + params: + - trim_right + - "(s)" +tokens: + - '\b\w+\(s\)' \ No newline at end of file