1
0
Fork 0
forked from docs/team-docs

update Vale style

This commit is contained in:
darknao 2023-04-28 10:04:56 +02:00
commit b8ecabe4fb
No known key found for this signature in database
25 changed files with 640 additions and 132 deletions

View file

@ -24,6 +24,8 @@ IgnoredScopes = code, tt, img, url, a, body.id
# For AsciiDoc: by default, listingblock, and literalblock.
SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock
Packages = RedHat
[formats]
# Associate `*.properties` files with the `md` format
properties = md

View file

@ -4,6 +4,6 @@ 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"
# source: "IBM - Periods with abbreviations, p. 5"
tokens:
- '\b(?:[A-Z]\.){3,5}'

View file

@ -4,40 +4,117 @@ 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"
# 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
"(?<!/)var": VAR
# Bind: BIND
'(?<!\.)yaml|Yaml': YAML
'(?<!Business )Resource Planner|(?<!Business Resource )Planner': Business Resource Planner
'(?<!JBoss )EAP|(?<!Red Hat )JBoss(?!\sCommunity|\sBroker|\sClients|\sConsole|\sAMQ|\sData\sGrid|\sBRMS|\sBPMS|\sEnterprise\sApplication\sPlatform|\.org|\sInterconnect|\sEAP|\sBPM\sSuite)': JBoss EAP
'(?<!Microsoft )Azure': Microsoft Azure
'(?<!Microsoft Azure )On-Demand Marketplace': Microsoft Azure On-Demand Marketplace
'(?<!Realtime )Decision\sServer': Realtime Decision Server
'(?<!Red Hat )Customer Portal': Red Hat Customer Portal
'(?<!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
'[nN]odejs|[nN]ode\.JS|node\.js': Node.js
'\s\.Net Core|\s\.Net|\s\.NET\sCore|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
'BPMS|(?<!Red Hat )JBoss BPMS|(?<!Red Hat JBoss )BPM(?! Suite)': Red Hat JBoss BPM Suite
'BRMS\sengine': inference engine
'DM(?![ -]Multipath)|directory manager': Directory Manager
'GUI\seditor|Business\sCentral\seditor': guided editor
'JBoss Broker|Red Hat Broker|The AMQ Broker': AMQ Broker
'JBoss Console|Red Hat Console': AMQ Console
'JBoss\.org': JBoss Community
'JBoss\sAMQ': AMQ
'JBoss\sInterconnect': AMQ Interconnect
'Kernel(?!-based Virtual Machine)': kernel
'Kie(?!\sServer)': KIE
'Kie\sServer': Intelligent Process Server
'O\.K\.D|okd|OpenShift Kubernetes Distribution|OpenShift\sOrigin': OKD
'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
'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
Appliance Console: Appliance console
Applix|ApplixWare: Applixware
asciidoctor|AsciiDoctor: Asciidoctor
asciidoc|Asciidoc: AsciiDoc
assertj|Assertj: AssertJ
auto-link|AutoLink: autolink
basic authentication|Basic Authentication|basic auth|Basic auth|Basic Auth: Basic HTTP authentication (first instance)|Basic authentication
BC: Business Central
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 view|Composite View|composite view: Composite Content View
configmap: config map
configuration map: config map
classic mode: GNOME Classic
Content view|content view: Content View
control key|ctrl: Ctrl
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
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
gb|Gb: GB
gbps|GBPS: Gbps
gb|Gb: GB
GDBTK: Insight
gid|Gid: GID
Gimp|gimp: GIMP
@ -46,98 +123,165 @@ swap:
Gnu|gnu: GNU
Gpl|gpl: GPL
Graalvm|graalVM: GraalVM
Greenboot|green boots: greenboot
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
IA64|ia64: Itanium
IBM z Systems: IBM Z
Ignite|Fuse Ignite: Fuse Online|Red Hat Fuse Online|Syndesis
ignition config: Ignition config
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 image: ISO image
iso: ISO
Itanium2: Itanium 2
JBoss.org: JBoss Community
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: 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
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|Ms-Dos|ms-dos|MSDOS|msdos: MS-DOS
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
openid connect|Openid Connect: OpenID Connect
OCP: Red Hat OpenShift Container Platform
ODF: Red Hat OpenShift Data Foundation
Open InfiniBand|Infiniband: InfiniBand
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
Organization administrator|Org Admin|org admin: Organization Administrator
OS|Operating System: operating system
Overcloud: overcloud
Podman desktop: Podman Desktop
podman: Podman
popup|Pop-up: pop-up
Posix|posix: POSIX
Postscript: PostScript
Powershell|powershell: PowerShell
PPC|P-PC|PPC64: PowerPC
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
Ram|ram: RAM
RAMdisk|ramdisk|RAM-disk: RAM disk
Ram|ram: RAM
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 JBoss Data Grid|JDG: Red Hat Data Grid
Red Hat JBoss EAP: Red Hat JBoss Enterprise Application Platform
Red Hat Network Satellite server: Red Hat Network Satellite Server
Red Hat Proxy: Red Hat Network Proxy Server
Red Hat Satellite Capsule server: Red Hat Satellite Capsule Server
Red Hat Satellite server: Red Hat Satellite Server
Red Hat satellite: Red Hat Satellite
Redboot|Red Boot: RedBoot
redis: Redis
RESTEASY|resteasy|Resteasy: RESTEasy
RHDS: Red Hat Directory Server
RHEL host|RHEL-H: Red Hat Enterprise Linux host
RHV: Red Hat Virtualization
Rom|rom: ROM
rpm: RPM
s-record|S-Record|s-Record|SREC: S-record
S90: IBM S 390
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
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
url: URL
"(?<!/)var": VAR
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
@ -147,7 +291,9 @@ swap:
wca: WCA
web-UI|webUI: web UI
Webauthn|webAuthn|WebAuthN: WebAuthn
websocket|Websocket: WebSocket
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
'(?<!\.)yaml|Yaml': YAML

