Enable vale for prose linting (#3)

* Enable vale in CI

* Add vale config

* Tweak vale

* Update config

* Update .gitignore

* Switch back

* Rename CI

* Add badges

* Tidy up CI

* Change image

* Configure vale

* Delint

* Update README
This commit is contained in:
Dunya Kirkali
2024-09-28 22:58:25 +02:00
committed by GitHub
parent 4e8f6cde08
commit 1890774875
135 changed files with 7002 additions and 21 deletions

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}'

View File

@@ -0,0 +1,325 @@
---
extends: substitution
ignorecase: false
level: error
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/casesensitiveterms/
message: "Use '%s' rather than '%s'."
action:
name: replace
swap:
"(?<!.-)javadocs?": Javadoc|API documentation|Java API documentation
"(?<!/)var": VAR
"(?<!Business )Resource Planner|(?<!Business Resource )Planner": Business Resource Planner
"(?<!Microsoft Azure )On-Demand Marketplace": Microsoft Azure On-Demand Marketplace
"(?<!Red Hat )JBoss Enterprise Application Platform": Red Hat JBoss Enterprise Application Platform
"(?<!Red Hat )OpenStack Platform|RHOS|RH-OSP": Red Hat OpenStack Platform
"(?<!Red Hat JBoss )BRMS(?! engine)": inference engine
"(?<!Red Hat JBoss )BRMS|BRM|(?<!Red Hat )JBoss BRMS": Red Hat JBoss BRMS
"(?<!T-)BC": Business Central
"[dD]ay-0|day 0": Day 0
"[dD]ay-1|day 1": Day 1
"[dD]ay-2|day 2": Day 2
"BPMS|(?<!Red Hat )JBoss BPMS|(?<!Red Hat JBoss )BPM(?! Suite)": Red Hat JBoss BPM Suite
"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| 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(?!-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
'dotNet': .NET
'A-MQ(?!\sBroker|\sClient|\sConsole|\sInterconnect)': AMQ
'A-MQ\sBroker': AMQ Broker
'A-MQ\sClients': AMQ Clients
'A-MQ\sConsole': AMQ Console
'A-MQ\sInterconnect': AMQ Interconnect
'ack\spacket|ACK(?!\sflag)|ack': ACK flag
'ActiveMQ\sArtemis|ActiveMQ(?!\sArtemis)': built-in messaging|JBoss EAP built-in messaging|JBoss EAP messaging
'Admin\sPortal|webadmin\sportal|webadmin|Administrator\sPortal|Administration\sportal': Administration Portal
'BRMS\sengine': inference engine
'GUI\seditor|Business\sCentral\seditor': guided editor
'JBoss\.org': JBoss Community
'JBoss\sAMQ': AMQ
'JBoss\sInterconnect': AMQ Interconnect
'Kie(?!\sServer)': KIE
'Kie\sServer': Intelligent Process Server
'O\.K\.D|okd|OpenShift Kubernetes Distribution|OpenShift\sOrigin': OKD
'Red\sHat\sInterconnect': AMQ Interconnect
'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
(?<!Ansible )Playbook: playbook
Ansible playbook: Ansible Playbook
Ansible rulebook: Ansible Rulebook
Appliance Console: Appliance console
application stream|Application stream: Application Stream
Applix|ApplixWare: Applixware
Appstream|appstream: AppStream repository
asciidoctor|AsciiDoctor: Asciidoctor
asciidoc|Asciidoc: AsciiDoc
assertj|Assertj: AssertJ
auto-link|AutoLink: autolink
AWS opt in Region: AWS opt-in Region
basic authentication|Basic Authentication|basic auth|Basic auth|Basic Auth: Basic HTTP authentication|Basic authentication
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"
CDS|Cds: CDs
Ceph Ansible: ceph-ansible
Ceph block device|Ceph block devices: Ceph Block Device
Ceph filesystem|Ceph file system: Ceph File System
Ceph monitor: Ceph Monitor
Ceph object gateway|Ceph object gateways: Ceph Object Gateway
ceph-osd|Object Storage Device|OSD daemon: OSD
cephfs: CephFS
CGroup|c group: cgroup
cidr|Classless Interdomain Routing|Classless Inter-domain Routing: CIDR
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 Ciew|Composite View|composite view: composite content view
configmap: config map
configuration map: config map
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
csv: CSV
CygMon|cygmon|CYGMON: Cygmon
Data Grid Administration Console: Data Grid Console
Data Grid console: Data Grid Console
Denial of Service: denial of service
Denial-of-Service: denial-of-service
Development Preview|Developer preview|dev preview: Developer Preview
devops|Devops|Dev-Ops|Dev Ops: DevOps
directory server: Directory Server
Disk druid|disk druid|diskdruid: Disk Druid
DNF automatic|dnf automatic: DNF Automatic
dns: DNS
DVD burner|burner: DVD writer
DWH|data warehouse|Dataware House: Data Warehouse
Etcd|ETCD: etcd
Exec Shield: Exec-Shield
EXIF|exif: Exif
Extranet: extranet
facter: Facter
Faq|faq|F.A.Q: FAQ
fault tolerant: fault-tolerant
fault-tolerance: fault tolerance
fedora project: Fedora™ Project
filestore|File Store: FileStore
Firewalld|firewallD|FirewallD: firewalld
Firewire|firewire: FireWire
FlatHub: Flathub
FlatPak: Flatpak
fortran: Fortran
Fqdn|fqdn: FQDN
gbps|GBPS: Gbps
gb|Gb: GB
GDBTK: Insight
gid|Gid: GID
Gimp|gimp: GIMP
GIT: Git
Gnome|gnome: GNOME
Gnu|gnu: GNU
Gpl|gpl: GPL
Graalvm|graalVM: GraalVM
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: Insights image builder|image builder
INSTALL_DIR|installDir: FUSE_HOME
Iops|IOPs: IOPS
Ip: IP
IPSec: IPsec
ipv4|IPV4|Ipv4: IPv4
ipv6|IPV6|Ipv6: IPv6
iSeries: ISeries
iso: ISO
Istio Service Mesh: Istio service mesh
Itanium2: Itanium 2
jar file: JAR file
Jbang|jbang: JBang
JBoss Clients: AMQ Clients
JBoss Data Grid: Data Grid
jetbrains|Jetbrains: JetBrains
Junit|junit: JUnit
Jvm|jvm: JVM
kbase|knowledge base: KIE base
kernel-based virtual machine: Kernel-based Virtual Machine
kernelspace: kernel space
key store: keystore
kickstart: Kickstart
kie API|Kie API|knowledge API: KIE API
kjar|kJAR: KJAR
knowledgebase: Knowledgebase
ksession|knowledge session: KIE session
Kubelet(?! Stats Receiver): kubelet
kubernetes|k8s: Kubernetes
kvm: KVM
Lan|lan: LAN
Librados|LIBRADOS: librados
Librbd|LIBRBD: librbd
Lightweight Directory Access Protocol over Secure Socket Layer: LDAPS
LINUX|linux: Linux
live-backup group: master-slave group
Local Zone|LZ|local zone: AWS Local Zone
Lun|lun: LUN
master CA: IdM CA renewal server
master server: IdM server and replicas
Microprofile|micro-profile: MicroProfile
Microsoft Azure Portal: Microsoft Azure portal
Microsoft Windows Server: Windows Server
MoM|Mom|mom: MOM
Mongo\sDB|mongoDB|Mongodb|Mongo-db: MongoDB
MS(?!-DOS?)|MSFT|MicroSoft: Microsoft
MS-dos|Ms-Dos|ms-dos|MSDOS|msdos: MS-DOS
MTLS|m-TLS: mTLS
mutual tls|Mutual tls|Mutual TLS: mutual TLS
MYSQL|mySQL: MySQL
native interface: management CLI
network interface card: network interface controller (NIC)
objectclass: objectClass
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
Open Telemetry: OpenTelemetry (OTel)
openid connect|Openid Connect: OpenID Connect
openrewrite|Openrewrite|Open Rewrite: OpenRewrite
Openshift online|OO: Red Hat OpenShift Online
Operating Environment: operating environment
Operator Hub|Operator hub|Operatorhub|operatorhub: OperatorHub
Opex|Opex|OPEX|opEx: OpEx
ORAN: O-RAN
Organization administrator|Org Admin|org admin: Organization Administrator
OS|Operating System: operating system
Overcloud: overcloud
P-PC|PPC64: PowerPC
Podman desktop: Podman Desktop
podman: Podman
popup|Pop-up: pop-up
Posix|posix: POSIX
Postscript: PostScript
Powershell|powershell: PowerShell
Ppp|ppp: PPP
prom|Prom: PROM
proof key for code exchange: Proof Key for Code Exchange
proof of concepts: proofs of concept
Properties editor: Properties View
pSeries: IBM eServer System p
puppet forge: Puppet Forge
puppet: Puppet
q & a|q&a|Q & A|Q&A: Q and A
qcow2|Qcow2: QCOW2
Qdmanage|QDMANAGE: qdmanage
Qdstat|QDSTAT: qdstat
Qeth|QETH: qeth
RAMdisk|ramdisk|RAM-disk: RAM disk
Ram|ram: RAM
RAW: raw
Red Hat JBoss Data Grid|JDG: Red Hat Data Grid
Red Hat JBoss EAP: Red Hat JBoss Enterprise Application Platform
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
RHEL host|RHEL-H: Red Hat Enterprise Linux host
RHV: Red Hat Virtualization
Role Based Access Control|Role-Based Access Control|role based access control: role-based access control
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
samba|SAMBA: Samba
Satellite server: Satellite Server
SE-Linux|S-E Linux|SE Linux|selinux: SELinux
Shadow Man|ShadowMan: Shadowman
Shadow passwords: shadow passwords
Shadow utilities: shadow utilities
Smallrye: SmallRye
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
Spice|spice: SPICE
Spring boot: Spring Boot
SR IOV: SR-IOV
Ssh|ssh: SSH
SSL handshake: TLS handshake
SSL(?!/TLS): SSL/TLS
standard Manager|standard environment: standalone Manager
Staroffice|Star Office: StarOffice
StartTLS|startTLS: STARTTLS
StartX: startx
STI|source to image: Source-to-Image (S2I)
SU: su
Subscription Manifest: subscription manifest
Sys V|System V: SysV
system D|system D|SystemD|system d: systemd
Technology preview|technology preview: Technology Preview
The Operator Lifecycle Manager: Operator Lifecycle Manager
Tolapai|Intel Tolapai: Intel(R) EP80579 Integrated Processor
ttl: TTL
uid: UID
ULTRASPARC|UltraSparc: UltraSPARC
Unix|unix|UNIX-like: UNIX
uri: URI
url: URL
urn: URN
VCPU|vcpu: vCPU
VI: vi
VIM|vim: Vim
Virtual Desktop Server Management: VDSM
virtual-console|Virtual Console: virtual console
vlan|vLAN: VLAN
VM portal|vm portal|Virtual Machine Portal|User Portal: VM Portal
vnic|VNIC|Virtual Network Interface Card: vNIC
vnuma|VNUMA: vNUMA node
vpn: VPN
VS Code|VSCode|VisualStudioCode|VisualStudio Code: Visual Studio Code
VT(?!-d)|VT-i: Intel Virtualization Technology
wan: WAN
wca: WCA
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
Xp|xp: XP
Xterm: xterm

