From 9939b4791eebb9e5ecacf03fb4a64819bc8664b3 Mon Sep 17 00:00:00 2001 From: dblock Date: Thu, 17 Oct 2024 12:09:24 -0400 Subject: [PATCH] Added editorial style guide checking. Signed-off-by: dblock --- .cspell | 16 ++ .../styles/OpenSearch/AcronymParentheses.yml | 75 +++++++++ .github/vale/styles/OpenSearch/Ampersand.yml | 6 + .github/vale/styles/OpenSearch/Cyber.yml | 5 + .../vale/styles/OpenSearch/DashSpacing.yml | 9 + .../styles/OpenSearch/DirectionAboveBelow.yml | 22 +++ .../styles/OpenSearch/DirectionTopBottom.yml | 16 ++ .../vale/styles/OpenSearch/Exclamation.yml | 6 + .../vale/styles/OpenSearch/FailoverNoun.yml | 7 + .../vale/styles/OpenSearch/FailoverVerb.yml | 7 + .../vale/styles/OpenSearch/FutureTense.yml | 7 + .../styles/OpenSearch/HeadingAcronyms.yml | 11 ++ .../OpenSearch/HeadingCapitalization.yml | 13 ++ .../vale/styles/OpenSearch/HeadingColon.yml | 7 + .../styles/OpenSearch/HeadingPunctuation.yml | 9 + .github/vale/styles/OpenSearch/Inclusive.yml | 15 ++ .../OpenSearch/LatinismsElimination.yml | 10 ++ .../OpenSearch/LatinismsSubstitution.yml | 15 ++ .../OpenSearch/LinksDoubleParentheses.yml | 8 + .../styles/OpenSearch/LinksDoubleSlash.yml | 7 + .../vale/styles/OpenSearch/LinksEndSlash.yml | 7 + .../vale/styles/OpenSearch/LinksMidSlash.yml | 7 + .github/vale/styles/OpenSearch/LoginNoun.yml | 7 + .github/vale/styles/OpenSearch/LoginVerb.yml | 7 + .github/vale/styles/OpenSearch/LogoutNoun.yml | 7 + .github/vale/styles/OpenSearch/LogoutVerb.yml | 7 + .../vale/styles/OpenSearch/MergeConflicts.yml | 6 + .../vale/styles/OpenSearch/OxfordComma.yml | 7 + .../vale/styles/OpenSearch/PassiveVoice.yml | 45 +++++ .github/vale/styles/OpenSearch/Please.yml | 9 + .github/vale/styles/OpenSearch/Range.yml | 7 + .github/vale/styles/OpenSearch/Repetition.yml | 6 + .../vale/styles/OpenSearch/RolloverNoun.yml | 7 + .../vale/styles/OpenSearch/RolloverVerb.yml | 7 + .github/vale/styles/OpenSearch/SetupNoun.yml | 7 + .github/vale/styles/OpenSearch/SetupVerb.yml | 7 + .../vale/styles/OpenSearch/SignatureV4.yml | 11 ++ .github/vale/styles/OpenSearch/Simple.yml | 10 ++ .../styles/OpenSearch/SpacingPunctuation.yml | 9 + .../vale/styles/OpenSearch/SpacingSlash.yml | 6 + .../vale/styles/OpenSearch/SpacingWords.yml | 6 + .github/vale/styles/OpenSearch/Spelling.yml | 5 + .../styles/OpenSearch/StackedHeadings.yml | 24 +++ .../styles/OpenSearch/SubstitutionsError.yml | 55 +++++++ .../OpenSearch/SubstitutionsSuggestion.yml | 16 ++ .../vale/styles/OpenSearch/TableHeadings.yml | 7 + .../vale/styles/OpenSearch/TimeoutNoun.yml | 7 + .../vale/styles/OpenSearch/TimeoutVerb.yml | 7 + .github/vale/styles/OpenSearch/UnitsNames.yml | 12 ++ .../vale/styles/OpenSearch/UnitsSpacing.yml | 8 + .github/vale/styles/OpenSearch/Version.yml | 6 + .../OpenSearch/acronyms/accept.txt | 1 + .../OpenSearch/acronyms/reject.txt | 1 + .../OpenSearch/plugins/accept.txt | 30 ++++ .../OpenSearch/plugins/reject.txt | 1 + .../OpenSearch/products/accept.txt | 100 +++++++++++ .../OpenSearch/products/reject.txt | 1 + .../vocabularies/OpenSearch/words/accept.txt | 155 ++++++++++++++++++ .../vocabularies/OpenSearch/words/reject.txt | 1 + .github/vale/tests/test-headings.md | 65 ++++++++ .github/vale/tests/test-style-neg.md | 95 +++++++++++ .github/vale/tests/test-style-pos.md | 93 +++++++++++ .github/workflows/lint.yml | 10 +- .vale.ini | 70 ++++++++ 64 files changed, 1232 insertions(+), 1 deletion(-) create mode 100644 .github/vale/styles/OpenSearch/AcronymParentheses.yml create mode 100644 .github/vale/styles/OpenSearch/Ampersand.yml create mode 100644 .github/vale/styles/OpenSearch/Cyber.yml create mode 100644 .github/vale/styles/OpenSearch/DashSpacing.yml create mode 100644 .github/vale/styles/OpenSearch/DirectionAboveBelow.yml create mode 100644 .github/vale/styles/OpenSearch/DirectionTopBottom.yml create mode 100644 .github/vale/styles/OpenSearch/Exclamation.yml create mode 100644 .github/vale/styles/OpenSearch/FailoverNoun.yml create mode 100644 .github/vale/styles/OpenSearch/FailoverVerb.yml create mode 100644 .github/vale/styles/OpenSearch/FutureTense.yml create mode 100644 .github/vale/styles/OpenSearch/HeadingAcronyms.yml create mode 100644 .github/vale/styles/OpenSearch/HeadingCapitalization.yml create mode 100644 .github/vale/styles/OpenSearch/HeadingColon.yml create mode 100644 .github/vale/styles/OpenSearch/HeadingPunctuation.yml create mode 100644 .github/vale/styles/OpenSearch/Inclusive.yml create mode 100644 .github/vale/styles/OpenSearch/LatinismsElimination.yml create mode 100644 .github/vale/styles/OpenSearch/LatinismsSubstitution.yml create mode 100644 .github/vale/styles/OpenSearch/LinksDoubleParentheses.yml create mode 100644 .github/vale/styles/OpenSearch/LinksDoubleSlash.yml create mode 100644 .github/vale/styles/OpenSearch/LinksEndSlash.yml create mode 100644 .github/vale/styles/OpenSearch/LinksMidSlash.yml create mode 100644 .github/vale/styles/OpenSearch/LoginNoun.yml create mode 100644 .github/vale/styles/OpenSearch/LoginVerb.yml create mode 100644 .github/vale/styles/OpenSearch/LogoutNoun.yml create mode 100644 .github/vale/styles/OpenSearch/LogoutVerb.yml create mode 100644 .github/vale/styles/OpenSearch/MergeConflicts.yml create mode 100644 .github/vale/styles/OpenSearch/OxfordComma.yml create mode 100644 .github/vale/styles/OpenSearch/PassiveVoice.yml create mode 100644 .github/vale/styles/OpenSearch/Please.yml create mode 100644 .github/vale/styles/OpenSearch/Range.yml create mode 100644 .github/vale/styles/OpenSearch/Repetition.yml create mode 100644 .github/vale/styles/OpenSearch/RolloverNoun.yml create mode 100644 .github/vale/styles/OpenSearch/RolloverVerb.yml create mode 100644 .github/vale/styles/OpenSearch/SetupNoun.yml create mode 100644 .github/vale/styles/OpenSearch/SetupVerb.yml create mode 100644 .github/vale/styles/OpenSearch/SignatureV4.yml create mode 100644 .github/vale/styles/OpenSearch/Simple.yml create mode 100644 .github/vale/styles/OpenSearch/SpacingPunctuation.yml create mode 100644 .github/vale/styles/OpenSearch/SpacingSlash.yml create mode 100644 .github/vale/styles/OpenSearch/SpacingWords.yml create mode 100644 .github/vale/styles/OpenSearch/Spelling.yml create mode 100644 .github/vale/styles/OpenSearch/StackedHeadings.yml create mode 100644 .github/vale/styles/OpenSearch/SubstitutionsError.yml create mode 100644 .github/vale/styles/OpenSearch/SubstitutionsSuggestion.yml create mode 100644 .github/vale/styles/OpenSearch/TableHeadings.yml create mode 100644 .github/vale/styles/OpenSearch/TimeoutNoun.yml create mode 100644 .github/vale/styles/OpenSearch/TimeoutVerb.yml create mode 100644 .github/vale/styles/OpenSearch/UnitsNames.yml create mode 100644 .github/vale/styles/OpenSearch/UnitsSpacing.yml create mode 100644 .github/vale/styles/OpenSearch/Version.yml create mode 100644 .github/vale/styles/config/vocabularies/OpenSearch/acronyms/accept.txt create mode 100644 .github/vale/styles/config/vocabularies/OpenSearch/acronyms/reject.txt create mode 100644 .github/vale/styles/config/vocabularies/OpenSearch/plugins/accept.txt create mode 100644 .github/vale/styles/config/vocabularies/OpenSearch/plugins/reject.txt create mode 100644 .github/vale/styles/config/vocabularies/OpenSearch/products/accept.txt create mode 100644 .github/vale/styles/config/vocabularies/OpenSearch/products/reject.txt create mode 100644 .github/vale/styles/config/vocabularies/OpenSearch/words/accept.txt create mode 100644 .github/vale/styles/config/vocabularies/OpenSearch/words/reject.txt create mode 100644 .github/vale/tests/test-headings.md create mode 100644 .github/vale/tests/test-style-neg.md create mode 100644 .github/vale/tests/test-style-pos.md create mode 100644 .vale.ini diff --git a/.cspell b/.cspell index 3d9ace5d3..b9555a029 100644 --- a/.cspell +++ b/.cspell @@ -51,10 +51,15 @@ fragmenter Fragmenter freqs generateonbehalfoftoken +geodistance geohash geohex Geohex geoip +geopoint +geoshape +geospacial +geospatial geotile gsub Gsub @@ -65,12 +70,14 @@ homoscedastic hotthreads huggingface hybridfs +ignorecase integ internalusers Intertransport Jelinek kibanainfo kibanaserver +kmeans koelnerphonetik kstem kuromoji @@ -110,6 +117,7 @@ niofs nmslib nodeattrs nodesdn +nonword noops nori Nori @@ -127,7 +135,12 @@ Oversample performanceanalyzer permissionsinfo pipefail +postmigration +preconfigure +preconfigured prefilter +pretrain +pretrained prirep rawfile readingform @@ -182,11 +195,13 @@ termvectors tfidf Tfidf Tika +timeframe tlbr tokenfilters translog Translog trbl +truststore tubone Undeploys unigrams @@ -199,6 +214,7 @@ urldecode vectory whoamiprotected wordnet +yber Yrtsd جامد جامدات \ No newline at end of file diff --git a/.github/vale/styles/OpenSearch/AcronymParentheses.yml b/.github/vale/styles/OpenSearch/AcronymParentheses.yml new file mode 100644 index 000000000..a3deecc01 --- /dev/null +++ b/.github/vale/styles/OpenSearch/AcronymParentheses.yml @@ -0,0 +1,75 @@ +extends: conditional +message: "'%s': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone." +link: 'https://github.com/opensearch-project/documentation-website/blob/main/STYLE_GUIDE.md#acronyms' +level: warning +scope: summary +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b((?