View file

@ -4,7 +4,7 @@ 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
# source: https://github.com/redhat-documentation/vale-at-red-hat/tree/main/.vale/styles/RedHat/Conjunctions.yml
action:
name: remove
tokens:

View file

@ -4,11 +4,11 @@ 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"
# 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
master(?! broker): primary|source|initiator|requester|controller|host|director|supplier
slave(?! broker): secondary|replica|responder|device|worker|proxy|performer|consumer

View file

@ -4,7 +4,7 @@ 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"
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#contractions"
action:
name: replace
swap:

View file

@ -4,17 +4,18 @@ 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"
# 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?'
- 'NULL'
- 'GIDs?'
- 'NULL'
- 'PIDs?'
- 'ROMs?'
- 'RPMs?'
@ -23,14 +24,17 @@ exceptions:
- 'URLs?'
- ACPI
- AIX
- API
- ARM
- ASCII
- ASP
- AWS
- BIND
- BIOS
- BMC
- CD
- CIDR
- CLI
- CNAME
- CSS
- CSV
- CUPS
@ -54,6 +58,7 @@ exceptions:
- GCJ
- GDB
- GET
- GIF
- GIMP
- GNOME
- GNU
@ -63,10 +68,12 @@ exceptions:
- GRUB
- GTK+
- GUI
- GUID
- HP
- HTML
- HTTP
- HTTPS
- IAM
- IBM
- IDE
- IOPS
@ -75,6 +82,7 @@ exceptions:
- ISO
- IT
- JAR
- JPEG
- JSON
- JSX
- JVM
@ -105,12 +113,13 @@ exceptions:
- OSS
- PATH
- PC
- POSIX
- PDF
- PHP
- PIN
- PPP
- PNG
- POSIX
- POST
- PPP
- PROM
- PXE
- QCOW2
@ -118,6 +127,7 @@ exceptions:
- RADOS
- RAID
- RAM
- RBAC
- RBD
- REPL
- REST
@ -125,6 +135,7 @@ exceptions:
- RGW
- RHEL
- RSA
- SAML
- SAP
- SCM
- SCSI
@ -135,10 +146,12 @@ exceptions:
- SOCKS
- SPEC
- SQL
- SSD
- SSH
- SSL
- SSSD
- SVG
- SVN
- SWAT
- TBD
- TCP
@ -156,6 +169,7 @@ exceptions:
- VDO
- VDSM
- VGA
- VLAN
- VNC
- VPN
- WAN
@ -166,3 +180,4 @@ exceptions:
- YAML
- YUM
- ZIP
- ZTP