14
.github/styles/RedHat/Conjunctions.yml vendored 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

View File

@@ -0,0 +1,13 @@
---
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'."
action:
name: replace
swap:
blacklist: blocklist
master(?! broker): primary|source|initiator|requester|controller|host|director|supplier
slave(?! broker): secondary|replica|responder|device|worker|proxy|performer|consumer|child
whitelist: allowlist

44
.github/styles/RedHat/Contractions.yml vendored 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": are 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

191
.github/styles/RedHat/Definitions.yml vendored Normal file
View File

@@ -0,0 +1,191 @@
---
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:
- 'APIs?'
- 'CPUs?'
- 'CVEs?'
- 'DVDs?'
- 'GIDs?'
- 'NULL'
- 'PIDs?'
- 'ROMs?'
- 'RPMs?'
- 'UIDs?'
- 'URIs?'
- 'URLs?'
- ACPI
- AIX
- ARM
- ASCII
- ASP
- AWS
- BIND
- BIOS
- BMC
- CD
- CIDR
- CLI
- CNAME
- CSS
- CSV
- CUPS
- DEBUG
- DHCP
- DNF
- DNS
- DOM
- DOS
- DPDK
- DPI
- DRL
- DSL
- EIP
- ELB
- ERROR
- FAQ
- FQDN
- FTP
- GAS
- GB
- GCC
- GCJ
- GDB
- GET
- GIF
- GIMP
- GNOME
- GNU
- GNUPro
- GPL
- GPU
- GRUB
- GTK+
- GUI
- GUID
- HP
- HTML
- HTTP
- HTTPS
- IAM
- IBM
- IDE
- IOPS
- IOV
- IP
- ISO
- IT
- JAR
- JPEG
- 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
- OVN
- OVS
- PATH
- PC
- PDF
- PHP
- PIN
- PNG
- POSIX
- POST
- PPP
- PROM
- PTP
- PV
- PVC
- PXE
- QCOW2
- QEMU
- RADOS
- RAID
- RAM
- RAN
- RBAC
- RBD
- REPL
- REST
- RFC
- RGW
- RHEL
- RSA
- SAML
- SAP
- SCM
- SCSI
- SCSS
- SDK
- SFTP
- SHA
- SOCKS
- SPEC
- SQL
- SSD
- SSH
- SSL
- SSSD
- SVG
- SVN
- SWAT
- TBD
- TCP
- TLS
- TODO
- TTL
- UDP
- UEFI
- UNIX
- USB
- UTC
- UTF
- UUID
- VAR
- VDO
- VDSM
- VGA
- VLAN
- VNC
- VPN
- WAN
- WCA
- XFS
- XML
- XSS
- YAML
- YUM
- ZIP
- ZTP

