Vale POS rule For noun + using

Author: aireilly

.github/workflows/preview-build.yml

@@ -20,7 +20,6 @@ jobs:
   preview-build:
     name: Preview build
     runs-on: ubuntu-latest
-    container: quay.io/antoraformodulardocs/antora-for-modular-docs:main
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -45,6 +44,13 @@ jobs:
         with:
           path: .cache
           key: ${{ steps.get-date.outputs.yearweek }}
+      - name: Install Vale
+        run: |
+          sudo gem install asciidoctor
+          curl -s https://api.github.com/repos/errata-ai/vale/releases/latest | grep "browser_download_url.*Linux_64-bit.tar.gz" | cut -d : -f 2,3 | tr -d \" | wget -qi -
+          mkdir bin && tar -xvzf *Linux_64-bit.tar.gz -C bin
+          export PATH=./bin:"$PATH"
+          vale -v
       - name: Build
         run: tools/publication-builder.sh
       - name: Store pull request details for preview-publish
@@ -64,4 +70,4 @@ jobs:
         run: htmltest
       - name: Validate language changes
         run: |
-          tools/validate-language-changes.sh
+          tools/validate-language-changes.sh

.github/workflows/publication-builder.yml

@@ -15,7 +15,7 @@ jobs:
   publication-builder:
     name: Build and publish to publication branch
     runs-on: ubuntu-latest
-    container: quay.io/antoraformodulardocs/antora-for-modular-docs:main
+    container: container: quay.io/antoraformodulardocs/antora-for-modular-docs:main
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

.github/workflows/validate-rules.yml

@@ -21,9 +21,9 @@ jobs:
       - name: Install Vale and validate rules
         run: |
           sudo gem install asciidoctor
-          wget https://github.com/errata-ai/vale/releases/download/v2.30.0/vale_2.30.0_Linux_64-bit.tar.gz
+          curl -s https://api.github.com/repos/errata-ai/vale/releases/latest | grep "browser_download_url.*Linux_64-bit.tar.gz" | cut -d : -f 2,3 | tr -d \" | wget -qi -
           mkdir bin && tar -xvzf *Linux_64-bit.tar.gz -C bin
           export PATH=./bin:"$PATH"
           vale -v
           chmod +x tools/validate-vale-rules.sh
-          ./tools/validate-vale-rules.sh
+          ./tools/validate-vale-rules.sh

.github/workflows/web-ide-link.yml

@@ -23,8 +23,6 @@ Hybrid Cloud Console
 //vale-fixture
 IBM Cloud
 //vale-fixture
-IBM Cloud Bare Metal
-//vale-fixture
 IBM LinuxONE
 //vale-fixture
 IBM Power
@@ -177,4 +175,4 @@ CAPV
 //vale-fixture
 CAPX
 //vale-fixture
-CAPZ
+CAPZ

.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testinvalid.adoc

@@ -499,9 +499,6 @@ UNIX-like
 uri
 url
 urn
-Use the .NET Core framework
-Use the .Net Core framework
-Use the .Net framework
 User Portal
 var
 VCPU

.vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc

@@ -30,6 +30,25 @@ back slash
 backside
 backwards compatible
 barcode
+bare metal clusters
+bare metal compute
+bare metal configuration
+bare metal control
+bare metal environment
+bare metal equipment
+bare metal event
+bare metal hardware
+bare metal host
+bare metal infrastructure
+bare metal installation
+bare metal installer
+bare metal machine
+bare metal media
+bare metal node
+bare metal provisioning
+bare metal server
+bare metal worker
+Install on bare-metal.
 best of breed
 Bidi
 Big Blue
@@ -388,7 +407,6 @@ TCP/IP network
 teleprocessing line
 testcase
 the installer
-There are many ways to write, for instance, using a pencil.
 thin provisioned
 third-party software vendor
 thru
@@ -443,7 +461,6 @@ virtual diskette drive
 virtual DOS machine
 virtual hard disk
 virtual hard disk
-w/ this
 w/o
 wait condition
 war room

.vale/fixtures/RedHat/TermsErrors/testinvalid.adoc

@@ -49,6 +49,24 @@ back
 backslash
 backup
 bar code
+bare-metal clusters
+bare-metal compute
+bare-metal configuration
+bare-metal control
+bare-metal environment
+bare-metal equipment
+bare-metal event
+bare-metal hardware
+bare-metal host
+bare-metal infrastructure
+bare-metal installation
+bare-metal installer
+bare-metal machine
+bare-metal media
+bare-metal node
+bare-metal provisioning
+bare-metal server
+bare-metal worker
 bean
 benchmark
 best in class

.vale/fixtures/RedHat/TermsErrors/testvalid.adoc

@@ -1,24 +1,6 @@
 above
 afterwards
 all caps
