From 9bf22938be528d91d37015b2f3eb5bda98a20f23 Mon Sep 17 00:00:00 2001
From: Chmouel Boudjnah <chmouel@redhat.com>
Date: Wed, 4 Sep 2024 10:49:26 +0200
Subject: [PATCH] vale rules update

update vale rules to latest
---
 .vale/styles/RedHat/CaseSensitiveTerms.yml | 15 +++++++--------
 .vale/styles/RedHat/Contractions.yml       |  2 +-
 .vale/styles/RedHat/Definitions.yml        |  2 ++
 .vale/styles/RedHat/GitLinks.yml           | 12 ++++++++++++
 .vale/styles/RedHat/Hyphens.yml            |  1 +
 .vale/styles/RedHat/PascalCamelCase.yml    |  2 ++
 .vale/styles/RedHat/PassiveVoice.yml       |  7 +++++++
 .vale/styles/RedHat/ReadabilityGrade.yml   | 11 ++++-------
 .vale/styles/RedHat/RepeatedWords.yml      |  6 +++++-
 .vale/styles/RedHat/SimpleWords.yml        |  1 -
 .vale/styles/RedHat/Slash.yml              |  1 +
 .vale/styles/RedHat/Spelling.yml           | 11 ++++++++---
 .vale/styles/RedHat/TermsErrors.yml        |  6 ++++--
 .vale/styles/RedHat/TermsSuggestions.yml   | 10 ++++------
 .vale/styles/RedHat/TermsWarnings.yml      |  9 ++++++++-
 .vale/styles/RedHat/UserReplacedValues.yml | 18 +++++++++++++-----
 .vale/styles/RedHat/Using.yml              | 14 ++++++++++++++
 17 files changed, 93 insertions(+), 35 deletions(-)
 create mode 100644 .vale/styles/RedHat/GitLinks.yml
 create mode 100644 .vale/styles/RedHat/Using.yml

diff --git a/.vale/styles/RedHat/CaseSensitiveTerms.yml b/.vale/styles/RedHat/CaseSensitiveTerms.yml
index 08b645d9a..91b6f9a43 100644
--- a/.vale/styles/RedHat/CaseSensitiveTerms.yml
+++ b/.vale/styles/RedHat/CaseSensitiveTerms.yml
@@ -23,16 +23,16 @@ swap:
   "DM(?![ -]Multipath)|directory manager": Directory Manager
   "JBoss Broker|Red Hat Broker|The AMQ Broker": AMQ Broker
   "JBoss Console|Red Hat Console": AMQ Console
-  "Kernel(?!-based Virtual Machine| Module Management)": kernel
+  "Kernel(?!-based Virtual Machine| Module Management| parameters| arguments| packet filtering)": kernel
   "OCM|(?<!Red Hat OpenShift )Cluster Manager|(?<!Red Hat )OpenShift Cluster Manager|the OpenShift Cluster Manager": Red Hat OpenShift Cluster Manager
   "OD": Red Hat OpenShift Dedicated
   "sub version|(?<!Apache )Subversion": sub-version
   '(?<!\.)IM': instant message
-  '(?<!\.)yaml|Yaml': YAML
+  '(?<!\.)yaml(?!-patch)|Yaml': YAML
   '(?<!JBoss )EAP|(?<!Red Hat )JBoss(?!\sCommunity|\sBroker|\sClients|\sConsole|\sAMQ|\sData\sGrid|\sBRMS|\sBPMS|\sEnterprise\sApplication\sPlatform|\.org|\sInterconnect|\sEAP|\sBPM\sSuite)': JBoss EAP
   '(?<!Realtime )Decision\sServer': Realtime Decision Server
   '[nN]odejs|[nN]ode\.JS|node\.js': Node.js
-  '\s\.Net Core|\s\.Net|\s\.NET\sCore|dotNet': .NET
+  'dotNet': .NET
   'A-MQ(?!\sBroker|\sClient|\sConsole|\sInterconnect)': AMQ
   'A-MQ\sBroker': AMQ Broker
   'A-MQ\sClients': AMQ Clients
@@ -87,10 +87,10 @@ swap:
   classic mode: GNOME Classic
   CloudForms Management Engine|CFME: Red Hat CloudForms|Red Hat CloudForms Appliance
   command prompt: shell prompt|Command Prompt (Windows product)
-  Composite Content view|composite content view|Composite View|composite view: Composite Content View
+  Composite Content view|Composite Content Ciew|Composite View|composite view: composite content view
   configmap: config map
   configuration map: config map
