docs/site-frontpage
20
1
Fork 4
Code Issues 9 Pull requests 1 Projects Activity Actions

add Vale linter

Browse source
This commit is contained in:
Alix Andrieu 2022-12-10 11:55:03 +01:00
commit 3ff7f05e0a
Signed by: darknao
SSH key fingerprint: SHA256:q7483bAR4lkMVcMuIji2IBQ6aLmEEDSHpz5V3uN0pBE
31 changed files with 2014 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
.gitlab-ci.yml
View file

@ -27,3 +27,21 @@ pages:
rules:
- if: $CI_COMMIT_BRANCH == "main" && $CI_PROJECT_ROOT_NAMESPACE == "fedora"
code_quality:
image:
name: jdkato/vale:latest
entrypoint: [""]
tags: [shared]
variables:
VARH_REPO: "redhat-documentation/vale-at-red-hat"
VARH_BRANCH: "main"
before_script:
- apk add --no-cache curl asciidoctor python3
- |
curl -o vale2cc.py \
https://raw.githubusercontent.com/${VARH_REPO}/${VARH_BRANCH}/tools/vale2cc.py
script:
- vale --no-exit --output=JSON . | python3 vale2cc.py > gl-code-quality-report.json
artifacts:
reports:
codequality: gl-code-quality-report.json

71
.vale.ini Normal file
View file

