Skip to content

Commit

Permalink
Merge branch 'main' into upgrade-specs
Browse files Browse the repository at this point in the history
Signed-off-by: Niyazbek Torekeldi <[email protected]>
  • Loading branch information
Tokesh authored Nov 24, 2024
2 parents af3ba3e + 962452c commit b7a8cae
Show file tree
Hide file tree
Showing 526 changed files with 10,229 additions and 3,292 deletions.
191 changes: 1 addition & 190 deletions .cspell
Original file line number Diff line number Diff line change
@@ -1,199 +1,10 @@
aarch
actiongroup
actiongroups
aggregatable
aoss
APIV
argjson
asciifolding
authc
authinfo
authtoken
autocut
autofollow
backendroles
backpressure
beider
Bobg
Boundsdouble
boxplot
Boxplot
caverphone
CBOR
charfilters
chisquared
chuhlomin
cpuacct
cuserr
daitch
dangoslen
dashboardsinfo
datarows
decompounder
Decompounder
dedup
determinized
distilbert
DNFOF
docvalue
Downsample
downsampling
Downsampling
cbor
evals
ewma
Ewma
faiss
fielddata
Fielddata
forcemerge
Formattable
fragmenter
Fragmenter
freqs
generateonbehalfoftoken
geohash
geohex
Geohex
geoip
geotile
gsub
Gsub
haasephonetik
heteroscedastic
hnsw
homoscedastic
hotthreads
huggingface
hybridfs
integ
internalusers
Intertransport
Jelinek
kibanainfo
kibanaserver
koelnerphonetik
kstem
kuromoji
Kuromoji
languageset
localstats
Lovins
lucene
Lucene
lycheeverse
marvinpinto
memlock
metaphone
mget
millis
Millis
mlockall
mmap
mmapfs
mmdb
mokotoff
Moneyball
msearch
msmarco
mtermvectors
mult
Multisearch
multitenancy
mxyz
nanos
Nanos
nbest
nfkc
ngram
niofs
nmslib
nodeattrs
nodesdn
noops
nori
Nori
nysiis
ONNX
opendistro
opensearch
OPENSEARCH
opensearchproject
opensearchstaging
ords
OSCPU
oversample
Oversample
performanceanalyzer
permissionsinfo
pipefail
prefilter
prirep
rawfile
readingform
rebalance
Rebalance
recoverysource
Refn
reindex
Reindex
relo
reloadcerts
remotestore
rerank
Rerank
Reranker
rethrottle
Rethrottle
rolesmapping
Rolespan
rollup
Rollup
rollups
Rollups
romaji
roundtrips
Rudnick
ruleset
scriptless
securityconfig
slowlog
Slowlog
slurpfile
snapshotted
softmax
Sorani
sslinfo
stoptags
stopwords
Stringifiedboolean
Stringifiedinteger
subqueries
subschemas
subword
syserr
tcnative
tdigest
tenantinfo
termvectors
tfidf
Tfidf
Tika
tokenfilters
translog
Translog
tubone
ulimits
Undeploys
unigrams
Unmanaged
unmatch
untriaged
updateable
upsert
urldecode
vectory
whoamiprotected
wordnet
Yrtsd
reprovision
deprovision
75 changes: 75 additions & 0 deletions .github/vale/styles/OpenSearch/AcronymParentheses.yml
Original file line number Diff line number Diff line change
@@ -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((?<!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
6 changes: 6 additions & 0 deletions .github/vale/styles/OpenSearch/Ampersand.yml
Original file line number Diff line number Diff line change
@@ -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'
5 changes: 5 additions & 0 deletions .github/vale/styles/OpenSearch/Cyber.yml
Original file line number Diff line number Diff line change
@@ -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]*'
9 changes: 9 additions & 0 deletions .github/vale/styles/OpenSearch/DashSpacing.yml
Original file line number Diff line number Diff line change
@@ -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+'
22 changes: 22 additions & 0 deletions .github/vale/styles/OpenSearch/DirectionAboveBelow.yml
Original file line number Diff line number Diff line change
@@ -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://github.com/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'
16 changes: 16 additions & 0 deletions .github/vale/styles/OpenSearch/DirectionTopBottom.yml
Original file line number Diff line number Diff line change
@@ -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://github.com/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
6 changes: 6 additions & 0 deletions .github/vale/styles/OpenSearch/Exclamation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
extends: existence
message: "Don't use exclamation points in documentation."
nonword: true
level: error
tokens:
- '\w+!(?:\s|$)'
7 changes: 7 additions & 0 deletions .github/vale/styles/OpenSearch/FailoverNoun.yml
Original file line number Diff line number Diff line change
@@ -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)'
7 changes: 7 additions & 0 deletions .github/vale/styles/OpenSearch/FailoverVerb.yml
Original file line number Diff line number Diff line change
@@ -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)'
7 changes: 7 additions & 0 deletions .github/vale/styles/OpenSearch/FutureTense.yml
Original file line number Diff line number Diff line change
@@ -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]+'
15 changes: 15 additions & 0 deletions .github/vale/styles/OpenSearch/Inclusive.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
extends: substitution
message: "Use '%s' instead of '%s' because the latter is an offensive term."
link: https://github.com/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
Loading

0 comments on commit b7a8cae

Please sign in to comment.