View file

@ -4,7 +4,7 @@ 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"
# source: "IBM - Ellipses, p.49"
action:
name: remove
tokens:

View file

@ -5,7 +5,7 @@ link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference
message: "Do not use end punctuation in headings."
nonword: true
scope: heading
source: "IBM - Periods in headings and titles, p. 61"
# source: "IBM - Periods in headings and titles, p. 61"
action:
name: edit
params:

View file

@ -5,29 +5,40 @@ link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference
match: $sentence
message: "Use sentence-style capitalization in '%s'."
scope: heading
source: "IBM - Capitalization in headings and titles, p.16"
# source: "IBM - Capitalization in headings and titles, p.16"
indicators:
- ":"
exceptions:
- API
- AWS
- Agroal
- Annobin
- Ansible
- Antora
- API
- AppData
- AsciiDoc
- Asciidoctor
- AWS
- AssertJ
- Azure
- Basic authentication
- Basic HTTP authentication
- BOM
- Bierner
- Bitbucket
- Bonjour
- Bouncy Castle
- Btrfs
- Bugzilla
- CDs
- CR
- CRD
- CRDs
- CRs
- Camel
- CapEx
- CDs
- CentOS
- Ceph
- cgroup
- Certificate Authorities
- Che-Theia
- Ciphertext
- Civetweb
@ -42,73 +53,84 @@ exceptions:
- Containerfile
- Containerfiles
- Cookiecutter
- CR
- CRD
- CRDs
- CRs
- Ctrl
- Cygmon
- DNS
- DaemonSet
- Datadog
- Dev
- DevOps
- DevWorkspace
- Dex
- DNS
- Docker
- Dockerfile
- Dockerfiles
- Dotnet
- Eclipse
- Dyninst
- Eclipse
- Electron
- Endevor
- Endian
- eServer
- Esprima
- Exif
- Fabrice
- Failsafe
- Fernflower
- Flathub
- Flatpak
- Flatpak Builder
- Fortran
- Funqy
- GCC
- GTKplus
- GUI
- Git
- GitHub
- GitHub Action
- GitLab
- GitLab Code Quality
- Gluster
- GraalVM
- Gradle
- GraphQL
- Grayscale
- GTKplus
- GUI
- GTK
- HTTP
- HTTPS
- Hashicorp
- Helgrind
- Helm
- Hibernate
- Homebrew
- HTTP
- HTTPS
- IBM
- IBM Cloud
- ID
- IDE
- IDEs
- IDs
- IPSec
- ISeries
- InfiniBand
- Infinispan
- Intelephense
- IntelliJ
- IPSec
- ISeries
- Itanium
- JAR file
- JBang
- JUnit
- JVM
- Jakarta
- Jandex
- Java
- Jave
- JetBrains
- Jira
- Jolokia
- Joyent
- JUnit
- JVM
- Kibana
- Kind
- Knative
- Knowledgebase
- Kogito
- Kompose
- Kubespray
@ -125,82 +147,101 @@ exceptions:
- Minikube
- Minishift
- Mirantis
- Mockito
- MongoDB
- mutual TLS
- MySQL
- Nagios
- Narayana
- Neoverse
- NetcoredebugOutput
- Netty
- Newdoc
- Nginx
- Node.js
- NuGet
- OAuth
- ORM
- OmniSharp
- OpEx
- OpenID Connect
- OpenJDK
- OpenRewrite
- OpenShift
- OpenTracing
- OpEx
- ORM
- PHP
- Podman
- PostgreSQL
- Podman Desktop
- PostScript
- PostgreSQL
- PowerPC
- PowerShell
- Productize
- Productized
- Proof Key for Code Exchange
- Prometheus
- Proof Key for Code Exchange
- Pytorch
- qeth
- Qt
- Quarkiverse
- Quarkus
- Quiltflower
- Qute
- RESTEasy
- Red Hat
- RedBoot
- Redis
- Redistributions
- RESTEasy
- Rolfe
- Sakila
- SCM
- SDK
- SELinux
- SVG
- Sakila
- Semeru
- SmallRye
- Shadowman
- SmallRye
- Software Development Kit
- Software Development Kits
- Spotify
- StarOffice
- startx
- Suchow
- SVG
- System
- SysV
- System
- Technology Preview
- Tekton
- Telekom
- Tensorflow
- Texinfo
- Toolset
- Traefik
- Uber
- UltraSPARC
- URI
- URIs
- URL
- URLs
- Uber
- UltraSPARC
- Vale
- Valgrind
- Velero
- Vert.x
- vNIC
- vNUMA
- WebAuthn
- WebSocket
- Webview
- Webviews
- Wildfly
- Window Maker
- Windows
- Windows Subsystem for Linux
- Woopra
- Wordpress
- XEmacs
- xterm
- Yana
- Yeoman
- Zowe
- GitLab Code Quality
- cgroup
- eServer
- mutual TLS
- mTLS
- qeth
- startx
- vNIC
- vNUMA
- xterm

