Skip to content

Commit

Permalink
Merge pull request opensearch-project#1810 from kolchfa-aws/style-upd…
Browse files Browse the repository at this point in the history
…ate-2

Add a sigv4 rule and more words to style workflow
  • Loading branch information
kolchfa-aws authored Jul 31, 2023
2 parents b8a5fff + 7537f6b commit a6e5ab9
Show file tree
Hide file tree
Showing 9 changed files with 36 additions and 5 deletions.
7 changes: 6 additions & 1 deletion .github/vale/styles/OpenSearch/HeadingCapitalization.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@ extends: capitalization
message: "'%s' is a heading and should be in sentence case."
level: error
scope: heading
match: $sentence
match: $sentence
threshold: 1
indicators:
- ":"
exceptions:
- k # ignores lowercase k-NN
10 changes: 10 additions & 0 deletions .github/vale/styles/OpenSearch/SignatureV4.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
extends: substitution
message: "'%s': Use 'AWS Signature Version 4' instead of '%s' on first appearance. Then, Signature Version 4 may be used. Only use SigV4 when space is limited."
ignorecase: true
link: 'https://github.com/opensearch-project/documentation-website/blob/main/TERMS.md'
level: warning
action:
name: replace
swap:
sigv4: Signature Version 4
AWS sigv4: AWS Signature Version 4
4 changes: 4 additions & 0 deletions .github/vale/styles/OpenSearch/SubstitutionsError.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,13 @@ swap:
'data set': dataset
'for information on': for information about
'for more information on': for more information about
'geo bounds': geobounds
'geo distance': geodistance
'geo hash': geohash
'geo hex': geohex
'geo point': geopoint
'geo shape': geoshape
'geo tile': geotile
'geospacial': geospatial
'hard code': hardcode
'high-performance computing': high performance computing
Expand Down
2 changes: 2 additions & 0 deletions .github/vale/styles/OpenSearch/TableHeadings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ message: "'%s' is a table heading and should be in sentence case."
level: error
scope: table.header
match: $sentence
exceptions:
- k # ignores lowercase k-NN
1 change: 1 addition & 0 deletions .github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Alerting plugin
Anomaly Detection plugin
Asynchronous Search plugin
Cross-Cluster Replication plugin
Crypto plugin
Maps plugin
Notebooks plugin
Notifications plugin
Expand Down
2 changes: 1 addition & 1 deletion .github/vale/styles/Vocab/OpenSearch/Products/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ Okta
Open Distro
OpenID Connect
OpenSearch
OpenSearch Benchmark
OpenSearch Dashboards
OpenSearch Project
OpenSearch Service
Expand Down Expand Up @@ -143,7 +144,6 @@ Searchium
Searchium.ai
Sease
Serverless
SigV4
Simple Schema for Observability
SnappyFlow
SquareShift
Expand Down
10 changes: 8 additions & 2 deletions .github/vale/styles/Vocab/OpenSearch/Words/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[Aa]utopopulate
[Aa]utoscaler?
[Bb]ackoff
[Bb]ackport
[Bb]ackport(s|ing)?
[Bb]ackpressure
[Bb]asemap
[Bb]igram
Expand All @@ -16,6 +16,7 @@ Boolean
[Cc]onfig
[Cc]ron
[Cc]ybersecurity
[Dd]ashboarding
[Dd]atagram
[Dd]eallocate
[Dd]eduplication
Expand Down Expand Up @@ -53,12 +54,14 @@ k-NN
[Kk]eystore
kibibyte
mebibyte
[Ll]earnings
[Ll]emmatization
Levenshtein
[Ll]inestring
[Ll]ookups?
[Ll]ossy
[Ll]owercases?d?
[Mm]acrobenchmarks?
[Mm]isorder
[Mm]odularization
[Mm]ultifield
Expand Down Expand Up @@ -88,19 +91,22 @@ pebibyte
[Rr]eindex
[Rr]eingest
[Rr]epo
[Rr]erank
[Rr]erank(er|ed|ing)?
[Rr]erankers?
[Rr]ewriters?
[Rr]ollout
[Rr]ollup
[Rr]unbooks?
[Ss]erverless
[Ss]harding
[Ss]ignificand
stdout
[Ss]ubaggregation
[Ss]ubcalculation
[Ss]ubcommands?
[Ss]ubfield
[Ss]ubquery
[Ss]ubstrings?
[Ss]ubtag
[Ss]ubtree
[Ss]ubvector
Expand Down
1 change: 1 addition & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ OpenSearch.RolloverNoun = YES
OpenSearch.RolloverVerb = YES
OpenSearch.SetupNoun = YES
OpenSearch.SetupVerb = YES
OpenSearch.SignatureV4 = YES
OpenSearch.SpacingPunctuation = YES
OpenSearch.SpacingSlash = YES
OpenSearch.SpacingWords = YES
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,6 @@ Optimizing the number and size of shards in your index can help you get the best

If you prefer to learn about this topic in video format instead of a blog post, check out this YouTube video: [OpenSearch - How to change the number of primary and replica shard(s) of an index](https://www.youtube.com/watch?v=xadv93LlbY4). This blog post is based on this GitHub repository: [OpenSearch_Read_Only_Index](https://github.com/ev2900/OpenSearch_Read_Only_Index)

If you are using Amazon OpenSearch Service (that is, the managed service), the AWS documentation also has information on index shard sizes. The [operational best practices shard strategy](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/bp.html#bp-sharding-strategy) section includes recommendations specific to the AWS managed service.
If you are using Amazon OpenSearch Service (that is, the managed service), the AWS documentation also has information on index shard sizes. The [operational best practices shard strategy](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/bp.html#bp-sharding-strategy) section includes recommendations specific to the AWS managed service.

Backports to our repo

0 comments on commit a6e5ab9

Please sign in to comment.