Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DO NOT MERGE - WIP Vale #17

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/styles/RedHat/Abbreviations.yml
Original file line number Diff line number Diff line change
@@ -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}'
326 changes: 326 additions & 0 deletions .github/styles/RedHat/CaseSensitiveTerms.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,326 @@
---
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)": 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|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
'\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
'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 view|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 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
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 changes: 14 additions & 0 deletions .github/styles/RedHat/Conjunctions.yml
Original file line number Diff line number Diff line change
@@ -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
13 changes: 13 additions & 0 deletions .github/styles/RedHat/ConsciousLanguage.yml
Original file line number Diff line number Diff line change
@@ -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
Loading