Added editorial style guide checking.

Signed-off-by: dblock <[email protected]>

.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
 جامد
 جامدات

.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:/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((?<!k-)[A-Z]{1,3}\/?[A-Z]{1,3}\d{0,2}\b(?!\sCommons))'
+second: '(?:\b[A-Za-z-]+ )+\(([A-Z]{1,3}\/?[A-Z]{1,3}\d{0,2})\)'
+# ... with the exception of these:
+exceptions:
+ - AND
+ - API
+ - ASCII
+ - AWS
+ - BASIC
+ - BM25
+ - BY
+ - CAT
+ - CPU
+ - CRUD
+ - CSV
+ - DELETE
+ - DNS
+ - DOS
+ - FAQ
+ - FTP
+ - GB
+ - GET
+ - GIF
+ - GROUP
+ - HAVING
+ - HTML
+ - HTTP
+ - HTTPS
+ - I/O
+ - ID
+ - IP
+ - JPEG
+ - JSON
+ - JVM
+ - KB
+ - MB
+ - N/A
+ - NAT
+ - NGINX
+ - 'NULL'
+ - OR
+ - PB
+ - PDF
+ - PNG
+ - POST
+ - PUT
+ - RAM
+ - REST
+ - RGB
+ - ROM
+ - SAML
+ - SDK
+ - SELECT
+ - SQL
+ - SSL
+ - TB
+ - TCP
+ - TIFF
+ - TLS
+ - TOC
+ - UI
+ - URI
+ - URL
+ - US
+ - UTC
+ - UTF
+ - XML
+ - YAML

.github/vale/styles/OpenSearch/Ampersand.yml

@@ -0,0 +1,6 @@
+extends: existence
+message: "Don't use an ampersand in place of 'and' in documentation."
+nonword: true
+level: warning
+tokens:
+ - '\w +& +\w'

.github/vale/styles/OpenSearch/Cyber.yml

@@ -0,0 +1,5 @@
+extends: existence
+message: "Use 'cyber' as a prefix. Remove spaces or hyphens in '%s'."
+level: error
+tokens:
+ - '[Cc]yber[- ]+[a-z]*'

.github/vale/styles/OpenSearch/DashSpacing.yml

@@ -0,0 +1,9 @@
+extends: existence
+message: "There should be no spaces around the dash in '%s'."
+ignorecase: true
+nonword: true
+level: error
+scope:
+ - ~list
+tokens:
+ - '\w+ +-{2,3} +\w+'

.github/vale/styles/OpenSearch/DirectionAboveBelow.yml

@@ -0,0 +1,22 @@
+extends: substitution
+message: "Use '%s' instead of '%s' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions."
+link: 'https:/opensearch-project/documentation-website/blob/main/TERMS.md'
+level: warning
+ignorecase: true
+swap:
+ - image below: following image
+ - example below: following example
+ - steps below: following steps
+ - section below: following section
+ - table below: following table
+ - image above: following image
+ - example above: preceding example
+ - section above: preceding section
+ - table above: preceding table
+ - above image: preceding image
+ - above section: preceding section
+ - above table: preceding table
+ - '\d+\.\d+\s+(?:and|or)\s+above': later
+ - '\d+\.\d+\s+(?:and|or)\s+below': earlier
+ - 'below(?!\s+(?:the|this|\d))': following or later
+ - 'above(?!\s+(?:the|this|\d))': 'previous, preceding, or earlier'

.github/vale/styles/OpenSearch/DirectionTopBottom.yml

@@ -0,0 +1,16 @@
+extends: substitution
+message: "Use '%s' instead of '%s' for window, page, or pane references to features or controls. Use 'top' and 'bottom' only as a general screen reference."
+link: 'https:/opensearch-project/documentation-website/blob/main/TERMS.md'
+level: warning
+ignorecase: true
+action:
+ name: replace
+swap:
+ - top left: upper left
+ - bottom left: lower left
+ - top right: upper right
+ - bottom right: lower right
+ - top-left: upper-left
+ - bottom-left: lower-left
+ - top-right: upper-right
+ - bottom-right: lower-right

.github/vale/styles/OpenSearch/Exclamation.yml

@@ -0,0 +1,6 @@
+extends: existence
+message: "Don't use exclamation points in documentation."
+nonword: true
+level: error
+tokens:
+ - '\w+!(?:\s|$)'

.github/vale/styles/OpenSearch/FailoverNoun.yml

@@ -0,0 +1,7 @@
+extends: sequence
+message: "Use 'failover' as an adjective or noun instead of '%s'."
+level: error
+ignorecase: true
+tokens:
+ - tag: NN|JJ
+ pattern: '(?:fail over|fail-over)'

.github/vale/styles/OpenSearch/FailoverVerb.yml

@@ -0,0 +1,7 @@
+extends: sequence
+message: "Use 'fail over' as a verb instead of '%s'."
+level: error
+ignorecase: true
+tokens:
+ - tag: VB|VBD|VBG|VBN|VBP|VBZ
+ pattern: '(?:failover|fail-over)'

.github/vale/styles/OpenSearch/FutureTense.yml

@@ -0,0 +1,7 @@
+extends: existence
+message: "'%s' is in future tense. Use present tense in documentation."
+ignorecase: true
+level: suggestion
+scope: raw
+tokens:
+ - '(?:will|is going to|won''t|[A-za-z]+''ll)\s+[a-z]+'

.github/vale/styles/OpenSearch/HeadingAcronyms.yml

