Merge pull request #26 from epics-extensions/move-vale-dir

Move vale dir
epics-extensions · Oct 6, 2023 · e89c3e9 · e89c3e9
2 parents 7c24e24 + a804179
commit e89c3e9
Show file tree

Hide file tree

Showing 175 changed files with 936 additions and 563 deletions.
diff --git a/.vale.ini b/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = doc/vale
+StylesPath = doc/_vale
 MinAlertLevel = suggestion
 
 Vocab = EPNix

diff --git a/doc/vale/Google/AMPM.yml → doc/_vale/Google/AMPM.yml b/doc/vale/Google/AMPM.yml → doc/_vale/Google/AMPM.yml
diff --git a/doc/vale/Google/Acronyms.yml → doc/_vale/Google/Acronyms.yml b/doc/vale/Google/Acronyms.yml → doc/_vale/Google/Acronyms.yml
diff --git a/doc/vale/Google/Colons.yml → doc/_vale/Google/Colons.yml b/doc/vale/Google/Colons.yml → doc/_vale/Google/Colons.yml
diff --git a/doc/vale/Google/Contractions.yml → doc/_vale/Google/Contractions.yml b/doc/vale/Google/Contractions.yml → doc/_vale/Google/Contractions.yml
diff --git a/doc/vale/Google/DateFormat.yml → doc/_vale/Google/DateFormat.yml b/doc/vale/Google/DateFormat.yml → doc/_vale/Google/DateFormat.yml
diff --git a/doc/vale/Google/Ellipses.yml → doc/_vale/Google/Ellipses.yml b/doc/vale/Google/Ellipses.yml → doc/_vale/Google/Ellipses.yml
diff --git a/doc/vale/Google/EmDash.yml → doc/_vale/Google/EmDash.yml b/doc/vale/Google/EmDash.yml → doc/_vale/Google/EmDash.yml
diff --git a/doc/vale/Google/EnDash.yml → doc/_vale/Google/EnDash.yml b/doc/vale/Google/EnDash.yml → doc/_vale/Google/EnDash.yml
diff --git a/doc/vale/Google/Exclamation.yml → doc/_vale/Google/Exclamation.yml b/doc/vale/Google/Exclamation.yml → doc/_vale/Google/Exclamation.yml
diff --git a/doc/vale/Google/FirstPerson.yml → doc/_vale/Google/FirstPerson.yml b/doc/vale/Google/FirstPerson.yml → doc/_vale/Google/FirstPerson.yml
diff --git a/doc/vale/Google/Gender.yml → doc/_vale/Google/Gender.yml b/doc/vale/Google/Gender.yml → doc/_vale/Google/Gender.yml
diff --git a/doc/vale/Google/GenderBias.yml → doc/_vale/Google/GenderBias.yml b/doc/vale/Google/GenderBias.yml → doc/_vale/Google/GenderBias.yml
diff --git a/doc/vale/Google/HeadingPunctuation.yml → doc/_vale/Google/HeadingPunctuation.yml b/doc/vale/Google/HeadingPunctuation.yml → doc/_vale/Google/HeadingPunctuation.yml
diff --git a/doc/vale/Google/Headings.yml → doc/_vale/Google/Headings.yml b/doc/vale/Google/Headings.yml → doc/_vale/Google/Headings.yml
diff --git a/doc/vale/Google/Latin.yml → doc/_vale/Google/Latin.yml b/doc/vale/Google/Latin.yml → doc/_vale/Google/Latin.yml
diff --git a/doc/vale/Google/LyHyphens.yml → doc/_vale/Google/LyHyphens.yml b/doc/vale/Google/LyHyphens.yml → doc/_vale/Google/LyHyphens.yml
diff --git a/doc/vale/Google/OptionalPlurals.yml → doc/_vale/Google/OptionalPlurals.yml b/doc/vale/Google/OptionalPlurals.yml → doc/_vale/Google/OptionalPlurals.yml
diff --git a/doc/vale/Google/Ordinal.yml → doc/_vale/Google/Ordinal.yml b/doc/vale/Google/Ordinal.yml → doc/_vale/Google/Ordinal.yml
diff --git a/doc/vale/Google/OxfordComma.yml → doc/_vale/Google/OxfordComma.yml b/doc/vale/Google/OxfordComma.yml → doc/_vale/Google/OxfordComma.yml
diff --git a/doc/vale/Google/Parens.yml → doc/_vale/Google/Parens.yml b/doc/vale/Google/Parens.yml → doc/_vale/Google/Parens.yml
diff --git a/doc/vale/Google/Passive.yml → doc/_vale/Google/Passive.yml b/doc/vale/Google/Passive.yml → doc/_vale/Google/Passive.yml
diff --git a/doc/vale/Google/Periods.yml → doc/_vale/Google/Periods.yml b/doc/vale/Google/Periods.yml → doc/_vale/Google/Periods.yml
diff --git a/doc/vale/Google/Quotes.yml → doc/_vale/Google/Quotes.yml b/doc/vale/Google/Quotes.yml → doc/_vale/Google/Quotes.yml
diff --git a/doc/vale/Google/Ranges.yml → doc/_vale/Google/Ranges.yml b/doc/vale/Google/Ranges.yml → doc/_vale/Google/Ranges.yml
diff --git a/doc/vale/Google/Semicolons.yml → doc/_vale/Google/Semicolons.yml b/doc/vale/Google/Semicolons.yml → doc/_vale/Google/Semicolons.yml
diff --git a/doc/vale/Google/Slang.yml → doc/_vale/Google/Slang.yml b/doc/vale/Google/Slang.yml → doc/_vale/Google/Slang.yml
diff --git a/doc/vale/Google/Spacing.yml → doc/_vale/Google/Spacing.yml b/doc/vale/Google/Spacing.yml → doc/_vale/Google/Spacing.yml
diff --git a/doc/vale/Google/Spelling.yml → doc/_vale/Google/Spelling.yml b/doc/vale/Google/Spelling.yml → doc/_vale/Google/Spelling.yml
diff --git a/doc/vale/Google/Units.yml → doc/_vale/Google/Units.yml b/doc/vale/Google/Units.yml → doc/_vale/Google/Units.yml
diff --git a/doc/vale/Google/We.yml → doc/_vale/Google/We.yml b/doc/vale/Google/We.yml → doc/_vale/Google/We.yml
diff --git a/doc/vale/Google/Will.yml → doc/_vale/Google/Will.yml b/doc/vale/Google/Will.yml → doc/_vale/Google/Will.yml
diff --git a/doc/vale/Google/WordList.yml → doc/_vale/Google/WordList.yml b/doc/vale/Google/WordList.yml → doc/_vale/Google/WordList.yml
diff --git a/doc/vale/Google/meta.json → doc/_vale/Google/meta.json b/doc/vale/Google/meta.json → doc/_vale/Google/meta.json
diff --git a/doc/vale/Google/vocab.txt → doc/_vale/Google/vocab.txt b/doc/vale/Google/vocab.txt → doc/_vale/Google/vocab.txt
diff --git a/doc/vale/Microsoft/AMPM.yml → doc/_vale/Microsoft/AMPM.yml b/doc/vale/Microsoft/AMPM.yml → doc/_vale/Microsoft/AMPM.yml
diff --git a/doc/vale/Microsoft/Accessibility.yml → doc/_vale/Microsoft/Accessibility.yml b/doc/vale/Microsoft/Accessibility.yml → doc/_vale/Microsoft/Accessibility.yml
diff --git a/doc/vale/Microsoft/Acronyms.yml → doc/_vale/Microsoft/Acronyms.yml b/doc/vale/Microsoft/Acronyms.yml → doc/_vale/Microsoft/Acronyms.yml
diff --git a/doc/vale/Microsoft/Adverbs.yml → doc/_vale/Microsoft/Adverbs.yml b/doc/vale/Microsoft/Adverbs.yml → doc/_vale/Microsoft/Adverbs.yml
diff --git a/doc/vale/Microsoft/Auto.yml → doc/_vale/Microsoft/Auto.yml b/doc/vale/Microsoft/Auto.yml → doc/_vale/Microsoft/Auto.yml
diff --git a/doc/vale/Microsoft/Avoid.yml → doc/_vale/Microsoft/Avoid.yml b/doc/vale/Microsoft/Avoid.yml → doc/_vale/Microsoft/Avoid.yml
diff --git a/doc/vale/Microsoft/ComplexWords.yml → doc/_vale/Microsoft/ComplexWords.yml b/doc/vale/Microsoft/ComplexWords.yml → doc/_vale/Microsoft/ComplexWords.yml
diff --git a/doc/vale/Microsoft/Contractions.yml → doc/_vale/Microsoft/Contractions.yml b/doc/vale/Microsoft/Contractions.yml → doc/_vale/Microsoft/Contractions.yml
diff --git a/doc/vale/Microsoft/Dashes.yml → doc/_vale/Microsoft/Dashes.yml b/doc/vale/Microsoft/Dashes.yml → doc/_vale/Microsoft/Dashes.yml
diff --git a/doc/vale/Microsoft/DateFormat.yml → doc/_vale/Microsoft/DateFormat.yml b/doc/vale/Microsoft/DateFormat.yml → doc/_vale/Microsoft/DateFormat.yml
diff --git a/doc/vale/Microsoft/DateNumbers.yml → doc/_vale/Microsoft/DateNumbers.yml b/doc/vale/Microsoft/DateNumbers.yml → doc/_vale/Microsoft/DateNumbers.yml
diff --git a/doc/vale/Microsoft/DateOrder.yml → doc/_vale/Microsoft/DateOrder.yml b/doc/vale/Microsoft/DateOrder.yml → doc/_vale/Microsoft/DateOrder.yml
diff --git a/doc/vale/Microsoft/Ellipses.yml → doc/_vale/Microsoft/Ellipses.yml b/doc/vale/Microsoft/Ellipses.yml → doc/_vale/Microsoft/Ellipses.yml
diff --git a/doc/vale/Microsoft/FirstPerson.yml → doc/_vale/Microsoft/FirstPerson.yml b/doc/vale/Microsoft/FirstPerson.yml → doc/_vale/Microsoft/FirstPerson.yml
diff --git a/doc/vale/Microsoft/Foreign.yml → doc/_vale/Microsoft/Foreign.yml b/doc/vale/Microsoft/Foreign.yml → doc/_vale/Microsoft/Foreign.yml
diff --git a/doc/vale/Microsoft/Gender.yml → doc/_vale/Microsoft/Gender.yml b/doc/vale/Microsoft/Gender.yml → doc/_vale/Microsoft/Gender.yml
diff --git a/doc/vale/Microsoft/GenderBias.yml → doc/_vale/Microsoft/GenderBias.yml b/doc/vale/Microsoft/GenderBias.yml → doc/_vale/Microsoft/GenderBias.yml
diff --git a/doc/vale/Microsoft/GeneralURL.yml → doc/_vale/Microsoft/GeneralURL.yml b/doc/vale/Microsoft/GeneralURL.yml → doc/_vale/Microsoft/GeneralURL.yml
diff --git a/doc/vale/Microsoft/HeadingAcronyms.yml → doc/_vale/Microsoft/HeadingAcronyms.yml b/doc/vale/Microsoft/HeadingAcronyms.yml → doc/_vale/Microsoft/HeadingAcronyms.yml
diff --git a/doc/vale/Microsoft/HeadingColons.yml → doc/_vale/Microsoft/HeadingColons.yml b/doc/vale/Microsoft/HeadingColons.yml → doc/_vale/Microsoft/HeadingColons.yml
diff --git a/doc/vale/Microsoft/HeadingPunctuation.yml → doc/_vale/Microsoft/HeadingPunctuation.yml b/doc/vale/Microsoft/HeadingPunctuation.yml → doc/_vale/Microsoft/HeadingPunctuation.yml
diff --git a/doc/vale/Microsoft/Headings.yml → doc/_vale/Microsoft/Headings.yml b/doc/vale/Microsoft/Headings.yml → doc/_vale/Microsoft/Headings.yml
diff --git a/doc/vale/Microsoft/Hyphens.yml → doc/_vale/Microsoft/Hyphens.yml b/doc/vale/Microsoft/Hyphens.yml → doc/_vale/Microsoft/Hyphens.yml
diff --git a/doc/vale/Microsoft/Negative.yml → doc/_vale/Microsoft/Negative.yml b/doc/vale/Microsoft/Negative.yml → doc/_vale/Microsoft/Negative.yml
diff --git a/doc/vale/Microsoft/Ordinal.yml → doc/_vale/Microsoft/Ordinal.yml b/doc/vale/Microsoft/Ordinal.yml → doc/_vale/Microsoft/Ordinal.yml
diff --git a/doc/vale/Microsoft/OxfordComma.yml → doc/_vale/Microsoft/OxfordComma.yml b/doc/vale/Microsoft/OxfordComma.yml → doc/_vale/Microsoft/OxfordComma.yml
diff --git a/doc/vale/Microsoft/Passive.yml → doc/_vale/Microsoft/Passive.yml b/doc/vale/Microsoft/Passive.yml → doc/_vale/Microsoft/Passive.yml
diff --git a/doc/vale/Microsoft/Percentages.yml → doc/_vale/Microsoft/Percentages.yml b/doc/vale/Microsoft/Percentages.yml → doc/_vale/Microsoft/Percentages.yml
diff --git a/doc/vale/Microsoft/Quotes.yml → doc/_vale/Microsoft/Quotes.yml b/doc/vale/Microsoft/Quotes.yml → doc/_vale/Microsoft/Quotes.yml
diff --git a/doc/vale/Microsoft/RangeFormat.yml → doc/_vale/Microsoft/RangeFormat.yml b/doc/vale/Microsoft/RangeFormat.yml → doc/_vale/Microsoft/RangeFormat.yml
diff --git a/doc/vale/Microsoft/RangeTime.yml → doc/_vale/Microsoft/RangeTime.yml b/doc/vale/Microsoft/RangeTime.yml → doc/_vale/Microsoft/RangeTime.yml
diff --git a/doc/vale/Microsoft/Ranges.yml → doc/_vale/Microsoft/Ranges.yml b/doc/vale/Microsoft/Ranges.yml → doc/_vale/Microsoft/Ranges.yml
diff --git a/doc/vale/Microsoft/Semicolon.yml → doc/_vale/Microsoft/Semicolon.yml b/doc/vale/Microsoft/Semicolon.yml → doc/_vale/Microsoft/Semicolon.yml
diff --git a/doc/vale/Microsoft/SentenceLength.yml → doc/_vale/Microsoft/SentenceLength.yml b/doc/vale/Microsoft/SentenceLength.yml → doc/_vale/Microsoft/SentenceLength.yml
diff --git a/doc/vale/Microsoft/Spacing.yml → doc/_vale/Microsoft/Spacing.yml b/doc/vale/Microsoft/Spacing.yml → doc/_vale/Microsoft/Spacing.yml
diff --git a/doc/vale/Microsoft/Suspended.yml → doc/_vale/Microsoft/Suspended.yml b/doc/vale/Microsoft/Suspended.yml → doc/_vale/Microsoft/Suspended.yml
diff --git a/doc/vale/Microsoft/Terms.yml → doc/_vale/Microsoft/Terms.yml b/doc/vale/Microsoft/Terms.yml → doc/_vale/Microsoft/Terms.yml
diff --git a/doc/vale/Microsoft/URLFormat.yml → doc/_vale/Microsoft/URLFormat.yml b/doc/vale/Microsoft/URLFormat.yml → doc/_vale/Microsoft/URLFormat.yml
diff --git a/doc/vale/Microsoft/Units.yml → doc/_vale/Microsoft/Units.yml b/doc/vale/Microsoft/Units.yml → doc/_vale/Microsoft/Units.yml
diff --git a/doc/vale/Microsoft/Vocab.yml → doc/_vale/Microsoft/Vocab.yml b/doc/vale/Microsoft/Vocab.yml → doc/_vale/Microsoft/Vocab.yml
diff --git a/doc/vale/Microsoft/We.yml → doc/_vale/Microsoft/We.yml b/doc/vale/Microsoft/We.yml → doc/_vale/Microsoft/We.yml
diff --git a/doc/vale/Microsoft/Wordiness.yml → doc/_vale/Microsoft/Wordiness.yml b/doc/vale/Microsoft/Wordiness.yml → doc/_vale/Microsoft/Wordiness.yml
diff --git a/doc/vale/Microsoft/meta.json → doc/_vale/Microsoft/meta.json b/doc/vale/Microsoft/meta.json → doc/_vale/Microsoft/meta.json
diff --git a/doc/vale/RedHat/Abbreviations.yml → doc/_vale/RedHat/Abbreviations.yml b/doc/vale/RedHat/Abbreviations.yml → doc/_vale/RedHat/Abbreviations.yml
diff --git a/doc/vale/RedHat/CaseSensitiveTerms.yml → doc/_vale/RedHat/CaseSensitiveTerms.yml b/doc/vale/RedHat/CaseSensitiveTerms.yml → doc/_vale/RedHat/CaseSensitiveTerms.yml
@@ -27,6 +27,8 @@ swap:
   "Kernel(?!-based Virtual Machine)": 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