-bare metal clusters
-bare metal compute
-bare metal configuration
-bare metal control
-bare metal environment
-bare metal equipment
-bare metal event
-bare metal hardware
-bare metal host
-bare metal infrastructure
-bare metal installation
-bare metal installer
-bare metal machine
-bare metal media
-bare metal node
-bare metal provisioning
-bare metal server
-bare metal worker
 below
 bottom left
 bottom right
@@ -48,7 +30,6 @@ segfault
 shell
 spawn
 start up
-Start using this.
 tar
 tar file
 tarball

.vale/fixtures/RedHat/TermsSuggestions/testinvalid.adoc

@@ -3,27 +3,8 @@ about using
 after
 are not using
 are using
-bare-metal clusters
-bare-metal compute
-bare-metal configuration
-bare-metal control
-bare-metal environment
-bare-metal equipment
-bare-metal event
-bare-metal hardware
-bare-metal host
-bare-metal infrastructure
-bare-metal installation
-bare-metal installer
-bare-metal machine
-bare-metal media
-bare-metal node
-bare-metal provisioning
-bare-metal server
-bare-metal worker
 before
-By using
-by using
+by
 earlier
 following
 from

.vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc

@@ -1,5 +1,9 @@
-This is __<a-user-replaced-value>__ with hyphens.
-This is __<a-user-replaced_value>__ with hyphens and underscores.
-This is __<a_user-replaced-value>__ with hyphens and undersores.
-This is __<a_user-replaced_value>__ with hyphens and underscores.
-This is __<a_user-`replaced`_value>__ with hyphens and monospaced.
+* `<user-replaced-value>` with hyphens in backticks
+* <user-replaced_value> with hyphens and underscores
+* <user-replaced-value> with hyphens and undersores
+* <user-replaced_value> with hyphens and underscores
+* __<a-user-replaced-value>__ with hyphens
+* __<a-user-replaced_value>__ with hyphens and underscores
+* __<a_user-replaced-value>__ with hyphens and undersores
+* __<a_user-replaced_value>__ with hyphens and underscores
+* __<a_user-`replaced`_value>__ with hyphens and monospaced

.vale/fixtures/RedHat/UserReplacedValues/testinvalid.adoc

@@ -0,0 +1,5 @@
+; Vale configuration file to test the `Using` rule
+StylesPath = ../../../styles
+MinAlertLevel = suggestion
+[*.adoc]
+RedHat.Using = YES

.vale/fixtures/RedHat/Using/.vale.ini

@@ -0,0 +1 @@
+We improved the system using new algorithms.

.vale/fixtures/RedHat/Using/testinvalid.adoc

@@ -0,0 +1,6 @@
+If you are using the ElasticSearch log store do nothing.
+The application crashes when not using the recommended API.
+Developers are using the latest version of the framework.
+Switching to using cloud storage improved our backup efficiency.
+The documentation provides guidelines about using third-party libraries.
+Users experience faster load times when using the optimized query.

.vale/fixtures/RedHat/Using/testvalid.adoc

@@ -32,7 +32,7 @@ swap:
   '(?<!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
+  '\s\.Net Core|\s\.Net|\s\.NET\sCore|dotNet': \s.NET
   'A-MQ(?!\sBroker|\sClient|\sConsole|\sInterconnect)': AMQ
   'A-MQ\sBroker': AMQ Broker
   'A-MQ\sClients': AMQ Clients

.vale/styles/RedHat/CaseSensitiveTerms.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]+'

.vale/styles/RedHat/RepeatedWords.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?| machines?| media| nodes?| provisioning| servers?| workers?)": bare-metal $1
+  "bare-metal(?! clusters?| compute| configuration| controls?| environments?| equipment| events?| hardware| hosts?| infrastructure| installations?| installers?| 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

.vale/styles/RedHat/TermsErrors.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"
-  "(?<!.-)jar": compress|archive
-  "(?<![Bb]y |not |are |to |about |[Ww]hen )using": by using|that uses
+  "(?<!, | in | on | at | to | for | from | of | with | without | against )which": "that"
   ", 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
+  "(?<!.-)jar": compress|archive
   "[Nn]avigate": click|select|browse|go to
   "bottom(?:-)?left": lower left|lower-left
   "bottom(?:-)?right": lower right|lower-right

.vale/styles/RedHat/TermsSuggestions.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_-]+>'

.vale/styles/RedHat/UserReplacedValues.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

.vale/styles/RedHat/Using.yml

@@ -0,0 +1,11 @@
+:navtitle: using
+:keywords: reference, rule, by using
+= By using
+
+Do not omit articles and prepositions that can increase the clarity of a sentence.
+
+.Additional resources
+
+* link:{ibmsg-url-print}[{ibmsg-print} - Grammar, p. 239]
+* link:{ibmsg-url}?topic=medium-global-audiences#grammar[{ibmsg} - Grammar]
+* link:{repository-url}blob/main/.vale/styles/RedHat/Using.yml[`Using.yml` source code]