27
.github/styles/RedHat/DoNotUseTerms.yml vendored Normal file
View File

@@ -0,0 +1,27 @@
---
extends: substitution
ignorecase: false
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/donotuseterms/
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.'
\bred\b(?!-? *hat)|orange|yellow|green|blue|indigo|violet: 'Do not use colors to describe something unless it is also described non-visually, for example, with the name of the item.'
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.'

12
.github/styles/RedHat/Ellipses.yml vendored 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:
- '\.\.\.'
- "…"

11
.github/styles/RedHat/EmDash.yml vendored Normal file
View File

@@ -0,0 +1,11 @@
---
extends: existence
ignorecase: true
level: warning
scope: raw
nonword: true
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/emdash/
message: Do not use em dashes. Use punctuation marks such as commas, parentheses, or colons instead.
tokens:
- '—'
- '&mdash;'

12
.github/styles/RedHat/GitLinks.yml vendored Normal file
View File

@@ -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).*'

View File

@@ -0,0 +1,11 @@
---
extends: substitution
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
action:
name: replace
swap:
'[.?!]$': ''

261
.github/styles/RedHat/Headings.yml vendored Normal file
View File

@@ -0,0 +1,261 @@
---
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:
- API
- AWS
- Agroal
- Annobin
- Ansible
- Antora
- AppData
- AsciiDoc
- Asciidoctor
- AssertJ
- Azure
- Basic authentication
- Basic HTTP authentication
- BOM
- Bierner
- Bitbucket
- Bonjour
- Bouncy Castle
- Btrfs
- Bugzilla
- CDs
- CR
- CRD
- CRDs
- CRs
- Camel
- CapEx
- CentOS
- Ceph
- Certificate Authorities
- Che-Theia
- Ciphertext
- Civetweb
- ClassLoader
- Classloader
- Cloudbursting
- Cloudwashing
- CodeReady
- Community
- ConfigMap
- ConfigMaps
- Containerfile
- Containerfiles
- Cookiecutter
- Ctrl
- Cygmon
- DNS
- DaemonSet
- Datadog
- Dev
- DevOps
- DevWorkspace
- Dex
- Docker
- Dockerfile
- Dockerfiles
- Dotnet
- Dyninst
- Eclipse
- Electron
- Endevor
- Endian
- Esprima
- Exif
- Fabrice
- Failsafe
- Fernflower
- Flathub
- Flatpak
- Flatpak Builder
- Fluentd
- Flyway
- Fortran
- Funqy
- GCC
- GTKplus
- GUI
- Git
- GitHub
- GitHub Action
- GitLab
- GitLab Code Quality
- Gluster
- GraalVM
- Gradle
- GraphQL
- Graylog
- Grayscale
- GTK
- HTTP
- HTTPS
- Hashicorp
- Helgrind
- Helm
- Hibernate
- Homebrew
- IBM
- IBM Cloud
- ID
- IDE
- IDEs
- IDs
- IPSec
- ISeries
- InfiniBand
- Infinispan
- Intelephense
- IntelliJ
- Istio
- Itanium
- JAR file
- JBang
- JBoss Log Manager
- JBoss Logging
- JUnit
- JVM
- Jakarta
- Jandex
- Java
- Jave
- JetBrains
- Jira
- Jolokia
- Joyent
- Kibana
- Kind
- Knative
- Knowledgebase
- Kogito
- Kompose
- Kubespray
- Kylin
- Laravel
- Liquibase
- Logstash
- Lombok
- Makefile
- Mandrel
- Mattermost
- Maven
- MicroProfile
- Microsoft
- Middleware
- Minikube
- Minishift
- Mirantis
- Mockito
- MongoDB
- MySQL
- Nagios
- Narayana
- Neoverse
- NetcoredebugOutput
- Netty
- Newdoc
- Nginx
- Node.js
- NuGet
- OAuth
- ORM
- OmniSharp
- OpEx
- OpenID Connect
- OpenJDK
- OpenRewrite
- OpenShift
- OpenTelemetry
- OpenTracing
- OTel
- PHP
- Podman
- Podman Desktop
- PostScript
- PostgreSQL
- PowerPC
- PowerShell
- Productize
- Productized
- Prometheus
- Proof Key for Code Exchange
- Pytorch
- Qt
- Quarkiverse
- Quarkus
- Quiltflower
- Qute
- RESTEasy
- Red Hat
- RedBoot
- Redis
- Redistributions
- SCM
- SDK
- SELinux
- SVG
- Sakila
- Semeru
- Shadowman
- SmallRye
- Software Development Kit
- Software Development Kits
- Spotify
- StarOffice
- Suchow
- SysV
- System
- Technology Preview
- Tekton
- Telekom
- Temurin
- Tensorflow
- Texinfo
- Toolset
- Traefik
- URI
- URIs
- URL
- URLs
- Uber
- UltraSPARC
- Vale
- Valgrind
- Velero
- Vert.x
- WebAuthn
- WebSocket
- Webview
- Webviews
- WebView
- Wildfly
- Window Maker
- Windows
- Windows Subsystem for Linux
- Woopra
- Wordpress
- XEmacs
- Yana
- Yeoman
- Zowe
- cgroup
- eServer
- gRPC
- mutual TLS
- mTLS
- qeth
- startx
- vNIC
- vNUMA
- xDS
- xterm

234
.github/styles/RedHat/Hyphens.yml vendored Normal file
View File

@@ -0,0 +1,234 @@
---
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-install: postinstall
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-configure: preconfigure
pre-defined: predefined
pre-enrollment: preenrollment
pre-establish: preestablish
pre-formatted: preformatted
pre-install: preinstall
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-register: reregister
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

View File

@@ -0,0 +1,13 @@
---
extends: existence
scope: raw
level: error
nonword: true
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/mergeconflictmarkers/
message: "Do not commit Git merge conflict markers in source code."
action:
name: remove
tokens:
- '^<{7}\s.*$'
- '^={7}$'
- '^>{7}\s.*$'

9
.github/styles/RedHat/OxfordComma.yml vendored Normal file
View File

@@ -0,0 +1,9 @@
---
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'."
scope: sentence
nonword: true
tokens:
- '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]'

View File