-  Content view|content view: Content View
+  Content view|Content View: content view
   control key|ctrl: Ctrl
   CP|RHCP|customer portal: Customer Portal|Red Hat Customer Portal
   crush map|crushmap: CRUSH map
@@ -243,12 +243,11 @@ swap:
   RAW: raw
   Red Hat JBoss Data Grid|JDG: Red Hat Data Grid
   Red Hat JBoss EAP: Red Hat JBoss Enterprise Application Platform
-  Red Hat Network Satellite server: Red Hat Network Satellite Server
-  Red Hat Proxy: Red Hat Network Proxy Server
   Red Hat Satellite Capsule server: Red Hat Satellite Capsule Server
   Red Hat Satellite server: Red Hat Satellite Server
   Red Hat satellite: Red Hat Satellite
   Redboot|Red Boot: RedBoot
+  RedFish: Redfish
   redis: Redis
   RESTEASY|resteasy|Resteasy: RESTEasy
   RHDS: Red Hat Directory Server
@@ -288,7 +287,7 @@ swap:
   StartX: startx
   STI|source to image: Source-to-Image (S2I)
   SU: su
-  Subscription manifest: Subscription Manifest
+  Subscription Manifest: subscription manifest
   Sys V|System V: SysV
   system D|system D|SystemD|system d: systemd
   Technology preview|technology preview: Technology Preview
diff --git a/.vale/styles/RedHat/Contractions.yml b/.vale/styles/RedHat/Contractions.yml
index 67354dedd..be0af55f6 100644
--- a/.vale/styles/RedHat/Contractions.yml
+++ b/.vale/styles/RedHat/Contractions.yml
@@ -8,7 +8,7 @@ message: "Avoid contractions. Use '%s' rather than '%s.'"
 action:
   name: replace
 swap:
-  "aren't": is not
+  "aren't": are not
   "can't": cannot
   "couldn't": could not
   "didn't": did not
diff --git a/.vale/styles/RedHat/Definitions.yml b/.vale/styles/RedHat/Definitions.yml
index d46eac8bf..1c968741e 100644
--- a/.vale/styles/RedHat/Definitions.yml
+++ b/.vale/styles/RedHat/Definitions.yml
@@ -126,6 +126,8 @@ exceptions:
   - PPP
   - PROM
   - PTP
+  - PV
+  - PVC
   - PXE
   - QCOW2
   - QEMU
diff --git a/.vale/styles/RedHat/GitLinks.yml b/.vale/styles/RedHat/GitLinks.yml
new file mode 100644
index 000000000..4e19e8343
--- /dev/null
+++ b/.vale/styles/RedHat/GitLinks.yml
@@ -0,0 +1,12 @@
+---
+extends: existence
+message: Do not include a link to %s unless it is explicitly approved.
+link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/gitlinks/
+ignorecase: true
+level: warning
+scope: raw
+action:
+  name: remove
+tokens:
+  - 'https:\/\/gitlab\.com\/.*'
+  - 'https:\/\/github\.com\/(?!openshift|redhat-developer).*'
\ No newline at end of file
diff --git a/.vale/styles/RedHat/Hyphens.yml b/.vale/styles/RedHat/Hyphens.yml
index 7926a0364..ad9a169b0 100644
--- a/.vale/styles/RedHat/Hyphens.yml
+++ b/.vale/styles/RedHat/Hyphens.yml
@@ -190,6 +190,7 @@ swap:
   re-direct: redirect
   re-edit: reedit
   re-examine: reexamine
+  re-register: reregister
   re-synchronize: resynchronize
   recreate: re-create
   reenable: re-enable
diff --git a/.vale/styles/RedHat/PascalCamelCase.yml b/.vale/styles/RedHat/PascalCamelCase.yml
index e4a23cbed..a2f3ea107 100644
--- a/.vale/styles/RedHat/PascalCamelCase.yml
+++ b/.vale/styles/RedHat/PascalCamelCase.yml
@@ -111,6 +111,7 @@ exceptions:
   - NetXen
   - NetXtreme
   - NFSv
+  - NMState
   - NuGet
   - NVidia
   - NVMe
@@ -172,6 +173,7 @@ exceptions:
   - TypeScript
   - UltraSPARC
   - USBGuard
+  - vCenter
   - vDisk
   - vHost
   - VMware