@@ -0,0 +1,11 @@
+extends: existence
+message: "'%s': Don't define acronyms in headings."
+link: 'https:/opensearch-project/documentation-website/blob/main/STYLE_GUIDE.md#acronyms'
+level: error
+ignorecase: false
+scope: heading
+nonword: true
+action:
+ name: remove
+tokens:
+ - '\([A-Z]{2,5}\)'

.github/vale/styles/OpenSearch/HeadingCapitalization.yml

@@ -0,0 +1,13 @@
+extends: capitalization
+message: "'%s' is a heading and should be in sentence case."
+level: error
+scope: heading
+match: $sentence
+indicators:
+ - )
+ - .
+ - ':'
+exceptions:
+ - '([A-Z][a-z0-9]+){2,}' # ignores all camel case words
+ - '[A-Z]{2,}' # ignores all acronyms
+ - k # ignores lowercase k-NN

.github/vale/styles/OpenSearch/HeadingColon.yml

@@ -0,0 +1,7 @@
+extends: existence
+message: "Capitalize the word after a colon in '%s'."
+nonword: true
+level: error
+scope: heading
+tokens:
+ - '(?::\s)[a-z]+'

.github/vale/styles/OpenSearch/HeadingPunctuation.yml

@@ -0,0 +1,9 @@
+extends: existence
+message: "Don't use punctuation at the end of a heading."
+nonword: true
+level: error
+scope: heading
+action:
+ name: remove
+tokens:
+ - '[.?!]$'

.github/vale/styles/OpenSearch/Inclusive.yml

@@ -0,0 +1,15 @@
+extends: substitution
+message: "Use '%s' instead of '%s' because the latter is an offensive term."
+link: https:/opensearch-project/documentation-website/blob/main/STYLE_GUIDE.md#offensive-terms
+ignorecase: true
+level: error
+swap:
+ abort: stop, end, or cancel
+ black day: blocked day
+ blacklist: deny list
+ kill: stop, end, clear, remove, or cancel
+ master account: management account
+ master: cluster manager
+ slave: replica, secondary, standby
+ white day: open day
+ whitelist: allow list

.github/vale/styles/OpenSearch/LatinismsElimination.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "Using '%s' is unnecessary. Remove."
+link: https:/opensearch-project/documentation-website/blob/main/STYLE_GUIDE.md#basic-guidelines
+ignorecase: true
+nonword: true
+level: warning
+action:
+ name: remove
+tokens:
+ - '\b(?:etc\.|etc)'

.github/vale/styles/OpenSearch/LatinismsSubstitution.yml

@@ -0,0 +1,15 @@
+extends: substitution
+message: "Use '%s' instead of '%s'."
+link: https:/opensearch-project/documentation-website/blob/main/STYLE_GUIDE.md#basic-guidelines
+ignorecase: false
+level: warning
+nonword: true
+action:
+ name: replace
+swap:
+ '\b(?:eg|e\.g\.)[\s,]': for example or such as
+ '\b(?:ie|i\.e\.)[\s,]': that is or specifically
+ '\bad hoc[\s,.]': one-time
+ '\b(?:v\.|vs\.|vs|versus)\s': compared to or compared with
+ '\bvia\s': using, through, by accessing, or by choosing
+ '\bvice versa': the other way around

.github/vale/styles/OpenSearch/LinksDoubleParentheses.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: "Remove double parentheses from the link '%s'."
+level: error
+nonword: true
+scope: raw
+tokens:
+ - '\]\({2,}[^)]*?\){1,}'
+

.github/vale/styles/OpenSearch/LinksDoubleSlash.yml

@@ -0,0 +1,7 @@
+extends: existence
+message: "Remove double slashes from the link '%s'."
+level: error
+nonword: true
+scope: raw
+tokens:
+ - '\(\{\{site.url\}\}\{\{site.baseurl\}\}[^)]*?\/{2,}[^)]*?\)'

.github/vale/styles/OpenSearch/LinksEndSlash.yml

@@ -0,0 +1,7 @@
+extends: existence
+message: "Add a trailing slash to the link '%s'."
+level: error
+nonword: true
+scope: raw
+tokens:
+ - '\(\{\{site.url\}\}\{\{site.baseurl\}\}(\/[A-Za-z0-9-_]+)+\s*\)'

.github/vale/styles/OpenSearch/LinksMidSlash.yml

@@ -0,0 +1,7 @@
+extends: existence
+message: "Add a slash after '{{site.url}}/{{site.baseurl}}' in '%s'."
+level: error
+nonword: true
+scope: raw
+tokens:
+ - '\(\{\{site.url\}\}\{\{site.baseurl\}\}([^\/])(?:(.*))?\)'

.github/vale/styles/OpenSearch/LoginNoun.yml

@@ -0,0 +1,7 @@
+extends: sequence
+message: "Use 'login' as an adjective or noun instead of '%s'."
+level: error
+ignorecase: true
+tokens:
+ - tag: NN|JJ
+ pattern: '(?:log in|log-in)'

.github/vale/styles/OpenSearch/LoginVerb.yml

@@ -0,0 +1,7 @@
+extends: sequence
+message: "Use 'log in' as a verb instead of '%s'."
+level: error
+ignorecase: true
+tokens:
+ - tag: VB|VBD|VBG|VBN|VBP|VBZ
+ pattern: '(?:login|log into|log on|log onto)'

.github/vale/styles/OpenSearch/LogoutNoun.yml

@@ -0,0 +1,7 @@
+extends: sequence
+message: "Use 'logout' as an adjective or noun instead of '%s'."
+level: error
+ignorecase: true
+tokens:
+ - tag: NN|JJ
+ pattern: '(?:log out)'