@@ -0,0 +1,190 @@
---
extends: existence
ignorecase: false
level: suggestion
scope: [list, sentence]
link: https://redhat-documentation.github.io/asciidoc-markup-conventions
message: "Consider wrapping this Pascal or Camel case term ('%s') in backticks."
# source: https://github.com/redhat-documentation/vale-at-red-hat/tree/main/.vale/styles/RedHat/PascalCamelCase.yml
tokens:
#PascalCase
- ([A-Z]+[a-z]+){2,}
- ([A-Z]+[a-z]+[A-Z]+){1,}
- ([A-Z]+[A-Z]+[a-z]+){1,}
#camelCase
- ([a-z]+)([A-Z]+[a-z]+){1,}
exceptions:
- '\b[A-Z]{2,}s?'
- 'vCPUs?'
- 3scale
- AGPLv
- AMQ
- API
- AppStream
- AsciiDoc
- AssertJ
- BaseOS
- BitBucket
- BlueStore
- CaaS
- camelCase
- CapEx
- CentOS
- CephFS
- CheckTree
- ClassLoader
- CloudForms
- CodeReady
- ConfigMaps?
- ConnectX
- Convert2RHEL
- CoreOS
- DaemonSet
- DDoS
- DevOps
- DevWorkspace
- DNSSec
- eServer
- eXpress
- eXtenSion
- FaaS
- FCoE
- FileStore
- FireWire
- FreeRADIUS
- GbE
- GBps
- GiB
- GitHub
- GitLab
- GitOps
- GlusterFS
- GNUPro
- GnuTLS
- GraalVM
- GraphQL
- GTID
- HashBase
- HdrHistogram
- Helm
- HyperShift
- IaaS
- IBoE
- IconBurst
- IdM
- IKEv
- InfiniBand
- InnoDB
- IntelliJ
- IntelliSense
- IPoIB
- IPsec
- IPv
- ISeries
- JavaScript
- JBoss
- JetBrains
- JUnit
- kBps
- KiB
- LangTags
- LGPLv
- libOSMesa
- LibreOffice
- libXNVCtrl
- LightPulse
- LinuxONE
- LiquidIO
- ManageIQ
- MariaDB
- MBps
- MegaRAID
- MiB
- MicroProfile
- MongoDB
- MoreUtils
- MySQL
- NetBIOS
- NetcoredebugOutput
- NetWeaver
- NetworkManager
- NetXen
- NetXtreme
- NFSv
- NMState
- NuGet
- NVidia
- NVMe
- OAuth
- objectClass
- OmniSharp
- OneConnect
- OpenEXR
- OpenID
- OpenIPMI
- OpenJDK
- OpenRAN
- OpenRewrite
- OpenSCAP
- OpenShift
- OpenSSH
- OpenSSL
- OpenStack
- OpenTelemetry
- OpenTracing
- OperatorHub
- OpEx
- OSBuild
- OTel
- PaaS
- PackageKit
- PathTools
- PCIe
- PipeWire
- PostgreSQL
- PostScript
- PowerPC
- PowerShell
- ProLiant
- PulseAudio
- PyPA
- PyPI
- QLogic
- ReaR
- RedBoot
- relaxngDatatype
- RESTEasy
- RHEL
- RoCE
- SaaS
- SeaBIOS
- SELinux
- SmallRye
- SmartNIC
- SmartState
- SQLite
- StarOffice
- STMicroelectronics
- SuperLU
- SysV
- TBps
- TiB
- TuneD
- TypeScript
- UltraSPARC
- USBGuard
- vCenter
- vDisk
- vHost
- VMware
- vSphere
- vSwitch
- WebAuthn
- WebSocket
- WireGuard
- XEmacs
- xPaaS
- XString
- XWayland
- YouTube
- ZCentral

193
.github/styles/RedHat/PassiveVoice.yml vendored Normal file
View File

@@ -0,0 +1,193 @@
---
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. In general, use active voice. Consult the style guide for acceptable use of passive voice."
# 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
exceptions:
- deprecated
- displayed
- imported
- supported
- tested
- trusted

View File

@@ -0,0 +1,8 @@
---
extends: existence
ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/productcentricwriting/
message: "Do not use transitive verb constructions like '%s' to grant abilities to inanimate objects. Whenever possible, use direct, user-focused sentences where the subject of the sentence performs the action."
tokens:
- '(allows?|enables?|lets?|permits?)\s(you|customers|the customer|the user|users)'

9
.github/styles/RedHat/README-IBM.adoc vendored 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]

View File