View file

@ -3,6 +3,6 @@ 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"
# source: "IBM - Commas between clauses, p.45"
tokens:
- '(?:[^,]+,){1,}\s\w+\sand'

View file

@ -0,0 +1,179 @@
---
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
- 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
- KiB
- LangTags
- LGPLv
- libOSMesa
- LibreOffice
- libXNVCtrl
- LightPulse
- LinuxONE
- LiquidIO
- ManageIQ
- MariaDB
- MegaRAID
- MiB
- MicroProfile
- MongoDB
- MoreUtils
- MySQL
- NetBIOS
- NetcoredebugOutput
- NetWeaver
- NetworkManager
- NetXen
- NetXtreme
- NFSv
- NuGet
- NVidia
- NVMe
- OAuth
- objectClass
- OmniSharp
- OneConnect
- OpenEXR
- OpenID
- OpenIPMI
- OpenJDK
- OpenRewrite
- OpenSCAP
- OpenShift
- OpenSSH
- OpenSSL
- OpenStack
- OpenTracing
- OperatorHub
- OpEx
- OSBuild
- 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
- TiB
- TuneD
- TypeScript
- UltraSPARC
- USBGuard
- vDisk
- vHost
- vSphere
- WebAuthn
- WebSocket
- WireGuard
- XEmacs
- xPaaS
- XString
- XWayland
- YouTube
- ZCentral

View file

@ -3,8 +3,8 @@ 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"
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:

View file

@ -4,7 +4,7 @@ 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"
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#release-notes"
# swap maps tokens in form of bad: good
swap:
Now: With this update

View file

@ -4,7 +4,7 @@ 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"
# source: "IBM - Audience and medium, p. 22"
tokens:
- this topic
- this module

View file

@ -4,6 +4,6 @@ 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"
# source: "IBM - Conversational style"
max: 32
token: \b(\w+)\b

View file

@ -4,7 +4,7 @@ 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"
# source: "IBM - Conversational style; http://www.plainlanguage.gov/howto/wordsuggestions/simplewords.cfm"
swap:
"approximate(?:ly)?": about
"objective(?! C?)": aim|goal

View file