+  "(?<!.-)javadocs?": Javadoc|API documentation|Java API documentation
+  '(?<!\.)IM': instant message
   '(?<!\.)yaml|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
@@ -52,21 +54,26 @@ swap:
   'Red\sHat\sVirtualization\sHypervisor|RHV\sHost|RHV-H': Red Hat Virtualization Host
   'RHVM|RHV-M|RHV\sManager': Red Hat Virtualization Manager
   'self-hosted\sengine\svirtual\smachine|engine\sVM': Manager virtual machine
+  "sub version|(?<!Apache )Subversion": sub-version
+  Ansible playbook: Ansible Playbook
   Appliance Console: Appliance console
   Applix|ApplixWare: Applixware
+  application stream|Application stream: Application Stream
+  Appstream|appstream: AppStream repository
   asciidoctor|AsciiDoctor: Asciidoctor
   asciidoc|Asciidoc: AsciiDoc
   assertj|Assertj: AssertJ
   auto-link|AutoLink: autolink
-  basic authentication|Basic Authentication|basic auth|Basic auth|Basic Auth: Basic HTTP authentication (first instance)|Basic authentication
-  BC: Business Central
+  basic authentication|Basic Authentication|basic auth|Basic auth|Basic Auth: Basic HTTP authentication|Basic authentication
+  "(?<!T-)BC": Business Central
+  Bean: bean
   Bios: BIOS
   blue print|BluePrint: blueprint
   bluestore|Blue Store: BlueStore
   btrfs: Btrfs
   Capex|capex|capEx: CapEx
   Capsule server: Capsule Server