@ -0,0 +1,71 @@
# Vale configuration file for the https://github.com/redhat-documentation/vale-at-red-hat repository.
# See: https://docs.errata.ai/vale/config
# Core settings appear at the top (the "global" section).
# The relative path to the folder containing linting rules (styles).
StylesPath = .vale/styles
# Optional: Use the `Vocab` parameter to define exceptions to the ruleset specified for `BasedOnStyles`.
# For more information about how to use the `Vocab` feature of vale, see: https://docs.errata.ai/vale/vocab
# Minimum alert level
# -------------------
# The minimum alert level in the output (suggestion, warning, or error).
# If integrated into CI, builds fail by default on error-level alerts, unless you run Vale with the --no-exit flag
MinAlertLevel = suggestion
# IgnoredScopes specifies inline-level HTML tags to ignore.
# These tags may occur in an active scope (unlike SkippedScopes, skipped entirely) but their content still will not raise any alerts.
# Default: ignore `code` and `tt`.
IgnoredScopes = code, tt, img, url, a, body.id
# SkippedScopes specifies block-level HTML tags to ignore. Ignore any content in these scopes.
# Default: ignore `script`, `style`, `pre`, and `figure`.
# For AsciiDoc: by default, listingblock, and literalblock.
SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock
[formats]
# Associate `*.properties` files with the `md` format
properties = md
# Match AsciiDoc files. See: https://docs.errata.ai/vale/scoping
# Ignore files in a directory starting by `.`
# to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
[[!.]*.adoc]
# Styles to load, located in the `StylesPath` folder:
BasedOnStyles = RedHat
; Ignore attributes definition, id statements
TokenIgnores = (:[^\n]+: [^\n]+), (\[id=[^\n]+)
; RedHat.BareMetal = NO
# Match Markdown files. See: https://docs.errata.ai/vale/scoping
# Match also `*.properties` files (see the `format` section).
[*.md]
# Styles to load, located in the `StylesPath` folder:
BasedOnStyles = RedHat
# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)
# Match Restructured text files
[*.rst]
# Styles to load, located in the `StylesPath` folder:
BasedOnStyles = RedHat
# Match INI files. See: https://docs.errata.ai/vale/scoping
[*.ini]
# Styles to load, located in the `StylesPath` folder:
BasedOnStyles = RedHat
# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)
# Disabling rules (NO)
RedHat.CaseSensitiveTerms = NO
RedHat.ConfigMap = NO
RedHat.Definitions = NO
RedHat.Slash = NO
RedHat.Spacing = NO
RedHat.Spelling = NO
RedHat.TermsSuggestions = NO

9
.vale/styles/RedHat/Abbreviations.yml Normal file
View file

@ -0,0 +1,9 @@
---
extends: existence
level: error
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/abbreviations/
message: "Do not use periods in all-uppercase abbreviations such as '%s'."
nonword: true
source: "IBM - Periods with abbreviations, p. 5"
tokens:
- '\b(?:[A-Z]\.){3,5}'

153
.vale/styles/RedHat/CaseSensitiveTerms.yml Normal file
View file

@ -0,0 +1,153 @@
---
extends: substitution
ignorecase: false
level: error
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/casesensitiveterms/
message: Use '%s' rather than '%s'.
source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions"
action:
name: replace
swap:
asciidoc|Asciidoc: AsciiDoc
asciidoctor|AsciiDoctor: Asciidoctor
'[nN]odejs|[nN]ode\.JS|node\.js': Node.js
# Bind: BIND
Bios: BIOS
btrfs: Btrfs
Capex|capex|capEx: CapEx
CD 1: CD #1
CDS|Cds: CDs
CGroup|c group: cgroup
configmap: config map
configuration map: config map
classic mode: GNOME Classic
control key|ctrl: Ctrl
csv: CSV
CygMon|cygmon|CYGMON: Cygmon
Denial of Service: denial of service
Denial-of-Service: denial-of-service
devops|Devops|Dev-Ops|Dev Ops: DevOps
Disk druid|disk druid|diskdruid: Disk Druid
dns: DNS
DVD burner|burner: DVD writer
Exec Shield: Exec-Shield
EXIF|exif: Exif
Faq|faq|F.A.Q: FAQ
fedora project: Fedora™ Project
fortran: Fortran
Fqdn|fqdn: FQDN
gb|Gb: GB
gbps|GBPS: Gbps
GDBTK: Insight
gid|Gid: GID
Gimp|gimp: GIMP
git|GIT: Git
Gnome|gnome: GNOME
Gnu|gnu: GNU
Gpl|gpl: GPL
Graalvm|graalVM: GraalVM
Grub: GRUB
GTK|Gtk|gtk: GTK+
HP Proliant: HP ProLiant
hyperthreading|hyper-threading: Hyper-Threading
HyperVisor|Hyperviser: hypervisor
IA64|ia64: Itanium
IBM z Systems: IBM Z
ignition config: Ignition config
Iops|IOPs: IOPS
Ip: IP
IPSec: IPsec
iSeries: ISeries
iso image: ISO image
iso: ISO
Itanium2: Itanium 2
JBoss.org: JBoss Community
jetbrains|Jetbrains: JetBrains
Junit|junit: JUnit
Jvm|jvm: JVM
kernel-based virtual machine: Kernel-based Virtual Machine
kickstart: Kickstart
kvm: KVM
Lan|lan: LAN
LINUX|linux: Linux
Microprofile|micro-profile: MicroProfile
Mongo\sDB|mongoDB|Mongodb|Mongo-db: MongoDB
MS-dos|Ms-Dos|ms-dos|MSDOS|msdos: MS-DOS
MS(?!-DOS?)|MSFT|MicroSoft: Microsoft
mutual tls|Mutual tls|Mutual TLS: mutual TLS
MYSQL|mySQL: MySQL
Objective-C: Objective C
openid connect|Openid Connect: OpenID Connect
Open InfiniBand|Infiniband: InfiniBand
Operating Environment: operating environment
Operator Hub|Operator hub|Operatorhub|operatorhub: OperatorHub
Opex|Opex|OPEX|opEx: OpEx
OS|Operating System: operating system
podman: Podman
popup|Pop-up: pop-up
Posix|posix: POSIX
Postscript: PostScript
PPC|P-PC|PPC64: PowerPC
Ppp|ppp: PPP
prom|Prom: PROM
proof key for code exchange: Proof Key for Code Exchange
pSeries: IBM eServer System p
q & a|q&a|Q & A|Q&A: Q and A
qcow2|Qcow2: QCOW2
Qeth|QETH: qeth
Ram|ram: RAM
RAMdisk|ramdisk|RAM-disk: RAM disk
RAW: raw
Red Hat Proxy: Red Hat Network Proxy Server
Red Hat satellite: Red Hat Satellite
Red Hat Satellite server: Red Hat Satellite Server
Red Hat Satellite Capsule server: Red Hat Satellite Capsule Server
Red Hat Network Satellite server: Red Hat Network Satellite Server
Redboot|Red Boot: RedBoot
RESTEASY|resteasy|Resteasy: RESTEasy
Rom|rom: ROM
rpm: RPM
s-record|S-Record|s-Record|SREC: S-record
S90: IBM S 390
samba|SAMBA: Samba
SE-Linux|S-E Linux|SE Linux|selinux: SELinux
Shadow Man|ShadowMan: Shadowman
Shadow passwords: shadow passwords
Shadow utilities: shadow utilities
Smallrye: SmallRye
socks: SOCKS
software collection|Software collection: Software Collection
Spring boot: Spring Boot
SR IOV: SR-IOV
Ssh|ssh: SSH
SSL(?!/TLS): SSL/TLS
Staroffice|Star Office: StarOffice
StartX: startx
SU: su
Sys V|System V: SysV
system D|system D|SystemD|system d: systemd
Tolapai|Intel Tolapai: Intel(R) EP80579 Integrated Processor
ttl: TTL
uid: UID
ULTRASPARC|UltraSparc: UltraSPARC
Unix|unix|UNIX-like: UNIX
url: URL
"(?<!/)var": VAR
VI: vi
VIM|vim: Vim
Virtual Desktop Server Management: VDSM
virtual-console|Virtual Console: virtual console
vlan|vLAN: VLAN
vnic|VNIC|Virtual Network Interface Card: vNIC
vnuma|VNUMA: vNUMA node
vpn: VPN
VS Code|VSCode|VisualStudioCode|VisualStudio Code: Visual Studio Code
VT-i|VT: Intel Virtualization Technology
wan: WAN
wca: WCA
web-UI|webUI: web UI
Webauthn|webAuthn|WebAuthN: WebAuthn
Window-Maker|WindowMaker: Window Maker
Xemacs: XEmacs
Xterm: xterm
'(?<!\.)yaml|Yaml': YAML

14
.vale/styles/RedHat/Conjunctions.yml Normal file
View file

@ -0,0 +1,14 @@
---
extends: existence
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/conjunctions/
message: "Do not overuse beginning sentences with '%s'."
scope: paragraph
source: https://github.com/redhat-documentation/vale-at-red-hat/tree/main/.vale/styles/RedHat/Conjunctions.yml
action:
name: remove
tokens:
- ^And
- ^But
- ^Or
- ^So

14
.vale/styles/RedHat/ConsciousLanguage.yml Normal file
View file

@ -0,0 +1,14 @@
---
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"
action:
name: replace
swap:
blacklist: blocklist
whitelist: allowlist
master: primary|source|initiator|requester|controller|host|director
slave: secondary|replica|responder|device|worker|proxy|performer

44
.vale/styles/RedHat/Contractions.yml Normal file
View file

@ -0,0 +1,44 @@
---
extends: substitution
ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/contractions/
message: "Avoid contractions. Use '%s' rather than '%s.'"
source: "https://redhat-documentation.github.io/supplementary-style-guide/#contractions"
action:
name: replace
swap:
"aren't": is not
"can't": cannot
"couldn't": could not
"didn't": did not
"doesn't": does not
"don't": do not
"hasn't": has not
"haven't": have not
"how'll": how will
"how's": how is
"isn't": is not
"it'll": it will
"it's": it is
"shouldn't": should not
"that'll": that will
"that's": that is
"they'll": they will
"they're": they are
"wasn't": was not
"we'll": we will
"we're": we are
"we've": we have
"weren't": were not
"what'll": what will
"what's": what is
"when'll": when will
"when's": when is
"where'll": where will
"where's": where is
"who'll": who will
"who's": who is
"why'll": why will
"why's": why is
"won't": will not

168
.vale/styles/RedHat/Definitions.yml Normal file
View file

@ -0,0 +1,168 @@
---
extends: conditional
ignorecase: false
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/definitions/
message: "Define acronyms and abbreviations (such as '%s') on first occurrence if they're likely to be unfamiliar."
source: "IBM - Abbreviations, p. 1"
# Ensures that the existence of 'first' implies the existence of 'second'.
first: '\b([A-Z]{3,5}s?)\b'
second: '\(([A-Z]{3,5}s?)\)'
# ... with the exception of these:
exceptions:
- 'CPUs?'
- 'CVEs?'
- 'DVDs?'
- 'NULL'
- 'GIDs?'
- 'PIDs?'
- 'ROMs?'
- 'RPMs?'
- 'UIDs?'
- 'URIs?'
- 'URLs?'
- ACPI
- AIX
- API
- ARM
- ASCII
- ASP
- BIND
- BIOS
- CD
- CLI
- CSS
- CSV
- CUPS
- DEBUG
- DHCP
- DNF
- DNS
- DOM
- DOS
- DPI
- DRL
- DSL
- EIP
- ERROR
- FAQ
- FQDN
- FTP
- GAS
- GB
- GCC
- GCJ
- GDB
- GET
- GIMP
- GNOME
- GNU
- GNUPro
- GPL
- GPU
- GRUB
- GTK+
- GUI
- HP
- HTML
- HTTP
- HTTPS
- IBM
- IDE
- IOPS
- IOV
- IP
- ISO
- IT
- JAR
- JSON
- JSX
- JVM
- KB
- KIE
- KVM
- LAN
- LDAP
- LESS
- LLDB
- LPAR
- LUKS
- LVM
- MAC
- MB
- MBR
- MDS
- mTLS
- NAT
- NET
- NFS
- NGINX
- NIC
- NOTE
- NTP
- NVDA
- OEM
- OSS
- PATH
- PC
- POSIX
- PDF
- PHP
- PIN
- PPP
- POST
- PROM
- PXE
- QCOW2
- QEMU
- RADOS
- RAID
- RAM
- RBD
- REPL
- REST
- RFC
- RGW
- RHEL
- RSA
- SAP
- SCM
- SCSI
- SCSS
- SDK
- SFTP
- SHA
- SOCKS
- SPEC
- SQL
- SSH
- SSL
- SSSD
- SVG
- SWAT
- TBD
- TCP
- TLS
- TODO
- TTL
- UDP
- UEFI
- UNIX
- USB
- UTC
- UTF
- UUID
- VAR
- VDO
- VDSM
- VGA
- VNC
- VPN
- WAN
- WCA
- XFS
- XML
- XSS
- YAML
- YUM
- ZIP

12
.vale/styles/RedHat/Ellipses.yml Normal file
View file

@ -0,0 +1,12 @@
---
extends: existence
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/ellipses/
message: "Avoid the ellipsis (...) except to indicate omitted words."
nonword: true
source: "IBM - Ellipses, p.49"
action:
name: remove
tokens:
- '\.\.\.'
- "…"

15
.vale/styles/RedHat/HeadingPunctuation.yml Normal file
View file

@ -0,0 +1,15 @@
---
extends: existence
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/headingpunctuation/
message: "Do not use end punctuation in headings."
nonword: true
scope: heading
source: "IBM - Periods in headings and titles, p. 61"
action:
name: edit
params:
- remove
- ".?!"
tokens:
- '[a-z0-9][.?!](?:\s|$)'

206
.vale/styles/RedHat/Headings.yml Normal file
View file

@ -0,0 +1,206 @@
---
extends: capitalization
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/headings/
match: $sentence
message: "Use sentence-style capitalization in '%s'."
scope: heading
source: "IBM - Capitalization in headings and titles, p.16"
indicators:
- ":"
exceptions:
- Annobin
- Ansible
- Antora
- API
- AsciiDoc
- Asciidoctor
- AWS
- Azure
- Bierner
- Bitbucket
- Bonjour
- Btrfs
- Bugzilla
- Camel
- CapEx
- CDs
- CentOS
- Ceph
- cgroup
- Che-Theia
- Ciphertext
- Civetweb
- ClassLoader
- Classloader
- Cloudbursting
- Cloudwashing
- CodeReady
- Community
- ConfigMap
- ConfigMaps
- Containerfile
- Containerfiles
- Cookiecutter
- CR
- CRD
- CRDs
- CRs
- Ctrl
- Cygmon
- DaemonSet
- Datadog
- Dev
- DevOps
- DevWorkspace
- Dex
- DNS
- Docker
- Dockerfile
- Dockerfiles
- Dotnet
- Eclipse
- Dyninst
- Endevor
- Endian
- eServer
- Esprima
- Exif
- Fabrice
- Fortran
- GCC
- Git
- GitHub
- GitHub Action
- GitLab
- Gluster
- GraalVM
- Gradle
- GraphQL
- Grayscale
- GTKplus
- GUI
- Hashicorp
- Helgrind
- Helm
- Hibernate
- Homebrew
- HTTP
- HTTPS
- IBM
- IBM Cloud
- IDE
- IDEs
- InfiniBand
- Infinispan
- Intelephense
- IntelliJ
- IPSec
- ISeries
- Itanium
- Jakarta
- Java
- Jave
- JetBrains
- Jira
- Jolokia
- Joyent
- JUnit
- JVM
- Kibana
- Knative
- Kogito
- Kompose
- Kubespray
- Kylin
- Laravel
- Lombok
- Makefile
- Mandrel
- Mattermost
- Maven
- MicroProfile
- Microsoft
- Middleware
- Minikube
- Minishift
- Mirantis
- MongoDB
- mutual TLS
- MySQL
- Nagios
- Neoverse
- NetcoredebugOutput
- Netty
- Newdoc
- Nginx
- NuGet
- OAuth
- OmniSharp
- OpenID Connect
- OpenShift
- OpenTracing
- OpEx
- ORM
- PHP
- Podman
- PostgreSQL
- PostScript
- PowerPC
- Productize
- Productized
- Proof Key for Code Exchange
- Prometheus
- Pytorch
- qeth
- Quarkus
- Quiltflower
- Red Hat
- RedBoot
- Redistributions
- RESTEasy
- Rolfe
- Sakila
- SCM
- SELinux
- Semeru
- SmallRye
- Shadowman
- Spotify
- StarOffice
- startx
- Suchow
- SVG
- System
- SysV
- Tekton
- Telekom
- Tensorflow
- Texinfo
- Toolset
- Traefik
- Uber
- UltraSPARC
- URI
- URIs
- URL
- URLs
- Vale
- Valgrind
- Velero
- Vert.x
- vNIC
- vNUMA
- WebAuthn
- Webview
- Webviews
- Wildfly
- Window Maker
- Woopra
- Wordpress
- XEmacs
- xterm
- Yana
- Yeoman
- Zowe
- GitLab Code Quality

8
.vale/styles/RedHat/OxfordComma.yml Normal file
View file

@ -0,0 +1,8 @@
---
extends: existence
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/oxfordcomma/
message: "Use the Oxford comma in '%s'."
source: "IBM - Commas between clauses, p.45"
tokens:
- '(?:[^,]+,){1,}\s\w+\sand'

186
.vale/styles/RedHat/PassiveVoice.yml Normal file
View file

@ -0,0 +1,186 @@
---
extends: existence
ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/passivevoice/
message: "'%s' is passive voice. Consider rewording in active voice. You can use the passive voice in prerequisites"
source: "https://redhat-documentation.github.io/supplementary-style-guide/#prerequisites; IBM - Voice, p.35"
raw:
- \b(am|are|were|being|is|been|was|be)\b\s*
tokens:
- '[\w]+ed'
- awoken
- beat
- become
- been
- begun
- bent
- beset
- bet
- bid
- bidden
- bitten
- bled
- blown
- born
- bought
- bound
- bred
- broadcast
- broken
- brought
- built
- burnt
- burst
- cast
- caught
- chosen
- clung
- come
- cost
- crept
- cut
- dealt
- dived
- done
- drawn
- dreamt
- driven
- drunk
- dug
- eaten
- fallen
- fed
- felt
- fit
- fled
- flown
- flung
- forbidden
- foregone
- forgiven
- forgotten
- forsaken
- fought
- found
- frozen
- given
- gone
- gotten
- ground
- grown
- heard
- held
- hidden
- hit
- hung
- hurt
- kept
- knelt
- knit
- known
- laid
- lain
- leapt
- learnt
- led
- left
- lent
- let
- lighted
- lost
- made
- meant
- met
- misspelt
- mistaken
- mown
- overcome
- overdone
- overtaken
- overthrown
- paid
- pled
- proven
- put
- quit
- read
- rid
- ridden
- risen
- run
- rung
- said
- sat
- sawn
- seen
- sent
- set
- sewn
- shaken
- shaven
- shed
- shod
- shone
- shorn
- shot
- shown
- shrunk
- shut
- slain
- slept
- slid
- slit
- slung
- smitten
- sold
- sought
- sown
- sped
- spent
- spilt
- spit
- split
- spoken
- spread
- sprung
- spun
- stolen
- stood
- stridden
- striven
- struck
- strung
- stuck
- stung
- stunk
- sung
- sunk
- swept
- swollen
- sworn
- swum
- swung
- taken
- taught
- thought
- thrived
- thrown
- thrust
- told
- torn
- trodden
- understood
- upheld
- upset
- wed
- wept
- withheld
- withstood
- woken
- won
- worn
- wound
- woven
- written
- wrung

9
.vale/styles/RedHat/README-IBM.adoc Normal file
View file

@ -0,0 +1,9 @@
= README for Rules from the IBM Style Guide
All rights for the IBM Style Guide belong to IBM.
Our sources of inspiration:
* link:https://github.com/errata-ai/IBM[The primary Vale implementation of the IBM Style Guide]
* https://www.ibm.com/developerworks/library/styleguidelines/index.html[The DeveloperWorks version of the IBM Style Guide]

13
.vale/styles/RedHat/README-proselint.md Normal file
View file

@ -0,0 +1,13 @@
<!-- vale off -->
Copyright © 2014–2015, Jordan Suchow, Michael Pacer, and Lara A. Ross
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

28
.vale/styles/RedHat/README-write-good.md Normal file
View file

@ -0,0 +1,28 @@
<!-- vale off -->
Based on [write-good](https://github.com/btford/write-good).
> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too.
```
The MIT License (MIT)
Copyright (c) 2014 Brian Ford
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

12
.vale/styles/RedHat/ReadabilityGrade.yml Normal file
View file

@ -0,0 +1,12 @@
---
extends: readability
grade: 21
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/readabilitygrade/
message: "Grade level (%s) too high."
metrics:
- Automated Readability
- Coleman-Liau
- Flesch-Kincaid
- Gunning Fog
- SMOG

11
.vale/styles/RedHat/ReleaseNotes.yml Normal file
View file

@ -0,0 +1,11 @@
---
extends: substitution
ignorecase: false
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/releasenotes/
message: "For release notes, consider using '%s' rather than '%s'."
source: "https://redhat-documentation.github.io/supplementary-style-guide/#release-notes"
# swap maps tokens in form of bad: good
swap:
Now: With this update
Previously: Before this update

10
.vale/styles/RedHat/RepeatedWords.yml Normal file
View file

@ -0,0 +1,10 @@
---
extends: repetition
message: "'%s' is repeated!"
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/repeatedwords/
ignorecase: false
alpha: true
tokens:
- '[^\s\.]+'
- '[^\s]+'

14
.vale/styles/RedHat/SelfReferentialText.yml Normal file
View file

@ -0,0 +1,14 @@
---
extends: existence
ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/selfreferentialtext/
message: "Avoid using self-referential text such as '%s'."
source: "IBM - Audience and medium, p. 22"
tokens:
- this topic
- this module
- this assembly
- this chapter
- this section
- this subsection

9
.vale/styles/RedHat/SentenceLength.yml Normal file
View file

@ -0,0 +1,9 @@
---
extends: occurrence
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/sentencelength/
message: "Try to keep sentences to an average of 32 words or fewer."
scope: sentence
source: "IBM - Conversational style"
max: 32
token: \b(\w+)\b

119
.vale/styles/RedHat/SimpleWords.yml Normal file
View file

@ -0,0 +1,119 @@
---
extends: substitution
ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/simplewords/
message: "Use simple language. Consider using '%s' rather than '%s'."
source: "IBM - Conversational style; http://www.plainlanguage.gov/howto/wordsuggestions/simplewords.cfm"
swap:
"approximate(?:ly)?": about
"objective(?! C?)": aim|goal
absent: none|not here
abundance: plenty
accelerate: speed up
accentuate: stress
accompany: go with
accomplish: carry out|do
accorded: given
accordingly: so
accrue: add
accurate: right|exact
acquiesce: agree
acquire: get|buy
"(?<!an |the |IP |IPv[46] |MAC )address": discuss
addressees: you
adjacent to: next to
adjustment: change
admissible: allowed
advantageous: helpful
advise: tell
aggregate: total
aircraft: plane
alleviate: ease
allocate: assign|divide
alternatively: or
alternatives: choices|options
ameliorate: improve
amend: change
anticipate: expect
apparent: clear|plain
ascertain: discover|find out
assistance: help
attain: meet
attempt: try
authorize: allow
belated: late
bestow: give
cease: stop|end
collaborate: work together
commence: begin
compensate: pay
component: part
comprise: form|include
concerning: about
confer: give|award
consequently: so
consolidate: merge
constitutes: forms
contains: has
convene: meet
demonstrate: show|prove
depart: leave
designate: choose
desire: want|wish
determine: decide|find
detrimental: bad|harmful
disclose: share|tell
discontinue: stop
disseminate: send|give
eliminate: end
elucidate: explain
employ: use
enclosed: inside|included
encounter: meet
endeavor: try
enumerate: count
equitable: fair
equivalent: equal
exclusively: only
expedite: hurry
facilitate: ease
females: women
finalize: complete|finish
frequently: often
identical: same
incorrect: wrong
indication: sign
initiate: start|begin
itemized: listed
jeopardize: risk
liaise: work with|partner with
maintain: keep|support
methodology: method
modify: change
monitor: check|watch
multiple: many
necessitate: cause
notify: tell
numerous: many
obligate: bind|compel
optimum: best|most
permit: let
portion: part
possess: own
previous: earlier
previously: before
prioritize: rank
procure: buy
provide: give|offer
purchase: buy
relocate: move
solicit: request
state-of-the-art: latest
subsequent: later|next
substantial: large
sufficient: enough
terminate: end
transmit: send
utilization: use
utilize: use

20
.vale/styles/RedHat/Slash.yml Normal file
View file

@ -0,0 +1,20 @@
---
extends: existence
ignorecase: true
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/slash/
message: "Use either 'or' or 'and' in '%s'"
source: "IBM - Slashes, p. 68"
tokens:
- '(?<!/)\w+/\w+'
exceptions:
- "client/server"
- "I/O"
- "[Ii]nput/[Oo]utput"
- "N/A"
- "SSL/TLS"
- "upstream/downstream"
- "z/OS"
- "z/OSMF"
- "0/"
- "C/C"

10
.vale/styles/RedHat/Spacing.yml Normal file
View file

@ -0,0 +1,10 @@
---
extends: existence
level: error
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/spacing/
message: "Keep one space between words in '%s'."
nonword: true
source: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
tokens:
- "[a-z][.?!] {2,}[A-Z]"
- "[a-z][.?!][A-Z]"

316
.vale/styles/RedHat/Spelling.yml Normal file
View file

@ -0,0 +1,316 @@
---
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'?"
source: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/spelling/
# A "filter" is a case-sensitive regular expression specifying words to ignore during spell checking.
# Spelling rule applies to individual words
filters:
- '\.NET'
- 'I/O'
- 'Node\.js'
- "[aA]llowlist"
- "[aA]utostart"
- "[bB]ackfilling"
- "[bB]acktrace"
- "[bB]indable"
- "[bB]oolean"
- "[bB]reakpoint"
- "[bB]reakpoints"
- "[cC]he"
- "[cC]lassloading"
- "[cC]olocate"
- "[cC]onfig"
- "[dD]ev[wW]orkspace"
- "[dD]evfile"
- "[dD]evfiles"
- "[dD]ownstream"
- "[dD]ownstreaming"
- "[eE]xposal"
- "[Ff]actories"
- "[Ff]actory"
- "[fF]ailback"
- "[fF]ailover"
- "[gG]bps"
- "[gG]it"
- "[gG]rafana"
- "[hH]eatmap"
- "[hH]ostname"
- "[hH]yperconverged"
- "[iI]node"
- "[iI]tem"
- "[jJ]et[bB]rains"
- "[jJ]ournald"
- "[jJ]ournaling"
- "[kK]eycloak"
- "[kK]eylime"
- "[kK]eyring"
- "[kK]eyrings"
- "[lL]ibvirt"
- "[lL]icensor"
- "[lL]iveness"
- "[lL]oopback"
- "[mM]atrixes"
- "[mM]ebibytes"
- "[mM]illicores"
- "[mM]ixin"
- "[mM]ixins"
- "[mM]odularization"
- "[mM]ulticluster"
- "[mM]ultihost"
- "[mM]ultinode"
- "[mM]ultithread"
- "[mM]ultitenant"
- "[mM]ultiuser"
- "[mM]ultizone"
- "[nN]amespace"
- "[nN]amespaces"
- "[oO]nboarding"
- "[oO]perator"
- "[pP]reconfigured"
- "[pP]regenerated"
- "[pP]ulldown"
- "[pP]roductize"
- "[pP]roductized"
- "[rR]eadonly"
- "[rR]ebalance"
- "[rR]ebalances"
- "[rR]ebalancing"
- "[rR]ebase"
- "[rR]ebased"
- "[rR]ecertification"
- "[rR]ecertifications"
- "[rR]eshard"
- "[rR]esharding"
- "[rR]eshards"
- "[rR]esyncing"
- "[rR]ollout"
- "[rR]ollouts"
- "[rR]oundtable"
- "[rR]oundtables"
- "[rR]uleset"
- "[rR]unlevel"
- "[rR]unlevels"
- "[rR]untime"
- "[rR]untimes"
- "[sS]crollbar"
- "[sS]erializer"
- "[sS]erverless"
- "[sS]harding"
- "[Ss]u"
- "[sS]ubcommand"
- "[sS]ubcommands"
- "[sS]ubmenu"
- "[sS]ubmenus"
- "[sS]ubnetwork"
- "[sS]ubnetworks"
- "[sS]ubpackage"
- "[sS]ubpackages"
- "[sS]ubpath"
- "[sS]ubpaths"
- "[sS]ubstep"
- "[sS]ubsteps"
- "[sS]ubtest"
- "[sS]ubtests"
- "[sS]ubuser"
- "[sS]ubusers"
- "[sS]ubvolume"
- "[sS]ubvolumes"
- "[sS]ystemd"
- "[tT]heia"
- "[tT]olerations"
- "[tT]raceback"
- "[tT]ruststore"
- "[uU]ncomment"
- "[uU]ndercloud"
- "[uU]ninstallation"
- "[uU]nmount"
- "[uU]nmounting"
- "[uU]nported"
- "[uU]nstaged"
- "[uU]ntrusted"
- "[uU]psell"
- "[uU]pselling"
- "Let\'s Encrypt"
- adoc
- Annobin
- Ansible
- Antora
- API
- aws
- AWS
- Azure
- Bierner
- Bitbucket
- Bonjour
- btn
- Btrfs
- Bugzilla
- CentOS
- Ceph
- cephfs
- cgroup
- Che-Theia
- Ciphertext
- Civetweb
- classloader
- classpath
- Cloudbursting
- Cloudwashing
- CodeReady
- ConfigMap
- ConfigMaps
- Containerfile
- Containerfiles
- Cookiecutter
- CR
- CRD
- CRDs
- CRs
- CSVs
- Ctrl
- Cygmon
- DaemonSet
- Datadog
- Dev
- DevWorkspace
- Dex
- DNS
- Docker
- Dockerfile
- Dockerfiles
- Dotnet
- Dyninst
- Endevor
- Endian
- endif
- Esprima
- Exif
- Fabrice
- Fortran
- GCC
- GitHub
- GitLab
- Gluster
- Gradle
- Grayscale
- GraalVM
- GraphQL
- GUI
- Hashicorp
- Helgrind
- Helm
- Homebrew
- htmltest
- http
- HTTP
- https
- HTTPS
- IDE
- IDEs
- Infinispan
- Intelephense
- IntelliJ
- Itanium
- Jakarta
- Java
- Jave
- JBoss
- Jira
- Jolokia
- Joyent
- JUnit
- jvm
- JVM
- Kafka
- kbd
- Kibana
- Knative
- knowledgebase
- Kogito
- Kompose
- Kubespray
- Kylin
- Laravel
- Lombok
- Makefile
- Mattermost
- Maven
- MicroProfile
- Microsoft
- Middleware
- Minikube
- Minishift
- Mirantis
- MongoDB
- MySQL
- Nagios
- Neoverse
- NetcoredebugOutput
- Netty
- Newdoc
- Nginx
- npm
- NuGet
- OAuth
- ocp
- OmniSharp
- OpenID
- OpenShift
- OpenTracing
- osd
- PHP
- Podman
- PostgreSQL
- preconfigured
- prepended
- Prometheus
- proxied
- Pytorch
- qeth
- Quarkus
- Quiltflower
- Redistributions
- Restic
- RESTEasy
- Rolfe
- Sakila
- sbt
- SCM
- SELinux
- Semeru
- SLAs
- Shadowman
- SmallRye
- Spotify
- startx
- Suchow
- Symfony
- SVG
- Tekton
- Telekom
- Tensorflow
- Texinfo
- Toolset
- Traefik
- Uber
- URI
- URIs
- url
- URL
- URLs
- Vale
- Valgrind
- Velero
- Vert.x
- vsix
- WebAuthn
- Webview
- Webviews
- Wildfly
- Woopra
- Wordpress
- Yana
- Yeoman
- Zowe

304
.vale/styles/RedHat/TermsErrors.yml Normal file
View file

@ -0,0 +1,304 @@
---
extends: substitution
ignorecase: true
level: error
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termserrors/
message: "Use '%s' rather than '%s'."
source: "https://redhat-documentation.github.io/supplementary-style-guide/glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
action:
name: replace
# swap maps tokens in form of bad: good
swap:
'\b(?:eg|e\.g\.)[\s,]': for example
'\b(?:ie|i\.e\.)[\s,]': that is
"(?:Ctrl|control)-click": press Ctrl and click
"(?<!IBM )S 390": "IBM S 390"
"(?<!kernel )oops": kernel oops
"(?<!make the )transition": "make the transition|move|migrate|change"
"(?<!mobile |cell )phone": "telephone|cell phone|mobile phone"
"(?<!Mozilla )Firefox": Mozilla Firefox
"(?<!Mozilla )Thunderbird": Mozilla Thunderbird
"a lot(?: of)?": many|much
"backward(?:-)?compatible": compatible with earlier versions
"bottle neck|bottle-neck": bottleneck
"bottom(?:-)?left": lower left|lower-left
"bottom(?:-)?right": lower right|lower-right
"broad cast|broad-cast": broadcast
"down(?:-)?level": earlier|previous|not at the latest level
"mash(?: )?up": create
"non-English(?!-language?)": in languages other than English|non-English-language
"pop-up (?:blocker|killer)": software to block pop-up ad windows
"re(?:-)?occur": recur
"sort(?:-|/)?merge": sort|merge
"top(?:-)?left": upper left|upper right|upper-left|upper-right
"top(?:-)?right": upper left|upper right|upper-left|upper-right
# "app(?:.)": app
a number of: several
abort: cancel|stop
administrate: administer
advisor: adviser
air wall: air gap
all caps: uppercase
alright|all right: "correct|as expected"
analyse: analyze
and/or: a or b|a, b, or both
as long as: if|provided that
as per: according to|as|as in
autodetect: auto-detect
back-level: earlier|previous|not at the latest level
bi-monthly: bimonthly
bi-weekly: biweekly
Big Blue: IBM
blink: flash
blue screen of death: stop error
boot diskette: boot disk
bootloader: boot loader
breadcrumbing: breadcrumb trail
bugfix: bug fix
builtin|built in: built-in
canned: preplanned|preconfigured|predefined
case insensitive: not case-sensitive
catastrophic error: unrecoverable error
CBE: Common Base Event
CBTS: CICS BTS|BTS
CD burner|burner: CD writer
centre: center
cipher text|cyphertext|cypher text|cipher-text|cypher-text: ciphertext
cloud-bursting: cloudbursting
cloud-washing: cloudwashing
co-locate|collocate: colocate
cold backup: offline backup
cold boot: hardware restart
cold start: hardware restart
colour: color
comes with: includes
comma delimited|commadelimited: comma-delimited
comma-delimited values|comma delimited values|comma separated values: comma-separated values
command driven|commanddriven: command-driven
command prompt: shell prompt
command-language: command language
componentization: component-based development|component model|component architecture|shared components
componentize: develop components
comprised of: consist of
computer farm|computer ranch: server farm
connect with: connect to
container based: container-based
containerised: containerized
context menu: menu|pop-up menu
contextual help: help|context-sensitive help
cross site scripting: cross-site scripting
crossplatform|cross platform: cross-platform
CRUD: create retrieve update and delete
daisy-chain|daisychain: daisy chain
datacenter|data-center|data centre|datacentre: data center
datamirroring|data-mirroring: data mirroring
datapath: data path
datum: data
de-bug: debug
debuggable: debug
deconfigure: unconfigure
deinstall: uninstall
deinstallation: uninstallation
demilitarized zone: DMZ
demon: daemon
depress: press|type
deregister: unregister
desire: want|required
desire|wish: need
desk top|desk-top: desktop
destroy: delete from the database
different than|different to: different from
disklabel|disk-label: disk label
dismount: demount|unmount|remove
domainname|domain-name: domain name
down-load|down load: download
down-stream|down stream: downstream
downgrade: upgrade|fallback|fall back|rollback|roll back
downward compatible: compatible with earlier versions
drag and drop: drag
drill up: navigate
dualboot|dual boot: dual-boot
e-fix: fix|interim fix
eFix: fix|interim fix
emphasise: emphasize
end user: user
end-user interface: graphical interface|interface
env: environment
etc: and so on
EUI: graphical user interface|interface
fill in: complete|enter|specify
finalise: finalize
firm ware|firm-ware: firmware
fixed disk drive: hard disk drive
flavor: version|method
floating-point: floating point
floppy disk: diskette|diskette drive
floppy drive: diskette|diskette drive
floppy: diskette|diskette drive
focussed: focused
fore-ground|forground: foreground
forward compatible: compatible with later versions
gray-scale|gray scale: grayscale
gzip: compress
gzipped: archive|compressed file
Hammer|x86_64|x86-64|x64|64-bit x86: AMD64
hard drive: hard disk|hard disk drive
hard file: hard disk|hard disk drive
hardcode: hard code
hardcoded: hard-coded
healthcheck|health-check: health check
helpdesk|help-desk: help desk
hence: therefore
hostgroup: host group
hot-line: hotline
hotadd|hot-add: hot add
hotplug|hot-plug: hot plug
hotswap|hot-swap: hot swap
hyper-converged: hyperconverged
i-fix: interim fix
i-Fix: interim fix
IBM's: IBM
ifix: interim fix
iFix: interim fix
in order to: to
in other words: for example|that is
in spite of: regardless of|despite
in the event: in case|if|when
inactivate: deactivate
information on: information about
information technology: IT
insure: ensure
Internet address: IP address|URL|Internet email address|web address
irrecoverable: unrecoverable
jar: compress|archive
keep in mind: remember
kernelspace: kernel-space
labour: labor
laptop: notebook
large page|super page: huge page
launch: start|open
learnt: learned
leave out: omit
left-hand: left
leverage: use
line cord: power cable|power cord
Linux specific|chip specific: specific
look at: examine
lots of|bunches of: many
main directory: root directory
make sure: verify
manpage: man page
matrices: matrixes
memory stick: USB flash drive
menu driven|menudriven: menu-driven
microcomputer: PC
motherboard: system board
mouse over: point to|move the mouse pointer over
mouse-button|mousebutton: mouse button
multi-processing: multiprocessing
multi-tenant: multitenant
network-centric computing: network computing
nonrecoverable: unrecoverable
nonsecure|non-secure: insecure
notion: concept
offline storage: auxiliary storage
OK button: OK
okay: OK
on ramp: access method
on the fly: dynamically|as needed|in real time|immediately
on the other hand: however|alternatively|conversely
on-ramp: access method
op-code: opcode
open-source|OpenSource|opensource: open source
organise: organize
organised: organized
organising: organizing
over-ride|over ride: override
pain point: challenge|concern|difficulty|issue
parent task: parent process
perfcounter: performance counter
perimeter network: DMZ
plaintext|plain-text|cleartext|clear text: plain text
plug in|plug ins: plugin
power down: turn off
power off: turn off
power on: turn on
preload: preinstall|preinstalled
preloaded: preinstall|preinstalled
prepend: add a prefix to
proof of concepts: proofs of concept|proofs of concept
pseudo ops|pseudoops: pseudo-ops
pull-down: pulldown
recognise: recognize
remote-access server: remote access server
remote-access: remote access
right double-click: double right-click
right now: now
right-hand: right
round table: roundtable
rule of thumb: rule
run level|run-level: runlevel
sanity check: test|evaluate
screensaver: screen saver
scroll bar|scroll-bar: scrollbar
secondary storage: auxiliary storage
selection button: left mouse button
send out: emit
serial database: nonpartitioned database environment
sharename|Sharename: share name
shift-click: press Shift and click
ship: include|included
Simple Object Access Protocol: SOAP
single quote mark: single quotation mark
single quote: single quotation mark
SME routine: session management exit routine
soundcard|sound-card: sound card
specfile: spec file
spelt: spelled
stand-alone: standalone
start up: start
straight forward|straight-forward: straightforward
sub-command: subcommand
sub-directory: subdirectory
sub-menu: submenu
sub-package: subpackage
sunset: withdraw from service|withdraw from marketing|discontinue|no longer support
super-user|super user: superuser
swapspace: swap space
switch off: turn off
switch on: turn on
tarball: tar file
terminate: end|stop
text based: text-based
textmode|text-mode: text mode
the installer: installation program
thin provisioned|thinly provisioned|thinly-provisioned: thin-provisioned
thumbstick: USB flash drive
thus: therefore
tier-one|tier 1: tier-1
timeframe|time-frame: time frame
toggle off: toggle
touchscreen: touch-sensitive screen
typo: typing error|typographical error
uncheck: clear
uncompress: decompress
undeploy: remove|withdraw
unjar: extract
unselect: clear|deselect
untar: extract
unzip: extract|decompress
up-grade|up grade: upgrade
up-sell: upsell
up-selling|up selling: upselling
up-stream|up stream: upstream
up-time|up time: uptime
upward compatible: compatible with later versions
utilize: use
versus: compared to
video-mode|videomode: video mode
vs: compared to
warning notice: attention notice
web-enable: enable for the web
wish: want
wish|would like: want
zero out: zero

36
.vale/styles/RedHat/TermsSuggestions.yml Normal file
View file

@ -0,0 +1,36 @@
---
extends: substitution
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'."
source: "https://redhat-documentation.github.io/supplementary-style-guide/glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
action:
name: replace
swap:
"(?<!by) using": by using|that uses
"shell(?! prompt| script)": shell prompt
", that": ", which (non restrictive clause preceded by a comma)|that (restrictive clause without a comma)"
"(?<!,) which": ", which (non restrictive clause preceded by a comma)|that (restrictive clause without a comma)"
"(?<!such )as": because|while
and so on: "appropriate descriptive wording, unless you list a clear sequence of elements"
bare metal|bare-metal: bare metal (noun)|bare-metal (adjective)
Bps|bps: Bps (bytes per second)|bps (bits per second)
client side|client-side: client-side (adjective)| client side (noun)
CD|cd: cd (change directory command)|CD (compact disc)
between: " - ' to indicate a 'range of numbers"
channel: repository
Cloud: cloud
code: write
crash: fail|lock up|stop|stop responding
functionality: functions # IBM
input|type: enter (followed by the text to enter in monospace) # https://redhat-documentation.github.io/supplementary-style-guide/#text-entry
recommend: direct users to take the recommended action
refer to: see
roll-out|roll out|rollout: roll out (verb)|rollout (noun)
segfault: segmentation fault
tar: compress|archive
thru|through: "' - ' (range)|by using|finished|completed"
user space|userspace|user-space: user space (noun)| user-space (modifier)
zip: compress
Navigate|navigate: '"click", "select", "browse", or "go to"'

20
.vale/styles/RedHat/TermsWarnings.yml Normal file
View file

@ -0,0 +1,20 @@
---
extends: substitution
ignorecase: true
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termswarnings/
message: "Consider using '%s' rather than '%s' unless updating existing content that uses it."
source: "https://redhat-documentation.github.io/supplementary-style-guide/glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
action:
name: replace
swap:
"I(?!/O)": you
he|she: you
host name: hostname
may: might (for possiblity)|can (for ability)
on-premises|on-prem|on premise: on-premise|on-site|in-house
entitlement: repository|subscription
plug-in: plugin
tooling: tool|tools
via: through|by|from|on|by using

153
.vale/styles/RedHat/Usage.yml Normal file
View file

@ -0,0 +1,153 @@
---
extends: existence
ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/usage/
message: "Verify your use of '%s' with the word usage guidelines."
source: "https://redhat-documentation.github.io/supplementary-style-guide/glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
tokens:
- "pop-up (?:help|menu)"
- "redbook(:s)?"
- above
- across
- actionable
- allow
- alpha
- alphabetic
- alphabetical
- architect
- architected
- as well as
- assembler
- attach
- below
- best-of-breed
- billion
- bitness
- black box
- board
- both
- bring up
- business partner
- cache
- camel case
- carry out
- catch
- central processing unit
- check
- choose
- combination box
- combo box
- command console
- Common Base Event
- complete
- congratulations
- connect
- consumability
- consume
- could
- customers
- daughterboard
- decompress
- decompressed
- deploy
- designed to
- display
- domestic
- done
- due to
- either
- EPUB
- execute
- fatal
- foo
- foobar
- foreign
- free
- freeze
- fubar
- geography
- green screen
- guarantee
- hard boot
- hash
- hash sign
- higher
- hit
- hover help
- illegal
- impact
- info center
- infocenter
- information center
- ingest
- internationalize
- invoke
- itself
- Java Development Kit # IBM
- JDK #IBM
- kill
- latest
- legacy
- let
- like
- lite
- localize
- look and feel
- look-and-feel
- "(?<!virtual )machine(?! learning)"
- master and slave
- migrate
- native
- new
- once
- out-of-the-box
- overhead
- panel
- partner
- permit
- please
- pound sign
- program temporary fix
- proper
- pull-down
- quote
- quoted
- repair
- reside
- respective
- respectively
- select
- selected
- should
- simply
- since
- slave
- so
- soft boot
- Solution Partnership Centers
- store
- tab
- text entry field
- text field
- themselves
- then
- there are
- there is
- this means
- throw
- throwable
- time to value
- time-tested
- translate
- trillion
- twistie
- twisty
- uncompressed
- unmount
- updatable
- very
- we
- whether or not
- while
- would

8
.vale/styles/RedHat/UserReplacedValues.yml Normal file
View file

@ -0,0 +1,8 @@
---
source: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/userreplacedvalues/
extends: substitution
message: '%s, rather than %s'
level: suggestion
scope: raw
swap:
'__<[a-z_\x60]+-[\x60a-z_-]+>__': Separate words by underscores in user-replaced values

4
.vale/styles/RedHat/meta.json Normal file
View file

@ -0,0 +1,4 @@
{
"feed": "https://github.com/redhat-documentation/vale-at-red-hat/releases.atom",
"vale_version": ">=2.20.0"
}