@ -4,7 +4,7 @@ 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"
# source: "IBM - Slashes, p. 68"
tokens:
- '(?<!/)\w+/\w+'
exceptions:

View file

@ -4,7 +4,7 @@ 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
# source: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
tokens:
- "[a-z][.?!] {2,}[A-Z]"
- "[a-z][.?!][A-Z]"

View file

@ -1,18 +1,21 @@
#file: noinspection IncorrectFormatting
---
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/
# 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]ccessor"
- "[aA]llowlist"
- "[aA]utostart"
- "[bB]ackfilling"
- "[bB]ackported"
- "[bB]acktrace"
- "[bB]indable"
- "[bB]oolean"
@ -22,6 +25,11 @@ filters:
- "[cC]lassloading"
- "[cC]olocate"
- "[cC]onfig"
- "[dD]eclaratively"
- "[dD]ecompiler"
- "[dD]eserialization"
- "[dD]esynchronize"
- "[dD]esynchronized"
- "[dD]ev[wW]orkspace"
- "[dD]evfile"
- "[dD]evfiles"
@ -35,6 +43,7 @@ filters:
- "[gG]bps"
- "[gG]it"
- "[gG]rafana"
- "[hH]ardcoding"
- "[hH]eatmap"
- "[hH]ostname"
- "[hH]yperconverged"
@ -53,6 +62,7 @@ filters:
- "[lL]oopback"
- "[mM]atrixes"
- "[mM]ebibytes"
- "[mM]iddleware"
- "[mM]illicores"
- "[mM]ixin"
- "[mM]ixins"
@ -68,9 +78,12 @@ filters:
- "[nN]amespaces"
- "[oO]nboarding"
- "[oO]perator"
- "[oO]verridable"
- "[pP]reconfigured"
- "[pP]regenerated"
- "[pP]ulldown"
- "[pP]repend"
- "[pP]repended"
- "[pP]roductize"
- "[pP]roductized"
- "[rR]eadonly"
@ -96,8 +109,12 @@ filters:
- "[rR]untimes"
- "[sS]crollbar"
- "[sS]erializer"
- "[sS]erialization"
- "[sS]erializable"
- "[sS]erverless"
- "[sS]ervlet"
- "[sS]harding"
- "[sS]ysctl"
- "[Ss]u"
- "[sS]ubcommand"
- "[sS]ubcommands"
@ -118,6 +135,7 @@ filters:
- "[sS]ubvolume"
- "[sS]ubvolumes"
- "[sS]ystemd"
- "[tT]emplated"
- "[tT]heia"
- "[tT]olerations"
- "[tT]raceback"
@ -132,21 +150,31 @@ filters:
- "[uU]ntrusted"
- "[uU]psell"
- "[uU]pselling"
- "Let\'s Encrypt"
- "[vV]alidator"
- "Let\\'s Encrypt"
- adoc
- AGPLv
- Agroal
- Annobin
- Ansible
- Antora
- API
- Applixware
- Asciidoctor
- AssertJ
- autolink
- aws
- AWS
- Azure
- Bierner
- Bitbucket
- BOM
- Bonjour
- Bouncy Castle
- btn
- Btrfs
- Bugzilla
- camelCase
- CentOS
- Ceph
- cephfs
@ -159,17 +187,20 @@ filters:
- Cloudbursting
- Cloudwashing
- CodeReady
- ConfigMap
- ConfigMaps
- ConfigMaps?
- Containerfile
- Containerfiles
- Cookiecutter
- CPUs
- CR
- CRD
- CRDs
- CRs
- CSIDriver
- CSINode
- CSVs
- Ctrl
- CVEs
- Cygmon
- DaemonSet
- Datadog
@ -185,18 +216,33 @@ filters:
- Endevor
- Endian
- endif
- eServer
- Esprima
- etcd
- Exif
- extranet
- Fabrice
- Facter
- Failsafe
- FDs
- Fernflower
- firewalld
- Flathub
- Flatpak
- Fortran
- Funqy
- GCC
- GIDs
- GitHub
- GitLab
- Gluster
- Gradle
- Grayscale
- GNUPro
- GraalVM
- Gradle
- GraphQL
- greenboot
- Grayscale
- GTIDs?
- GUI
- Hashicorp
- Helgrind
@ -209,13 +255,22 @@ filters:
- HTTPS
- IDE
- IDEs
- IKEv
- Infinispan
- Intelephense
- IntelliJ
- IPsec
- ISeries
- IPPool
- IPsec
- IPv
- ISVs
- Itanium
- Jakarta
- Jandex
- Java
- Jave
- JBang
- JBoss
- Jira
- Jolokia
@ -225,69 +280,101 @@ filters:
- JVM
- Kafka
- kbd
- keystore
- Kibana
- Knative
- knowledgebase
- Knowledgebase
- Kogito
- Kompose
- kubelet
- Kubespray
- Kylin
- Laravel
- LGPLv
- librados
- librbd
- libOSMesa
- Lombok
- Makefile
- Mattermost
- Maven
- MicroProfile
- Microsoft
- Middleware
- Minikube
- Minishift
- Mirantis
- Mockito
- MongoDB
- Multipath
- MySQL
- Nagios
- Narayana
- Neoverse
- NetcoredebugOutput
- Netty
- Newdoc
- NFSv
- Nginx
- npm
- NuGet
- NVidia
- NVMe
- OAuth
- objectClass
- ocp
- OmniSharp
- OpenID
- OpenJDK
- OpenRewrite
- OpenShift
- OpenTracing
- OSBuild
- osd
- OSs
- PCIe
- PDFs?
- PHP
- PIDs
- Podman
- PostgreSQL
- preconfigured
- prepended
- PowerShell
- Prometheus
- proxied
- Pytorch
- qdmanage
- qdstat
- qeth
- QLogic
- Quarkiverse
- Quarkus
- Quiltflower
- Qute
- Realtime
- Redis
- Redistributions
- Restic
- relaxngDatatype
- RESTEasy
- Restic
- Rolfe
- Rollup
- ROMs
- rootful
- rootless
- RPMs
- Sakila
- sbt
- SCM
- SELinux
- Semeru
- SLAs
- Shadowman
- SLAs
- SmallRye
- Spotify
- startx
- STMicroelectronics
- Suchow
- Symfony
- SVG
- Symfony
- Tekton
- Telekom
- Tensorflow
@ -295,22 +382,29 @@ filters:
- Toolset
- Traefik
- Uber
- URI
- URIs
- UIDs
- URIs?
- url
- URL
- URLs
- URLs?
- USBGuard
- Vale
- Valgrind
- vDisk
- Velero
- Vert.x
- vHost
- VMs
- vsix
- vSphere
- WebAuthn
- Webview
- Webviews
- Webpack
- WebSocket
- Wildfly
- Woopra
- Wordpress
- XString
- XWayland
- Yana
- Yeoman
- ZCentral
- Zowe