-  CD 1: CD #1
+  CD 1: "CD #1"
   CDS|Cds: CDs
   Ceph Ansible: ceph-ansible
   Ceph block device|Ceph block devices: Ceph Block Device
@@ -125,21 +132,22 @@ swap:
   Gnu|gnu: GNU
   Gpl|gpl: GPL
   Graalvm|graalVM: GraalVM
-  grpc|GRPC: gRPC
   Greenboot|green boots: greenboot
+  grpc|GRPC: gRPC
   Grub: GRUB
   GTK|Gtk|gtk: GTK+
   hot rod|HotRod|hotrod: Hot Rod
   HP Proliant: HP ProLiant
   HTTP interface: management console
   hyperthreading|hyper-threading: Hyper-Threading
   HyperVisor|Hyperviser: hypervisor
+  i-fix|i-Fix|ifix|iFix: interim fix
   IA64|ia64: Itanium
   IBM z Systems: IBM Z
   Ignite|Fuse Ignite: Fuse Online|Red Hat Fuse Online|Syndesis
   ignition config: Ignition config
+  IM: instant message
   Image Builder: image builder
-  Istio Service Mesh : Istio service mesh
   INSTALL_DIR|installDir: FUSE_HOME
   Iops|IOPs: IOPS
   Ip: IP
