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