View file

@ -4,27 +4,27 @@ 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"
# 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
"[bB]asic [aA]uth": Basic HTTP authentication (first instance)|Basic authentication
"a lot(?: of)?": many|much
"AI": Assisted Installer
"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
"IPI": installer-provisioned infrastructure
"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
@ -32,7 +32,19 @@ swap:
"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
# "app(?:.)": app
'(?<!\/)etc(?!\/)': and so on
'(?<!IBM\s)S\/390|S90|S\s390': IBM S/390
'(?<!self-)hosted engine(?! host)|hosted-engine(?! host)': self-hosted engine
'(?<!virtual )floppy disk': diskette|diskette drive
'(?<!virtual )floppy drive': diskette|diskette drive
'(?<!virtual )floppy(?!\sdisk|\sdrive)': diskette|diskette drive
'(?<!virtual )hard drive': hard disk|hard disk drive
'\b(?:eg|e\.g\.)[\s,]': for example
'\b(?:ie|i\.e\.)[\s,]': that is
'fixed\sdisk\sdrive': hard disk drive
'virtual\shard\sdisk': virtual hard drive
a number of: several
abort: cancel|stop
administrate: administer
@ -56,6 +68,7 @@ swap:
breadcrumbing: breadcrumb trail
bugfix: bug fix
builtin|built in: built-in
byte code: bytecode
canned: preplanned|preconfigured|predefined
case insensitive: not case-sensitive
catastrophic error: unrecoverable error
@ -75,12 +88,11 @@ swap:
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
computer farm|computer ranch: server cluster|server farm
connect with: connect to
container based: container-based
containerised: containerized
@ -88,7 +100,6 @@ swap:
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
@ -101,15 +112,18 @@ swap:
deinstallation: uninstallation
demilitarized zone: DMZ
demon: daemon
deployment configuration: deployment
depress: press|type
deregister: unregister
desire: want|required
desire|wish: need
desk top|desk-top: desktop
destroy: delete from the database
details pane: details view
different than|different to: different from
disklabel|disk-label: disk label
dismount: demount|unmount|remove
domain mode: managed domain
domainname|domain-name: domain name
down-load|down load: download
down-stream|down stream: downstream
@ -123,32 +137,27 @@ swap:
emphasise: emphasize
end user: user
end-user interface: graphical interface|interface
enum: data enumeration
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
hosted engine host|hosted-engine host|self-hosted engine host|(?<!self-)hosted engine node|hosted-engine node: self-hosted engine node
hostgroup: host group
hot-line: hotline
hotadd|hot-add: hot add
@ -165,12 +174,10 @@ swap:
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
@ -183,6 +190,9 @@ swap:
leverage: use
line cord: power cable|power cord
Linux specific|chip specific: specific
live broker: master broker
live only: live-only
load-balance|load-balancing: load balance
look at: examine
lots of|bunches of: many
main directory: root directory
@ -195,6 +205,7 @@ swap:
motherboard: system board
mouse over: point to|move the mouse pointer over
mouse-button|mousebutton: mouse button
multi site|multi-site: multisite
multi-processing: multiprocessing
multi-tenant: multitenant
network-centric computing: network computing
@ -209,6 +220,7 @@ swap:
on the other hand: however|alternatively|conversely
on-ramp: access method
op-code: opcode
openshit: OpenShift
open-source|OpenSource|opensource: open source
organise: organize
organised: organized
@ -216,10 +228,12 @@ swap:
over-ride|over ride: override
pain point: challenge|concern|difficulty|issue
parent task: parent process
passive broker: slave broker
perfcounter: performance counter
perimeter network: DMZ
plaintext|plain-text|cleartext|clear text: plain text
plug in|plug ins: plugin
pojo: data model
power down: turn off
power off: turn off
power on: turn on
@ -230,6 +244,7 @@ swap:
pseudo ops|pseudoops: pseudo-ops
pull-down: pulldown
recognise: recognize
regex: regular expression
remote-access server: remote access server
remote-access: remote access
right double-click: double right-click
@ -238,7 +253,8 @@ swap:
round table: roundtable
rule of thumb: rule
run level|run-level: runlevel
sanity check: test|evaluate
sanity check: test|evaluate|validate|verify
sanity test: test|evaluate|validate|verify
screensaver: screen saver
scroll bar|scroll-bar: scrollbar
secondary storage: auxiliary storage
@ -252,12 +268,15 @@ swap:
single quote mark: single quotation mark
single quote: single quotation mark
SME routine: session management exit routine
snapset|snapsets: snapshot set
soundcard|sound-card: sound card
specfile: spec file
spelt: spelled
stand-alone: standalone
standalone mode: standalone server
start up: start
straight forward|straight-forward: straightforward
sub version|(?<!Apache )Subversion: sub-version
sub-command: subcommand
sub-directory: subdirectory
sub-menu: submenu
@ -267,23 +286,25 @@ swap:
swapspace: swap space
switch off: turn off
switch on: turn on
sysprep tool|sysprep process|sysprep function: sysprep
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
thru: through|throughput
thumbstick: USB flash drive
thus: therefore
tier-one|tier 1: tier-1
timeframe|time-frame: time frame
toggle off: toggle
touchscreen: touch-sensitive screen
trust store: truststore
typo: typing error|typographical error
uncheck: clear
uncompress: decompress
undeploy: remove|withdraw
unjar: extract
unselect: clear|deselect
untar: extract
unzip: extract|decompress
@ -296,9 +317,13 @@ swap:
utilize: use
versus: compared to
video-mode|videomode: video mode
virtual diskette drive: virtual floppy drive
virtual diskette: virtual floppy disk
vs: compared to
warning notice: attention notice
web-enable: enable for the web
wish: want
wish|would like: want
xsite: cross-site replication
zero out: zero
zonegroup|zone-group: zone group