@@ -148,6 +156,7 @@ swap:
   ipv6|IPV6|Ipv6: IPv6
   iSeries: ISeries
   iso: ISO
+  Istio Service Mesh: Istio service mesh
   Itanium2: Itanium 2
   jar file: JAR file
   Jbang|jbang: JBang
@@ -193,6 +202,7 @@ swap:
   Objective-C: Objective C
   OCP: Red Hat OpenShift Container Platform
   ODF: Red Hat OpenShift Data Foundation
+  OK button|okay|ok: OK
   Open InfiniBand|Infiniband: InfiniBand
   openid connect|Openid Connect: OpenID Connect
   openrewrite|Openrewrite|Open Rewrite: OpenRewrite
@@ -240,6 +250,10 @@ swap:
   RHDS: Red Hat Directory Server
   RHEL host|RHEL-H: Red Hat Enterprise Linux host
   RHV: Red Hat Virtualization
+  rolling application stream: Rolling Application Stream
+  rolling application streams: Rolling Application Streams
+  rolling stream: Rolling Stream
+  rolling streams: Rolling Streams
   Rom|rom: ROM
   rpm: RPM
   s-record|S-Record|s-Record|SREC: S-record
@@ -253,6 +267,7 @@ swap:
   smart NIC|Smart-NIC: SmartNIC
   Smart State|smart state|Smart state|Smartstate|Analysis: SmartState analysis
   socks: SOCKS