diff --git a/.vale/styles/RedHat/PassiveVoice.yml b/.vale/styles/RedHat/PassiveVoice.yml
index 901babbad..67b16afe3 100644
--- a/.vale/styles/RedHat/PassiveVoice.yml
+++ b/.vale/styles/RedHat/PassiveVoice.yml
@@ -184,3 +184,10 @@ tokens:
   - woven
   - written
   - wrung
+exceptions:
+  - deprecated
+  - displayed
+  - imported
+  - supported
+  - tested
+  - trusted
diff --git a/.vale/styles/RedHat/ReadabilityGrade.yml b/.vale/styles/RedHat/ReadabilityGrade.yml
index 32c913b58..a401a67c5 100644
--- a/.vale/styles/RedHat/ReadabilityGrade.yml
+++ b/.vale/styles/RedHat/ReadabilityGrade.yml
@@ -1,12 +1,9 @@
 ---
 extends: readability
-grade: 21
-level: suggestion
+grade: 9
+message: "Simplify your language. The calculated Flesch–Kincaid grade level of %s is above the recommended reading grade level of 9."
 link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/readabilitygrade/
-message: "Grade level ('%s') too high."
+level: suggestion
 metrics:
-  - Automated Readability
-  - Coleman-Liau
   - Flesch-Kincaid
-  - Gunning Fog
-  - SMOG
+
diff --git a/.vale/styles/RedHat/RepeatedWords.yml b/.vale/styles/RedHat/RepeatedWords.yml
index e061198e6..3893d9b45 100644
--- a/.vale/styles/RedHat/RepeatedWords.yml
+++ b/.vale/styles/RedHat/RepeatedWords.yml
@@ -6,7 +6,11 @@ link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference
 ignorecase: false
 alpha: true
 action:
-  name: remove
+  name: edit
+  params:
+    - regex
+    - '(\w+)(\s\w+)' # pattern
+    - "$1" # replace
 tokens:
   - '[^\s\.]+'
   - '[^\s]+'
diff --git a/.vale/styles/RedHat/SimpleWords.yml b/.vale/styles/RedHat/SimpleWords.yml
index 5e5f69ee5..452e7e48b 100644
--- a/.vale/styles/RedHat/SimpleWords.yml
+++ b/.vale/styles/RedHat/SimpleWords.yml
@@ -12,7 +12,6 @@ swap:
   "objective(?! C?)": aim|goal
   absent: none|not here
   abundance: plenty
-  accelerate: speed up
   accentuate: stress
   accompany: go with
   accomplish: carry out|do
diff --git a/.vale/styles/RedHat/Slash.yml b/.vale/styles/RedHat/Slash.yml
index 68115a431..7584c390f 100644
--- a/.vale/styles/RedHat/Slash.yml
+++ b/.vale/styles/RedHat/Slash.yml
@@ -24,3 +24,4 @@ exceptions:
   - "upstream/downstream"
   - "z/OS"
   - "z/OSMF"
+  - "[Kk]ey/value"
diff --git a/.vale/styles/RedHat/Spelling.yml b/.vale/styles/RedHat/Spelling.yml
index f9cfec66c..21547073d 100644
--- a/.vale/styles/RedHat/Spelling.yml
+++ b/.vale/styles/RedHat/Spelling.yml
@@ -3,10 +3,10 @@
 extends: spelling
 level: warning
 link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/spelling/
-message: "Use correct American English spelling. Did you really mean '%s'?"
+message: "Verify the word '%s'. It is not in the American English spelling dictionary used by Vale."
 # A "filter" is a case-sensitive regular expression specifying words to ignore during spell checking.
 # Spelling rule applies to individual words
-# There is no need to add plural forms (s?) to th regex
+# There is no need to add plural forms (s?) to the regex
 filters:
   - "[aA]ccessor"
   - "[aA]llowlist"
@@ -49,7 +49,7 @@ filters:
   - "[dD]ev"
   - "[dD]ev[wW]orkspace"
   - "[dD]evfile"
-  - "[dD]evfiles"
+  - "[dD]istro"
   - "[dD]ownstream"
   - "[dD]ownstreaming"
   - "[eE]xposal"
@@ -60,6 +60,7 @@ filters:
   - "[fF]ailover"
   - "[fF]indability"
   - "[gG]bps"
+  - "[gG]ibibyte"
   - "[gG]it"
   - "[gG]lock"
   - "[gG]radle"
@@ -85,6 +86,7 @@ filters:
   - "[kK]eyrings"
   - "[kK]eyspace"
   - "[kK]eytab"
+  - "[kK]ustomize"
   - "[lL]ibvirt"
   - "[lL]icensor"
   - "[lL]iquibase"