View file

@ -4,33 +4,38 @@ 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"
# 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)"
"(?<!by) using": by using|that uses
"(?<!such )as": because|while
", that": ", which (non restrictive clause preceded by a comma)|that (restrictive clause without a comma)"
"[Bb]are metal|[Bb]are-metal(?! clusters?| compute| configuration| controls?| environments?| equipment| events?| hardware| hosts?| infrastructure| installations?| installers?| machines?| media| nodes?| provisioning| servers?| workers?)": bare metal (noun)|bare-metal (adjective)
"shell(?! prompt| script)": shell prompt
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"
Bps|bps: Bps (bytes per second)|bps (bits per second)
CD|cd: cd (change directory command)|CD (compact disc)
channel: repository
client side|client-side: client-side (adjective)| client side (noun)
Cloud: cloud
code: write
crash: fail|lock up|stop|stop responding
functionality: functions # IBM
Hammer|x86_64|x86-64|x64|64-bit x86: AMD64
input|type: enter (followed by the text to enter in monospace) # https://redhat-documentation.github.io/supplementary-style-guide/#text-entry
jar: compress|archive (verb)
Navigate|navigate: '"click", "select", "browse", or "go to"'
recommend: direct users to take the recommended action
refer to: see
roll-out|roll out|rollout: roll out (verb)|rollout (noun)
Router: AMQ Interconnect
segfault: segmentation fault
tar: compress|archive
thru|through: "' - ' (range)|by using|finished|completed"
unjar: extract (verb)
user space|userspace|user-space: user space (noun)| user-space (modifier)
zip: compress
Navigate|navigate: '"click", "select", "browse", or "go to"'
information on: information about