+  SoftIRQ: softirq
   software collection|Software collection: Software Collection
   Source Navigator: Source-Navigator^TM^
   Spec: spec
@@ -297,6 +312,7 @@ swap:
   web-UI|webUI: web UI
   Webauthn|webAuthn|WebAuthN: WebAuthn
   websocket|Websocket: WebSocket
+  WiFi|Wifi|wi-fi: Wi-Fi
   Window-Maker|WindowMaker: Window Maker
   Xemacs: XEmacs
   xplat-cli|x-plat-cli|xplat cli|x-plat cli|X-PLAT CLI|X-PLAT-CLI|XPLAT-CLI|XPLAT CLI: Microsoft Azure Cross-Platform Command-Line Interface

diff --git a/doc/vale/RedHat/Conjunctions.yml → doc/_vale/RedHat/Conjunctions.yml b/doc/vale/RedHat/Conjunctions.yml → doc/_vale/RedHat/Conjunctions.yml
diff --git a/doc/vale/RedHat/ConsciousLanguage.yml → doc/_vale/RedHat/ConsciousLanguage.yml b/doc/vale/RedHat/ConsciousLanguage.yml → doc/_vale/RedHat/ConsciousLanguage.yml
@@ -3,12 +3,11 @@ extends: substitution
 ignorecase: true
 level: warning
 link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/consciouslanguage/
-message: Use '%s' rather than '%s.'
-# source: "https://redhat-documentation.github.io/supplementary-style-guide/#conscious-language"
+message: Use %s rather than '%s'.
 action:
   name: replace
 swap:
   blacklist: blocklist
-  whitelist: allowlist
   master(?! broker): primary|source|initiator|requester|controller|host|director|supplier