@@ -123,6 +125,7 @@ filters:
   - "[mM]ultizone"
   - "[nN]amespace"
   - "[nN]amespaces"
+  - "[nN]MState"
   - "[nN]onheap"
   - "[nN]oninteractive"
   - "[nN]onpaired"
@@ -216,6 +219,7 @@ filters:
   - "[sS]ysctl"
   - "[sS]yslog"
   - "[sS]ystemd"
+  - "[tT]elco"
   - "[tT]emplated"
   - "[tT]heia"
   - "[tT]olerations"
@@ -493,6 +497,7 @@ filters:
   - USBGuard
   - Vale
   - Valgrind
+  - vCenter
   - vDisk
   - Velero
   - Vert.x
diff --git a/.vale/styles/RedHat/TermsErrors.yml b/.vale/styles/RedHat/TermsErrors.yml
index deaff5967..c16b34ecd 100644
--- a/.vale/styles/RedHat/TermsErrors.yml
+++ b/.vale/styles/RedHat/TermsErrors.yml
@@ -19,6 +19,8 @@ swap:
   "(?<!Mozilla )Thunderbird": Mozilla Thunderbird
   "(?<!pseudo-)ops": operations
   "(?<!self-)hosted engine|hosted-engine": self-hosted engine
+  "bare metal( clusters?| compute| configuration| controls?| environments?| equipment| events?| hardware| hosts?| infrastructure| installations?| installers?| instances?| machines?| media| nodes?| provisioning| servers?| workers?)": bare-metal$1
+  "bare-metal(?! clusters?| compute| configuration| controls?| environments?| equipment| events?| hardware| hosts?| infrastructure| installations?| installers?| instances?| machines?| media| nodes?| provisioning| servers?| workers?)": bare metal
   "[bB]asic [aA]uth": Basic HTTP authentication|Basic authentication
   "a lot(?: of)?": many|much
   "best of breed|best-of-breed": best in class
@@ -34,7 +36,6 @@ swap:
   "top(?:-)?left": upper left|upper right|upper-left|upper-right
   "top(?:-)?right": upper left|upper right|upper-left|upper-right
   "UPI": user-provisioned infrastructure
-  "w/(?!o) ": "with "
   "w/o": without
   '(?<!IBM\s)S\/390|S90|S\s390': IBM S/390
   'backwards?\scompatible': compatible with earlier versions
@@ -142,7 +143,7 @@ swap:
   cyber threat: cyberthreat
   cyberresilience: cyber resilience
   data base: database
-  datacenter|data-center|data centre|datacentre: data center
+  (?<!vCenter )datacenter|data-center|data centre|datacentre: data center
   datafile: data file
   dataflow: data flow
   datamart: data mart
@@ -302,6 +303,7 @@ swap:
   pain point: challenge|concern|difficulty|issue
   parent task: parent process
   parent/child: parent-child
+  peer-pod: peer pod
   passive broker: slave broker
   pathname: path name
   PCOMM: Personal Communications
diff --git a/.vale/styles/RedHat/TermsSuggestions.yml b/.vale/styles/RedHat/TermsSuggestions.yml
index 2d4a3eb40..eb908d7b3 100644
--- a/.vale/styles/RedHat/TermsSuggestions.yml
+++ b/.vale/styles/RedHat/TermsSuggestions.yml
@@ -4,15 +4,13 @@ ignorecase: false
 level: suggestion
 link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termssuggestions/
 message: "Depending on the context, consider using '%s' rather than '%s'."
+scope: sentence
 action:
   name: replace
 swap:
-  "(?<!,| in| on| at| to| for| from| of| with| without| against) which": ", which| that"
+  "(?<!, | in | on | at | to | for | from | of | with | without | against )which": "that|, which"
+  ", that": "that|, which"
   "(?<!.-)jar": compress|archive
-  "(?<![Bb]y |not |are |to |about |[Ww]hen )using": by using|that uses
-  ", that": ", which| that"
-  "[Bb]are metal(?= clusters?| compute| configuration| controls?| environments?| equipment| events?| hardware| hosts?| infrastructure| installations?| installers?| machines?| media| nodes?| provisioning| servers?| workers?)": bare-metal
-  "[Bb]are-metal(?! clusters?| compute| configuration| controls?| environments?| equipment| events?| hardware| hosts?| infrastructure| installations?| installers?| machines?| media| nodes?| provisioning| servers?| workers?)": bare metal
   "[Nn]avigate": click|select|browse|go to
   "bottom(?:-)?left": lower left|lower-left
   "bottom(?:-)?right": lower right|lower-right
