From bdbdcf6624c11d28aeb01f10ae26e1c8070dcff6 Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Thu, 13 Jul 2023 13:39:34 -0400 Subject: [PATCH] accessible visual language --- .vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc | 3 +++ .vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc | 11 ++++++++++- .vale/styles/RedHat/DoNotUseTerms.yml | 1 + .vale/styles/RedHat/TermsSuggestions.yml | 4 ++-- 4 files changed, 16 insertions(+), 3 deletions(-) diff --git a/.vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc b/.vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc index 03a0ad047..2ef7d2a70 100644 --- a/.vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc +++ b/.vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc @@ -4,6 +4,9 @@ congratulations foo fubar future-proof +green +yellow +blue kerberize kerberized native interface diff --git a/.vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc b/.vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc index 9f57ccc81..bfff5548d 100644 --- a/.vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc +++ b/.vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc @@ -1,4 +1,5 @@ 64-bit x86 +after bare-metal clusters bare-metal compute bare-metal configuration @@ -17,11 +18,19 @@ bare-metal node bare-metal provisioning bare-metal server bare-metal worker +before by by using +earlier +following from information about +later +lower left +lower right on +preceding +previous see this section segmentation fault shell prompt @@ -30,7 +39,7 @@ something against which something else something at which something else something for which something else something from which something else -something in which somehing else +something in which something else something of which something else something on which something else something to which something else diff --git a/.vale/styles/RedHat/DoNotUseTerms.yml b/.vale/styles/RedHat/DoNotUseTerms.yml index 1d2ff1c9a..981cfdeef 100644 --- a/.vale/styles/RedHat/DoNotUseTerms.yml +++ b/.vale/styles/RedHat/DoNotUseTerms.yml @@ -16,6 +16,7 @@ swap: 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".' diff --git a/.vale/styles/RedHat/TermsSuggestions.yml b/.vale/styles/RedHat/TermsSuggestions.yml index 5e9d675ec..361f48fe1 100644 --- a/.vale/styles/RedHat/TermsSuggestions.yml +++ b/.vale/styles/RedHat/TermsSuggestions.yml @@ -21,10 +21,10 @@ swap: '(?