-  slave(?! broker): secondary|replica|responder|device|worker|proxy|performer|consumer
+  slave(?! broker): secondary|replica|responder|device|worker|proxy|performer|consumer|child
+  whitelist: allowlist
diff --git a/doc/vale/RedHat/Contractions.yml → doc/_vale/RedHat/Contractions.yml b/doc/vale/RedHat/Contractions.yml → doc/_vale/RedHat/Contractions.yml
diff --git a/doc/vale/RedHat/Definitions.yml → doc/_vale/RedHat/Definitions.yml b/doc/vale/RedHat/Definitions.yml → doc/_vale/RedHat/Definitions.yml
diff --git a/doc/_vale/RedHat/DoNotUseTerms.yml b/doc/_vale/RedHat/DoNotUseTerms.yml
@@ -0,0 +1,26 @@
+---
+extends: substitution
+ignorecase: true
+level: warning
+link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/donotuse/
+message: "%s"
+swap:
+  # Start each error message with "Do not use ..."
+  # Error messages must be single quoted.
+  'ACK(?! flag)': 'Do not use "ACK" as acronym for "acknowledgement". When writing about the acknowledgement flag ("ACK flag") in a TCP packet, use "ACK flag".'
+  'future-proof': Do not use "future-proof" in a statement about the benefits, characteristics, or performance of a Red Hat product or service.'
+  'out of the box|out-of-the-box': 'Do not use "out of the box" or "out-of-the-box". Use text that is suitable for the context and the noun to which this adjective applies.'
+  and/or: 'Do not use "and/or". Depending on the context, use one of the following constructions: a and b, a or b, or a, b, or both.'
+  basically: 'Do not use "basically". "Basically" is another term for "in principle" or "fundamentally".'
+  congratulations: 'Do not use "congratulations" in technical information."'
+  debuggable: 'Do not use "debuggable". Rephrase the sentence to use the verb or noun debug. For example, change rebuild the debuggable version to rebuild the version that can be debugged.'
+  foo: 'Do not use "foo". This term is technical jargon in code and as shorthand for fubar, an acronym of profanity in code.'
+  fubar: 'Do not use "fubar". This term is an acronym of a profanity that is sometimes used by developers in code.'
+  kerberize|kerberized: 'Do not use "kerberize" to refer to applications or services that use Kerberos authentication. Refer to such applications as "Kerberos-aware" or "Kerberos-enabled", or rewrite the sentence.'
+  native interface: 'Do not use "native interface" to refer to the command line interface for the JBoss EAP management tool.'
+  overhead: 'Do not use "overhead". Use terminology that is more specific. For example, write "running large queries can increase processor usage".'
+  please: 'Do not use "please" in technical documentation.'
+  quiescent: 'Do not use "quiescent". If a system is, or needs to be inactive, write "inactive". If a system is, or needs to be safe, write "safe".'
+  resides: 'Do not use "resides" if a simpler verb is possible.'
+  respective|respectively: 'Do not use "respective" or "respectively". Rewrite to avoid using these words.'
+  time-tested: 'Do not use "time-tested". Time-tested implies a claim of suitability or reliability.'
diff --git a/doc/vale/RedHat/Ellipses.yml → doc/_vale/RedHat/Ellipses.yml b/doc/vale/RedHat/Ellipses.yml → doc/_vale/RedHat/Ellipses.yml
diff --git a/doc/vale/RedHat/HeadingPunctuation.yml → doc/_vale/RedHat/HeadingPunctuation.yml b/doc/vale/RedHat/HeadingPunctuation.yml → doc/_vale/RedHat/HeadingPunctuation.yml
diff --git a/doc/vale/RedHat/Headings.yml → doc/_vale/RedHat/Headings.yml b/doc/vale/RedHat/Headings.yml → doc/_vale/RedHat/Headings.yml
diff --git a/doc/_vale/RedHat/Hyphens.yml b/doc/_vale/RedHat/Hyphens.yml
@@ -0,0 +1,230 @@
+---
+extends: substitution
+ignorecase: true
+level: warning
+link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/hyphens/
+message: Use %s rather than '%s'.
+action:
+  name: replace
+# swap maps tokens in the form "bad: good"
+swap:
+  '(?<!.-)addon': add-on
+  'broad cast|broad-cast': broadcast
+  'call out|call-out': callout
+  'comma delimited|commadelimited': comma-delimited
+  'command driven|commanddriven': command-driven
+  'meta-data|meta data': metadata
+  'open-source|OpenSource|opensource': open source
+  'over-ride|over ride': override
+  'plug-ins|plug ins': plugins
+  'plug-in|plug in': plugin
+  'super-user|super user': superuser
+  'timeframe|time-frame': time frame
+  'up-grade|up grade': upgrade
+  'up-selling|up selling': upselling
+  'up-stream|up stream': upstream
+  'up-time|up time': uptime
+  ad-hoc: ad hoc
+  auto-configure: autoconfigure
+  auto-generated: autogenerate
+  auto-install: autoinstall
+  auto-number: autonumber
+  back-up: backup
+  bench-mark: benchmark
+  bi-annual: biannual
+  bi-directional: bidirectional
+  bi-monthly: bimonthly
+  bi-weekly: biweekly
+  bilevel: bi-level
+  check-out: checkout
+  checkin: check-in
+  client-server: client/server
+  cloud-bursting: cloudbursting
+  cloud-washing: cloudwashing
+  co-author: coauthor
+  co-existence: coexistence
+  co-locate|collocate: colocate
+  co-location: colocation
+  co-operate: cooperate
+  co-ordinate: coordinate
+  co-requisite: corequisite
+  co-worker: coworker
+  comma separated: comma-separated
+  command-language: command language
+  container based: container-based
+  counter-clockwise: counterclockwise
+  counter-measures: countermeasures
+  cross reference: cross-reference
+  cross site scripting: cross-site scripting
+  crossplatform|cross platform: cross-platform
+  cyber-attack: cyberattack
+  cyber-crime: cybercrime
+  cyber-security: cybersecurity
+  cyber-space: cyberspace
+  daisy-chain|daisychain: daisy chain
+  de-bias: debias
+  de-bug: debug
+  desk top|desk-top: desktop
+  disklabel|disk-label: disk label
+  domainname|domain-name: domain name
+  dotted-decimal: dotted decimal
+  double byte: double-byte
+  double click: double-click
+  double-click on: double-click
+  double-word: doubleword
+  down-load|down load: download
+  down-stream|down stream: downstream
+  e-book: ebook
+  e-mail: email
+  extra-linguistic: extralinguistic
+  extra-partition: extrapartition
+  firm ware|firm-ware: firmware
+  floating-point: floating point
+  fly-out: flyout
+  fore-ground|forground: foreground
+  frontend: front end|front-end
+  gray-scale|gray scale: grayscale
+  helpdesk|help-desk: help desk
+  hot-line: hotline
+  hotadd|hot-add: hot add
+  hotplug|hot-plug: hot plug
+  hotswap|hot-swap: hot swap
+  hyper-active: hyperactive
+  hyper-converged: hyperconverged
+  hyper-sensitive: hypersensitive
+  in line|in-line: inline
+  infra-red: infrared
+  infra-structure: infrastructure
+  inter-active: interactive
+  inter-cept: intercept
+  inter-related: interrelated
+  intra-node: intranode
+  intra-partition: intrapartition
+  intra-record: intrarecord
+  intra-system: intrasystem
+  load-balance: load balance
+  load-balancing: load balancing
+  macro-instruction: macroinstruction
+  macro-structure: macrostructure
+  meta-class: metaclass
+  meta-file: metafile
+  meta-table: metatable
+  micro-chip: microchip
+  micro-circuit: microcircuit
+  micro-code: microcode
+  mid-day: midday
+  mid-term: midterm
+  mid-year: midyear
+  mini-computer: minicomputer
+  mini-course: minicourse
+  mini-disk: minidisk
+  mouse-button|mousebutton: mouse button
+  multi site|multi-site: multisite
+  multi-channel: multichannel
+  multi-cloud: multicloud
+  multi-factor: multifactor
+  multi-media: multimedia
+  multi-path: multipath
+  multi-plexer: multiplexer
+  multi-point: multipoint
+  multi-processing: multiprocessing
+  multi-processor: multiprocessor
+  multi-schema: multischema
+  multi-table: multitable
+  multi-tenant: multitenant
+  multi-tier: multitiered
+  multi-tiered: multitiered
+  multi-vendor: multivendor
+  multicore: multi-core
+  multiinstance: multi-instance
+  new-line: newline
+  non-compliant: noncompliant
+  non-contiguous: noncontiguous
+  non-heap: nonheap
+  non-interactive: noninteractive
+  non-linear: nonlinear
+  non-negotiable: nonnegotiable
+  non-paired: nonpaired
+  non-system: nonsystem
+  non-zero: nonzero
+  nonnative: non-native
+  off-boarding: offboarding
+  off-load: offload
+  omni-channel: omnichannel
+  on-boarding: onboarding
+  on-line: online
+  op-code: opcode
+  over-lay: overlay
+  over-ride: override
+  over-strike: overstrike
+  post-editing: postediting
+  post-installation: postinstallation
+  post-mortem: postmortem
+  post-operation: postoperation
+  post-requisite: postrequisite
+  power down: turn off|power off
+  power up: power on|turn on
+  poweroff: power-off
+  pre-apply: preapply
+  pre-assembled: preassembled
+  pre-cache: precache
+  pre-compile: precompile
+  pre-defined: predefined
+  pre-enrollment: preenrollment
+  pre-establish: preestablish
+  pre-formatted: preformatted
+  pre-installation: preinstallation
+  pre-operational: preoperational
+  pre-process: preprocess
+  pre-processor: preprocessor
+  pre-runtime: preruntime
+  pseudo code|pseudo-code: pseudocode
+  pseudo ops|pseudoops: pseudo-ops
+  pseudo-code: pseudocode
+  pseudo-random: pseudorandom
+  pseudo-text: pseudotext
+  pulldown|pull down: pull-down
+  re-direct: redirect
+  re-edit: reedit
+  re-examine: reexamine
+  re-synchronize: resynchronize
+  recreate: re-create
+  reenable: re-enable
+  remote-access: remote access
+  run level|run-level: runlevel
+  run-time: run time|runtime
+  semi-colon: semicolon
+  semi-conductor: semiconductor
+  serverside: server-side|server side
+  set-up: setup
+  soundcard|sound-card: sound card
+  stand-alone: standalone
+  straight forward|straight-forward: straightforward
+  sub-address: subaddress
+  sub-area: subarea
+  sub-capacity: subcapacity
+  sub-class: subclass
+  sub-command: subcommand
+  sub-directory: subdirectory
+  sub-menu: submenu
+  sub-net: subnet
+  sub-network: subnetwork
+  sub-package: subpackage
+  sub-tab: subtab
+  super-class: superclass
+  super-object: superobject
+  super-script: superscript
+  text based: text-based
+  textmode|text-mode: text mode
+  time-out: timeout|time out
+  trade-off|trade off: tradeoff
+  un-available: unavailable
+  un-committed: uncommitted
+  un-formatted: unformatted
+  un-install: uninstall
+  un-ordered: unordered
+  under-lying: underlying
+  under-run: underrun
+  under-used: underused
+  up-sell: upsell
+  video-mode|videomode: video mode
diff --git a/doc/vale/RedHat/OxfordComma.yml → doc/_vale/RedHat/OxfordComma.yml b/doc/vale/RedHat/OxfordComma.yml → doc/_vale/RedHat/OxfordComma.yml
diff --git a/doc/vale/RedHat/PascalCamelCase.yml → doc/_vale/RedHat/PascalCamelCase.yml b/doc/vale/RedHat/PascalCamelCase.yml → doc/_vale/RedHat/PascalCamelCase.yml
diff --git a/doc/vale/RedHat/PassiveVoice.yml → doc/_vale/RedHat/PassiveVoice.yml b/doc/vale/RedHat/PassiveVoice.yml → doc/_vale/RedHat/PassiveVoice.yml
diff --git a/doc/vale/RedHat/README-IBM.adoc → doc/_vale/RedHat/README-IBM.adoc b/doc/vale/RedHat/README-IBM.adoc → doc/_vale/RedHat/README-IBM.adoc
diff --git a/doc/vale/RedHat/README-proselint.md → doc/_vale/RedHat/README-proselint.md b/doc/vale/RedHat/README-proselint.md → doc/_vale/RedHat/README-proselint.md
diff --git a/doc/vale/RedHat/README-write-good.md → doc/_vale/RedHat/README-write-good.md b/doc/vale/RedHat/README-write-good.md → doc/_vale/RedHat/README-write-good.md
diff --git a/doc/vale/RedHat/ReadabilityGrade.yml → doc/_vale/RedHat/ReadabilityGrade.yml b/doc/vale/RedHat/ReadabilityGrade.yml → doc/_vale/RedHat/ReadabilityGrade.yml
diff --git a/doc/vale/RedHat/ReleaseNotes.yml → doc/_vale/RedHat/ReleaseNotes.yml b/doc/vale/RedHat/ReleaseNotes.yml → doc/_vale/RedHat/ReleaseNotes.yml
diff --git a/doc/vale/RedHat/RepeatedWords.yml → doc/_vale/RedHat/RepeatedWords.yml b/doc/vale/RedHat/RepeatedWords.yml → doc/_vale/RedHat/RepeatedWords.yml
diff --git a/doc/vale/RedHat/SelfReferentialText.yml → doc/_vale/RedHat/SelfReferentialText.yml b/doc/vale/RedHat/SelfReferentialText.yml → doc/_vale/RedHat/SelfReferentialText.yml
diff --git a/doc/vale/RedHat/SentenceLength.yml → doc/_vale/RedHat/SentenceLength.yml b/doc/vale/RedHat/SentenceLength.yml → doc/_vale/RedHat/SentenceLength.yml