View file

@ -3,18 +3,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"
message: "Consider using '%s' rather than '%s' unless updating existing content that uses the term."
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
action:
name: replace
swap:
CRUD: create, retrieve, update, and delete (CRUD)
"I(?!/O)": you
he|she: you
host name: hostname
may: might (for possiblity)|can (for ability)
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
sane: accurate|valid|verified
tooling: tool|tools
via: through|by|from|on|by using
BIOS: firmware

View file

@ -4,7 +4,7 @@ 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"
# 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)?"
@ -30,7 +30,6 @@ tokens:
- bring up
- business partner
- cache
- camel case
- carry out
- catch
- central processing unit
@ -55,7 +54,6 @@ tokens:
- display
- domestic
- done
- due to
- either
- EPUB
- execute
@ -95,7 +93,7 @@ tokens:
- localize
- look and feel
- look-and-feel
- "(?<!virtual )machine(?! learning)"
- "(?<!virtual |Podman )machine(?! learning)"
- master and slave
- migrate
- native
@ -117,6 +115,7 @@ tokens:
- reside
- respective
- respectively
- sanity
- select
- selected
- should

View file

@ -1,5 +1,5 @@
---
source: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/userreplacedvalues/
# source: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/userreplacedvalues/
extends: substitution
message: '%s, rather than %s'
level: suggestion