@@ -0,0 +1,13 @@
<!-- vale off -->
Copyright © 20142015, 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.

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.
```

View File

@@ -0,0 +1,9 @@
---
extends: readability
grade: 9
message: "Simplify your language. The calculated FleschKincaid 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/
level: suggestion
metrics:
- Flesch-Kincaid

11
.github/styles/RedHat/ReleaseNotes.yml vendored 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

16
.github/styles/RedHat/RepeatedWords.yml vendored Normal file
View File

@@ -0,0 +1,16 @@
---
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
action:
name: edit
params:
- regex
- '(\w+)(\s\w+)' # pattern
- "$1" # replace
tokens:
- '[^\s\.]+'
- '[^\s]+'

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

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

120
.github/styles/RedHat/SimpleWords.yml vendored Normal file
View File

@@ -0,0 +1,120 @@
---
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'."
action:
name: replace
swap:
"(?<!an |the |IP |IPv[46] |MAC |sub-)address": discuss
"approximate(?:ly)?": about
"objective(?! C?)": aim|goal
absent: none|not here
abundance: plenty
accentuate: stress
accompany: go with
accomplish: carry out|do
accorded: given
accordingly: so
accrue: add
accurate: right|exact
acquiesce: agree
acquire: get|buy
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
utilizing: using

27
.github/styles/RedHat/Slash.yml vendored Normal file
View File

@@ -0,0 +1,27 @@
---
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"
scope:
- sentence
- heading
tokens:
- '(?<!/)\w+/\w+'
exceptions:
- '\d{1,4}\/\d{1,4}'
- "0/"
- "[Ii]nput/[Oo]utput"
- "C/C"
- "client/server"
- "I/O"
- "N/A"
- "read/write"
- "SSL/TLS"
- "TCP/IP"
- "upstream/downstream"
- "z/OS"
- "z/OSMF"
- "[Kk]ey/value"

11
.github/styles/RedHat/SmartQuotes.yml vendored Normal file
View File

@@ -0,0 +1,11 @@
---
extends: substitution
message: Do not use smart quotation marks. Use %s rather than %s.
level: warning
nonword: true
scope: raw
action:
name: replace
swap:
|: "'"
‟|″|‶: "\""

10
.github/styles/RedHat/Spacing.yml vendored 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:
- '\w+[.?!]\s{2,}[A-Z]\w+'
- '\w+[.?!][A-Z]\w+'

522
.github/styles/RedHat/Spelling.yml vendored Normal file
View File

@@ -0,0 +1,522 @@
#file: noinspection IncorrectFormatting
---
extends: spelling
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/spelling/
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 the regex
filters:
- "[aA]ccessor"
- "[aA]llowlist"
- "[aA]utogenerate"
- "[aA]utoinstall"
- "[aA]utomount"
- "[aA]utonumber"
- "[aA]utostart"
- "[bB]ackfilling"
- "[bB]ackport"
- "[bB]ackported"
- "[bB]acktrace"
- "[bB]indable"
- "[bB]oolean"
- "[bB]ootable"
- "[bB]reakpoint"
- "[bB]reakpoints"
- "[cC]he"
- "[cC]hrony"
- "[cC]lassloading"
- "[cC]lasspath"
- "[cC]olocate"
- "[cC]olocation"
- "[cC]onfig"
- "[cC]ontainerd"
- "[cC]orequisite"
- "[cC]ustomizer"
- "[cC]yberattack"
- "[cC]ybercrime"
- "[cC]ybersecurity"
- "[dD]atasource"
- "[dD]eclaratively"
- "[dD]ecompiler"
- "[dD]efragmentation"
- "[dD]eserialization"
- "[dD]eserialize"
- "[dD]eserialized"
- "[dD]esynchronize"
- "[dD]esynchronized"
- "[dD]ev"
- "[dD]ev[wW]orkspace"
- "[dD]evfile"
- "[dD]istro"
- "[dD]ownstream"
- "[dD]ownstreaming"
- "[eE]xposal"
- "[eE]xtrapartition"
- "[Ff]actories"
- "[Ff]actory"
- "[fF]ailback"
- "[fF]ailover"
- "[fF]indability"
- "[gG]bps"
- "[gG]ibibyte"
- "[gG]it"
- "[gG]lock"
- "[gG]radle"
- "[gG]rafana"
- "[hH]ardcoding"
- "[hH]eatmap"
- "[hH]ostname"
- "[hH]yperconverged"
- "[iI]node"
- "[iI]ntranode"
- "[iI]ntrapartition"
- "[iI]ntrarecord"
- "[iI]ntrasystem"
- "[iI]nvocable"
- "[iI]tem"
- "[jJ]et[bB]rains"
- "[jJ]ournald"
- "[jJ]ournaling"
- "[kK]dump"
- "[kK]eycloak"
- "[kK]eylime"
- "[kK]eyring"
- "[kK]eyrings"
- "[kK]eyspace"
- "[kK]eytab"
- "[kK]ustomize"
- "[lL]ibvirt"
- "[lL]icensor"
- "[lL]iquibase"
- "[lL]iveness"
- "[lL]oopback"
- "[mM]acrostructure"
- "[mM]atrixes"
- "[mM]ebibytes"
- "[mM]etaclass"
- "[mM]etafile"
- "[mM]etamodel"
- "[mM]etatable"
- "[mM]iddleware"
- "[mM]illicores"
- "[mM]inicourse"
- "[mM]inidisk"
- "[mM]ixin"
- "[mM]ixins"
- "[mM]odularization"
- "[Mm]onospace"
- "[mM]ulticloud"
- "[mM]ulticluster"
- "[mM]ultifactor"
- "[mM]ultihost"
- "[mM]ultinode"
- "[mM]ultipath"
- "[mM]ultipoint"
- "[mM]ultisite"
- "[mM]ultitable"
- "[mM]ultitenancy"
- "[mM]ultitenant"
- "[mM]ultithread"
- "[mM]ultitiered"
- "[mM]ultiuser"
- "[mM]ultivendor"
- "[mM]ultizone"
- "[nN]amespace"
- "[nN]amespaces"
- "[nN]MState"
- "[nN]onheap"
- "[nN]oninteractive"
- "[nN]onpaired"
- "[nN]onsystem"
- "[oO]ffboarding"
- "[oO]mnichannel"
- "[oO]nboarding"
- "[oO]perator"
- "[oO]verridable"
- "[oO]verstrike"
- "[pP]luggable"
- "[pP]ostediting"
- "[Pp]ostinstall"
- "[pP]ostinstallation"
- "[pP]ostoperation"
- "[pP]ostrequisite"
- "[pP]recompile"
- "[pP]reconfigured"
- "[pP]reenrollment"
- "[pP]reformatted"
- "[pP]regenerated"
- "[Pp]reinstall"
- "[pP]reinstallation"
- "[pP]reoperational"
- "[pP]repend"
- "[pP]repended"
- "[pP]reprocess"
- "[pP]reprocessor"
- "[pP]roductize"
- "[pP]roductized"
- "[pP]seudocode"
- "[pP]seudorandom"
- "[pP]seudotext"
- "[pP]ulldown"
- "[rR]eadonly"
- "[rR]eauthenticate"
- "[rR]ebalance"
- "[rR]ebalances"
- "[rR]ebalancing"
- "[rR]ebase"
- "[rR]ebased"
- "[rR]ecertification"
- "[rR]ecertifications"
- "[rR]eenabled"
- "[rR]eentrant"
- "[rR]efreshable"
- "[rR]eindex"
- "[rR]eindexing"
- "[rR]eshard"
- "[rR]esharding"
- "[rR]eshards"
- "[rR]esyncing"
- "[rR]ollout"
- "[rR]ollouts"
- "[rR]oundtable"
- "[rR]oundtables"
- "[rR]ulebook"
- "[rR]uleset"
- "[rR]unlevel"
- "[rR]unlevels"
- "[rR]untime"
- "[rR]untimes"
- "[sS]crollbar"
- "[sS]earchability"
- "[sS]erializable"
- "[sS]erialization"
- "[sS]erializer"
- "[sS]erverless"
- "[sS]ervlet"
- "[sS]etter"
- "[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]ysctl"
- "[sS]yslog"
- "[sS]ystemd"
- "[tT]elco"
- "[tT]emplated"
- "[tT]heia"
- "[tT]olerations"
- "[tT]raceback"
- "[tT]ruststore"
- "[uU]mask"
- "[uU]ncomment"
- "[uU]ndercloud"
- "[uU]nderrun"
- "[uU]nformatted"
- "[uU]ninstallation"
- "[uU]nmount"
- "[uU]nmounting"
- "[uU]nported"
- "[uU]nstaged"
- "[uU]ntrusted"
- "[uU]psell"
- "[uU]pselling"
- "[vV]alidator"
- "I/O"
- "Let\\'s Encrypt"
- '\.NET'
- 'Node\.js'
- ACLs
- adoc
- AGPLv
- Agroal
- Annobin
- Ansible
- Antora
- API
- Applixware
- Asciidoctor
- AssertJ
- autolink
- aws
- AWS
- Azure
- bcrypt
- Bierner
- Bitbucket
- BOM
- Bonjour
- Bouncy Castle
- btn
- Btrfs
- Bugzilla
- Buildah
- camelCase
- CentOS
- Ceph
- cephfs
- cgroup
- Che-Theia
- Ciphertext
- Civetweb
- classloader
- Cloudbursting
- Cloudwashing
- CodeReady
- ConfigMap
- Containerfile
- Cookiecutter
- CPUs
- CR
- CRD
- CRDs
- CRs
- CSIDriver
- CSINode
- CSVs
- Ctrl
- CVEs
- Cygmon
- DaemonSet
- Datadog
- Dev
- DevWorkspace
- Dex
- DNS
- Docker
- Dockerfile
- Dockerfiles
- Dotnet
- Dyninst
- Endevor
- Endian
- endif
- eServer
- Esprima
- etcd
- Exif
- extranet
- Fabrice
- Facter
- Failsafe
- FDs
- Fernflower
- firewalld
- Flathub
- Flatpak
- Fluentd
- Flyway
- Fortran
- Funqy
- Galera
- GCC
- GIDs
- GitHub
- GitLab
- Gluster
- GNUPro
- GraalVM
- GraphQL
- Graylog
- Grayscale
- greenboot
- gRPC
- GTID
- GUI
- Hashicorp
- Helgrind
- Helm
- Homebrew
- htmltest
- http
- HTTP
- https
- HTTPS
- IDE
- IDEs
- IKEv
- Infinispan
- Intelephense
- IntelliJ
- IPPool
- IPsec
- IPv
- ISeries
- Istio
- ISVs
- Itanium
- Jakarta
- Jandex
- Java
- Jave
- JBang
- JBoss
- Jira
- Jolokia
- Joyent
- JUnit
- jvm
- JVM
- Kafka
- kbd
- Kerberos
- keystore
- Kibana
- Knative
- Knowledgebase
- Kogito
- Kompose
- kubelet
- Kubernetes
- Kubespray
- Kylin
- Laravel
- LGPLv
- libOSMesa
- librados
- librbd
- Libreswan
- Liquibase
- Logstash
- Lombok
- Makefile
- Mattermost
- Maven
- MicroProfile
- Microsoft
- Minikube
- Minishift
- Mirantis
- Mockito
- MongoDB
- MySQL
- Nagios
- Narayana
- Neoverse
- NetcoredebugOutput
- Netty
- Newdoc
- NFSv
- Nginx
- npm
- NuGet
- Nutanix
- NVidia
- NVMe
- OAuth
- objectClass
- ocp
- OmniSharp
- OpenID
- OpenJDK
- OpenRewrite
- OpenShift
- OpenTelemetry
- OpenTracing
- OSBuild
- osd
- OSs
- OSTree
- OTel
- PCIe
- PDF
- Petitboot
- PHP
- PIDs
- Podman
- PostgreSQL
- PowerShell
- Prometheus
- proxied
- Pytorch
- qdmanage
- qdstat
- qeth
- QLogic
- Quarkiverse
- Quarkus
- Quiltflower
- Qute
- Realtime
- Redis
- Redistributions
- relaxngDatatype
- RESTEasy
- Restic
- Rolfe
- Rollup
- ROMs
- rootful
- rootless
- RPMs
- Sakila
- sbt
- SCM
- SELinux
- Semeru
- Shadowman
- Skopeo
- SLAs
- SmallRye
- Spotify
- startx
- STMicroelectronics
- Stratis
- Suchow
- SVG
- Symfony
- Tekton
- Telekom
- Temurin
- Tensorflow
- Texinfo
- Toolset
- Traefik
- Uber
- UIDs
- URI
- url
- URL
- USBGuard
- Vale
- Valgrind
- vCenter
- vDisk
- Velero
- Vert.x
- vHost
- VMs
- VMware
- vsix
- vSphere
- WebAuthn
- Webpack
- WebSocket
- WebView
- wifi
- Wildfly
- Woopra
- Wordpress
- XString
- XWayland
- Yana
- Yeoman
- ZCentral
- Zowe

9
.github/styles/RedHat/Symbols.yml vendored Normal file
View File

@@ -0,0 +1,9 @@
---
extends: existence
level: suggestion
link: https://redhat-documentation.github.io/supplementary-style-guide/#_symbols
message: "Do not use the '%s' symbol."
nonword: true
tokens:
- '(?<![":])\!(?![":])'
- '(?<!")\&(?!")'

471
.github/styles/RedHat/TermsErrors.yml vendored Normal file
View File

@@ -0,0 +1,471 @@
---
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'."
action:
name: replace
# swap maps tokens in form of bad: good
swap:
"(?<!-)healthcheck|health-check": health check
"(?<!-)pm": PM
"(?<!-|I )am": AM
"(?<!.)io": I/O
"(?<!as well )as per": according to|as|as in
"(?<!kernel )oops": kernel oops
"(?<!mobile |cell )phone": "telephone|cell phone|mobile phone"
"(?<!Mozilla )Firefox": Mozilla Firefox
"(?<!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
"bottle neck|bottle-neck": bottleneck
"Christian name|forename|first name": given name
"down(?:-)?level": earlier|previous|not at the latest level
"IPI": installer-provisioned infrastructure
"pop-up (?:blocker|killer)": software to block pop-up ad windows
"re(?:-)?occur": recur
"sanity test|sanity check": test|evaluate|validate|verify
"single quote mark|single quote(?! mark)": single quotation mark
"sort(?:-|/)?merge": sort|merge
"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": without
'(?<!IBM\s)S\/390|S90|S\s390': IBM S/390
'backwards?\scompatible': compatible with earlier versions
'(?<= )for instance(?=,)': for example
10BASE-2: 10BASE2
10BASET: 10BASE-T
24/7: 24x7
32-bit Windows operating system: Windows 32-bit operating system
a number of: several
abort: cancel|stop
ac: AC
accelerator key: keyboard shortcut
acknowledgement: acknowledgment
adapter card: adapter|card
adaptor: adapter
administrate: administer
adviser: advisor
air wall: air gap
aka: also known as
alphameric: alphanumeric
alphanumerical: alphanumeric
alright|all right: "correct|as expected"
amongst: among
analogue: analog
analyse: analyze
anticlockwise: counterclockwise
appendices: appendixes
application program interface: application programming interface
artefact: artifact
article-based information: topic-based information
as long as: if|provided that
autodetect: auto-detect
back slash: backslash
back-level: earlier|previous|not at the latest level
backside: back|rear
barcode: bar code
Bidi: bidi
Big Blue: IBM
bit map: bitmap
bitfield: bit field
bitness: bit version|bit value
bitrate: bit rate
bitstring: bit string
black hat hacker: attacker
blink: flash
blue screen of death: stop error
boot diskette: boot disk
bootloader: boot loader
breadcrumbing: breadcrumb trail
break point: breakpoint
bring up: start|power on|open|turn on
bufferpool: buffer pool
builtin|built in: built-in
busmaster: bus master
busses: buses
byte code: bytecode
Camelcase|CamelCase: camel case
cancelation: cancellation
cancelled: canceled
cancelling: canceling
canned: preplanned|preconfigured|predefined
cardreader: card reader
case insensitive: not case-sensitive
catalogue: catalog
catastrophic error: unrecoverable error
CBE: Common Base Event
CBTS: CICS BTS|BTS
CD burner|burner: CD writer
centre: center
check box: checkbox
check list: checklist
check mark: checkmark
chipset: chip set
chronologic: chronological
cipher text|cyphertext|cypher text|cipher-text|cypher-text: ciphertext
codepage: code page
codepoint: code point
codeset: code set
cold backup: offline backup
cold boot: hardware restart
cold start: hardware restart
colours?: color|colors
combo box: combination box
comes with: includes
CommServer: Communications Server
comprised of: consist of
computer farm|computer ranch: server cluster|server farm
connect with: connect to
containerised: containerized
context menu: menu|pop-up menu
contextual help: help|context-sensitive help
control point logical unit: control logical unit
controlling logical unit: control logical unit
convertor: converter
copy book: copybook
cyber attack: cyberattack
cyber attacker: cyberattacker
cyber crime: cybercrime
cyber defense: cyberdefense
cyber hacker: cyberhacker
cyber intelligence: cyberintelligence
cyber security: cybersecurity
cyber space: cyberspace
cyber terror: cyberterror
cyber threat: cyberthreat
cyberresilience: cyber resilience
data base: database
(?<!vCenter )datacenter|data-center|data centre|datacentre: data center
datafile: data file
dataflow: data flow
datamart: data mart
datamirroring|data-mirroring: data mirroring
datapath: data path
datapool: data pool
dataset: data set
datasheet: data sheet
datum: data
daylight savings time: Daylight Saving Time
dc: DC
DDNAME: ddname
deconfigure: unconfigure
deinstall: uninstall
deinstallation: uninstallation
demilitarized zone: DMZ
demon: daemon
demount: dismount|unmount
deployment configuration: deployment
depress: press|type
deregister: unregister
descendent: descendant
details pane: details view
diagnostic tests: diagnostics
different than|different to: different from
dismiss: close
disrupter: disruptor
domain mode: managed domain
DOS environment: DOS session
double quote: double quotation mark
double word: doubleword
down time: downtime
downwards? compatible: compatible with earlier versions
drill up: navigate
dualboot|dual boot: dual-boot
dumpfile: dump file
eFix|e-fix: fix|interim fix
Elastic Load Balancer: Elastic Load Balancing
emphasise: emphasize
end user: user
end-user interface: graphical interface|interface
enum: data enumeration
env: environment
EUI: graphical user interface|interface
evangelist: influencer|advocate|ambassador
fatal: unrecoverable
fill in: complete|enter|specify
finalise: finalize
fire up: start
fixed disk drive: hard disk drive
flavor: version|method
focussed: focused
forward compatible: compatible with later versions
freezes: hangs|stops responding
G11N|g11n: globalization
gage: gauge
grayed out: not displayed|unavailable
grey: gray
gzipped file: archive|compressed file
hard boot: restart
hard copy: hardcopy
hard file: hard disk|hard disk drive
hardcode: hard code
hardcoded: hard-coded
health care: healthcare
heart beat: heartbeat
hence: therefore
hostgroup: host group
hotkey: hot key
HOWTO: how-to
imbed: embed
in depth: in-depth
in other words: for example|that is
in spite of: regardless of|despite
in the event: in case|if|when
inactivate: deactivate
incent: motivate|encourage
incentivize: motivate|encourage
inch pound: inch-pound
information technology: IT
initial caps: initial capital letters
Internet address: IP address|URL|Internet email address|web address
Intranet: intranet
invoke: start|call
irrecoverable: unrecoverable
JavaBean: JavaBeans
joblog: job log
jobstream: job stream
judgement: judgment
keep in mind: remember
kernelspace: kernel-space
kick off: start
L10N|l10n: localization
labelled: labeled
labour: labor
large page|super page: huge page
last name: surname
learnings: lessons|training events|experiences
learnt: learned
leave out: omit
left most: leftmost
left-arrow key: Left Arrow key
left-hand: left
left-justified: left-aligned
left-justify: left-align
left-most: leftmost
line cord: power cable|power cord
link edit: link-edit
link editing: link-editing
live broker: master broker
live only: live-only
loadtime: load time|load-time
log into: log in to
log off of: log off from
log onto: log on to
logfile: log file
lots of|bunches of: many
main directory: root directory
make file: makefile
man day: person day
man hour: person hour|labor hour
manipulation button: right mouse button
manpage: man page
masterbrand: corporate brand
matrices: matrixes
memory stick: USB flash drive
menu driven|menudriven: menu-driven
menubar: menu bar
microcomputer: PC
motherboard: system board
mountpoint: mount point
mouse button 1: left mouse button
mouse button 2: right mouse button
mouse over: point to|move the mouse pointer over
multijobbing: multitasking
MV: major vector
nameserver: name server
network-centric computing: network computing
newsfeed: news feed
nextgen: next generation
nonrecoverable: unrecoverable
nonsecure|non-secure: insecure
notion: concept
NWSAA: NetWare for SAA
offline storage: auxiliary storage
on demand: on-demand
on ramp|on-ramp: access method
on the fly: dynamically|as needed|in real time|immediately
on the other hand: however|alternatively|conversely
openshit: OpenShift
opt into: opt in
opting into: opting in|opting in to
organise: organize
organised: organized
organising: organizing
orientate: orient
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
perfcounter: performance counter
perimeter network: DMZ
phillips screw: Phillips screw
phillips screwdriver: Phillips screwdriver
PL/1: PL/I
plaintext|plain-text|cleartext|clear text: plain text
planar board: system board
Plug-and-Play: plug-and-play
pod cast|Podcast|Pod Cast: podcast
pojo: data model
pop-up list: list
pop-up menu: menu
pop-up window: window
pops up: opens
pow wow: meeting|session
poweron: power-on
practise: practice
preventative: preventive
print friendly: printer friendly
prior to: before
program product: licensed program
programmed operator: program operator
Programming Language/I: PL/I
proof of concepts: proofs of concept
pub/sub|publish-subscribe: publish/subscribe
quickstart|Quickstart: quick start
read-write: read/write
recognise: recognize
Red Hat Java: Red Hat build of OpenJDK
Red Hat OpenJDK|RHOJDK|Red Hat Open Java Development Kit: Red Hat build of OpenJDK
regex: regular expression
requestor: requester
right now: now
right-hand: right
right-justified: right-aligned
right-justify: right-align
right-most: rightmost
round table: roundtable
round-robin task dispatching: round-robin scheduling
rule of thumb: rule
schemata: schemas
screencap: screen capture
screensaver: screen saver
scroll bar|scroll-bar: scrollbar
second name: surname
secondary storage: auxiliary storage
segregate: separate
segregation: separation|segmentation
selection button: left mouse button
send out: emit
serial database: nonpartitioned database environment
sharename|Sharename: share name
ships with|is shipped with: includes
short cut: shortcut
shortcut key: keyboard shortcut
shortcut menu: menu
sign into: sign in to
sign off of: sign off from
signoff: sign-off
signon: sign on to
Simple Object Access Protocol: SOAP
single signon: single sign-on
smartcard: smart card
smartpaper: smart paper
SME routine: session management exit routine
snapset|snapsets: snapshot set
so long as: if|when
sockets interface: socket interface
socksified: SOCKS-enabled
soft boot: restart the system
soft copy: softcopy
specfile: spec file
spelt: spelled
spend: expense|expenditure|outlay
standalone mode: standalone server
sunset: withdraw from service|withdraw from marketing|discontinue|no longer support
swapspace: swap space
switch off: turn off
synch: sync|synchronize
syncpoint: sync point
sysprep tool|sysprep process|sysprep function: sysprep
system engineer: systems engineer
tablespace: table space
TCP/IP network: Internet Protocol network|IP network
teleprocessing line: telecommunication line|transmission line
testcase: test case
the installer: installation program
thin provisioned|thinly provisioned|thinly-provisioned: thin-provisioned
third-party software vendor: independent software vendor
thru: through|throughput
thumb drive: USB flash drive
thumbstick: USB flash drive
tier-one|tier 1: tier-1
time box: timebox
time line: timeline
time stamp: timestamp
timeslice: time slice
timezone: time zone
toggle off: toggle
tool bar: toolbar
tool box: toolbox
tool kit: toolkit
tool tip: tooltip
ToolTip: tooltip
totalled: totaled
touch base: contact|communicate
touchscreen: touch-sensitive screen
trouble shoot: troubleshoot
trust store: truststore
try and: try to
twisty: twistie
TY-RAP: cable tie
typo: typing error|typographical error
unallocate: deallocate
uncheck: clear
uncompilation: decompilation
uncompile: decompile
uncompress: decompress
undeploy: remove|withdraw
underbar: underscore
unencrypt: decrypt
unselect: clear|deselect
untar: extract
unzip: extract|decompress
upgradable: upgradeable
upward compatible: compatible with later versions
USB thumb drive: USB flash drive
useable: usable
utilize: use
vanilla: uncustomized
versus: compared to
virtual diskette drive: virtual floppy drive
virtual diskette(?! drive): virtual floppy disk
virtual DOS machine: DOS session
virtual hard disk: virtual hard drive
virtual-equals-real: nonpageable
virtual-equals-virtual: pageable
wait condition: wait state
war room: center of operations|command center|control room
warmstart|warm boot: warm start
warning notice: attention notice
web cast: webcast
web site: website
web-enable: enable for the web
webmistress|web master: webmaster
white hat hacker: offensive security researcher
whitepaper: white paper
wild card: wildcard
wiring closet: telecommunications closet
wish: want
wish|would like: want
work flow: workflow
work group: workgroup
work load: workload
work space: workspace
work station: workstation
XSA: extended subarea addressing
xsite: cross-site replication
zero out: zero
zeroes: zeros
zonegroup|zone-group: zone group
Zulu time: Coordinated Universal Time

View File

@@ -0,0 +1,54 @@
---
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'."
scope: sentence
action:
name: replace
swap:
"(?<!, | in | on | at | to | for | from | of | with | without | against )which": "that|, which"
", that": "that|, which"
"(?<!.-)jar": compress|archive
"[Nn]avigate": click|select|browse|go to
"bottom(?:-)?left": lower left|lower-left
"bottom(?:-)?right": lower right|lower-right
"shell(?! prompt| script)": shell prompt
"x64|x86-64|(?<!64-bit )x86": 64-bit x86|x86_64
'(?<!.*-|program )operator': Operator
'(?<!.*-|program )operators': Operators
'(?<![\.\-])(?:zip|gzip|tar)(?! file| archive)': compress
'(?<!\.)tar file': ".tar file"
'(?<!\.)zip file': ".zip file"
above: earlier|previous|preceding|before
afterwards: afterward
all caps: uppercase
below: after|later|following
bottom left: lower left
bottom right: lower right
bugfix: bug fix
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
higher: later
hit: press|type
in order to: to
information on: information about
launch: start|open
legacy: existing|traditional|established|classic|earlier|previous
once: after|when
on-premise: on-site|in-house
refer to: see
segfault: segmentation fault
spawn: create
start up: start
tarball: ".tar file"
thus: therefore
translate: convert|transform
via: through|by|from|on|by using

74
.github/styles/RedHat/TermsWarnings.yml vendored Normal file
View File

@@ -0,0 +1,74 @@
---
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 the term."
action:
name: replace
swap:
"(?:Ctrl|control)-click": press Ctrl and click
"(?<!make the )transition": "make the transition|move|migrate|change"
"bottom(?:-)?left": lower left|lower-left
"bottom(?:-)?right": lower right|lower-right
"non-English(?!-language?)": in languages other than English|non-English-language
'(?<!.-|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
'I(?!/O)': you
'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
desired: needed|required
desire|wish: want|require|need
destroy|destroyed: delete|deleted
double click|double-click on: double-click
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
illegal: invalid|not allowed|incorrect
in order to: to
ingests?: import|load|obtain|process
insure: ensure
invokable: invocable
kill: end|stop
kilobytes?: KB|kB
leverage: use
look at: examine
may: might|can
on-premises|on-prem|on premise: on-premise|on-site|in-house
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
terminate: end|stop
tooling: tool|tools
vs: compared to

View File

@@ -0,0 +1,16 @@
---
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
nonword: true
action:
name: edit
params:
- regex
- "(-)" # pattern
- "_" # replace
tokens:
- '__<[a-z_\x60]+-[\x60a-z_-]+>__'
- '<[a-z_]+-[a-z_-]+>'

14
.github/styles/RedHat/Using.yml vendored Normal file
View File

@@ -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

View File

@@ -0,0 +1,66 @@
{{- /* See https://github.com/errata-ai/vale/issues/614 */ -}}
{{- /* See https://vale.sh/manual/output/ */ -}}
{{- /* Keep track of our various counts */ -}}
{{- $e := 0 -}}
{{- $w := 0 -}}
{{- $s := 0 -}}
{{- $f := 0 -}}
{{- /* Range over the linted files */ -}}
{{- range .Files}}
{{$table := newTable true}}
{{- $f = add1 $f -}}
{{- .Path | underline | indent 1 -}}
{{- "\n" -}}
{{- $msgToLoc := dict -}}
{{- $msgToLvl := dict -}}
{{- $msgToChk := dict -}}
{{- /* Range over the file's alerts */ -}}
{{- range .Alerts -}}
{{- $error := "" -}}
{{- if eq .Severity "error" -}}
{{- $error = .Severity | red -}}
{{- $e = add1 $e -}}
{{- else if eq .Severity "warning" -}}
{{- $error = .Severity | yellow -}}
{{- $w = add1 $w -}}
{{- else -}}
{{- $error = .Severity | blue -}}
{{- $s = add1 $s -}}
{{- end}}
{{- $loc := printf "%d:%d" .Line (index .Span 0) -}}
{{- $locations := get $msgToLoc .Message -}}
{{- $_ := set $msgToLoc .Message (cat $locations $loc) -}}
{{- $_ := set $msgToLvl .Message $error -}}
{{- $_ := set $msgToChk .Message .Check -}}
{{end -}}
{{- range keys $msgToLoc -}}
{{- $msg := . -}}
{{- $loc := trimPrefix "," ((splitList " " (get $msgToLoc $msg)) | join ",") -}}
{{- $lvl := get $msgToLvl $msg -}}
{{- $chk := get $msgToChk $msg -}}
{{- $row := list $loc $lvl $msg $chk | toStrings -}}
{{- $table = addRow $table $row -}}
{{end -}}
{{- $table = renderTable $table -}}
{{end}}
{{- $e}} {{"errors" | red}}, {{$w}} {{"warnings" | yellow}} and {{$s}} {{"suggestions" | blue}} in {{$f}} {{$f | int | plural "file" "files"}}.

4
.github/styles/RedHat/meta.json vendored 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"
}