@@ -30,11 +28,11 @@ swap:
   bottom left: lower left
   bottom right: lower right
   bugfix: bug fix
-  can not: cannot
   choose: select
   componentization: component-based development|component model|component architecture|shared components
   componentize: develop components|divide into components|re-engineer into reusable software components
   consumes: uses
+  distro: distribution
   drag and drop: drag
   executable(?! program| routine| files?): executable program
   frontend: front end|front-end
diff --git a/.vale/styles/RedHat/TermsWarnings.yml b/.vale/styles/RedHat/TermsWarnings.yml
index 01b79114b..94cdcc4e8 100644
--- a/.vale/styles/RedHat/TermsWarnings.yml
+++ b/.vale/styles/RedHat/TermsWarnings.yml
@@ -12,7 +12,7 @@ swap:
   "bottom(?:-)?left": lower left|lower-left
   "bottom(?:-)?right": lower right|lower-right
   "non-English(?!-language?)": in languages other than English|non-English-language
-  '(?<!.-)like': such as
+  '(?<!.-|acts? |performs? |behaves? |operates? |functions? |reacts? |moves? |looks? |feels? |works? |runs? |advances? |shifts? )like': such as
   '(?<!\/)etc(?!\/)': and so on
   '\b(?:eg)': for example
   '\b(?:ie)': that is
@@ -20,13 +20,16 @@ swap:
   'is updatable|are updatable': can be updated|can be changed
   "(?<!the |the Red Hat )Hybrid Cloud Console|(?<!the )Red Hat Hybrid Cloud Console|(?<!the |Red Hat |Hybrid )Cloud Console|the Cloud Console": the Red Hat Hybrid Cloud Console|the Hybrid Cloud Console
   all caps: uppercase
+  appears: is displayed
   architected: designed
   as well as(?! per): and
   BIOS: firmware
   bottom left: lower left
   bottom right: lower right
   bugfix: bug fix
+  call up: call
   can not: cannot
+  carry on: continue
   carry out: test|run
   click on: click
   deselect: clear
@@ -37,6 +40,7 @@ swap:
   downgrade: upgrade|fallback|fall back|rollback|roll back
   entitlement: repository|subscription
   execute: run|issue|start|enter
+  find out: discover
   hamburger|kebab menu|kebab: more options icon|options icon
   he|she: you
   host name: hostname
@@ -54,11 +58,14 @@ swap:
   opt into|opting into: opt in
   preload: preinstall
   preloaded: preinstalled
+  print out: print
   right double-click: double right-click
   sane: accurate|valid|verified
   shift-click: press Shift and click
   spawn: create
   start up: start
+  speed up: accelerate
+  speeds up: accelerates
   switch on: turn on
   tap on: tap
   tarball: tar file
diff --git a/.vale/styles/RedHat/UserReplacedValues.yml b/.vale/styles/RedHat/UserReplacedValues.yml
index a167bee10..b4aacf515 100644
--- a/.vale/styles/RedHat/UserReplacedValues.yml
+++ b/.vale/styles/RedHat/UserReplacedValues.yml
@@ -1,8 +1,16 @@
 ---
-extends: substitution
-message: "%s."
-link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/userreplacedvalues/
+extends: existence
 level: suggestion
+message: "Separate words by underscores in user-replaced values."
+link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/userreplacedvalues/
 scope: raw
-swap:
-  '__<[a-z_\x60]+-[\x60a-z_-]+>__': Separate words by underscores in user-replaced values
+nonword: true
+action:
+  name: edit
+  params:
+    - regex
+    - "(-)" # pattern
+    - "_" # replace
+tokens:
+  - '__<[a-z_\x60]+-[\x60a-z_-]+>__'
+  - '<[a-z_]+-[a-z_-]+>'
\ No newline at end of file
diff --git a/.vale/styles/RedHat/Using.yml b/.vale/styles/RedHat/Using.yml
new file mode 100644
index 000000000..869cdc9b1
--- /dev/null
+++ b/.vale/styles/RedHat/Using.yml
@@ -0,0 +1,14 @@
+---
+extends: sequence
+message: "Use 'by using' instead of 'using' when it follows a noun for clarity and grammatical correctness."
+link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/using/
+level: warning
+action:
+  name: edit
+  params:
+    - regex
+    - '(\w+)( using)' # pattern
+    - "$1 by using" # replace
+tokens:
+  - tag: NN|NNP|NNPS|NNS
+  - pattern: using