From 6dfe8d31f3787801d4fff012a5c947d67660c516 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Thu, 20 Jul 2023 17:35:02 -0400 Subject: [PATCH 1/2] Add a sigv4 rule and more words to style workflow Signed-off-by: Fanit Kolchina --- .../vale/styles/OpenSearch/HeadingCapitalization.yml | 7 ++++++- .github/vale/styles/OpenSearch/SignatureV4.yml | 10 ++++++++++ .github/vale/styles/OpenSearch/SubstitutionsError.yml | 4 ++++ .github/vale/styles/OpenSearch/TableHeadings.yml | 2 ++ .../vale/styles/Vocab/OpenSearch/Plugins/accept.txt | 1 + .../vale/styles/Vocab/OpenSearch/Products/accept.txt | 2 +- .github/vale/styles/Vocab/OpenSearch/Words/accept.txt | 7 +++++-- .vale.ini | 1 + ...07-06-optimize-opensearch-index-shard-size.markdown | 4 +++- 9 files changed, 33 insertions(+), 5 deletions(-) create mode 100644 .github/vale/styles/OpenSearch/SignatureV4.yml diff --git a/.github/vale/styles/OpenSearch/HeadingCapitalization.yml b/.github/vale/styles/OpenSearch/HeadingCapitalization.yml index 28ff0aa023..a6b80b9d75 100644 --- a/.github/vale/styles/OpenSearch/HeadingCapitalization.yml +++ b/.github/vale/styles/OpenSearch/HeadingCapitalization.yml @@ -2,4 +2,9 @@ extends: capitalization message: "'%s' is a heading and should be in sentence case." level: error scope: heading -match: $sentence \ No newline at end of file +match: $sentence +threshold: 1 +indicators: + - ":" +exceptions: + - k # ignores lowercase k-NN \ No newline at end of file diff --git a/.github/vale/styles/OpenSearch/SignatureV4.yml b/.github/vale/styles/OpenSearch/SignatureV4.yml new file mode 100644 index 0000000000..a8c241c902 --- /dev/null +++ b/.github/vale/styles/OpenSearch/SignatureV4.yml @@ -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 \ No newline at end of file diff --git a/.github/vale/styles/OpenSearch/SubstitutionsError.yml b/.github/vale/styles/OpenSearch/SubstitutionsError.yml index 095f27120f..76ee5a7538 100644 --- a/.github/vale/styles/OpenSearch/SubstitutionsError.yml +++ b/.github/vale/styles/OpenSearch/SubstitutionsError.yml @@ -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 diff --git a/.github/vale/styles/OpenSearch/TableHeadings.yml b/.github/vale/styles/OpenSearch/TableHeadings.yml index 49e1e96f99..0a8572d47a 100644 --- a/.github/vale/styles/OpenSearch/TableHeadings.yml +++ b/.github/vale/styles/OpenSearch/TableHeadings.yml @@ -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 \ No newline at end of file diff --git a/.github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt index 76ebfc1b48..784a7fb6d0 100644 --- a/.github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt +++ b/.github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt @@ -2,6 +2,7 @@ Alerting plugin Anomaly Detection plugin Asynchronous Search plugin Cross-Cluster Replication plugin +Crypto plugin Maps plugin Notebooks plugin Notifications plugin diff --git a/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt index 0586f9151e..8f7eb7e0a4 100644 --- a/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt +++ b/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt @@ -105,6 +105,7 @@ Okta Open Distro OpenID Connect OpenSearch +OpenSearch Benchmark OpenSearch Dashboards OpenSearch Project OpenSearch Service @@ -143,7 +144,6 @@ Searchium Searchium.ai Sease Serverless -SigV4 Simple Schema for Observability SnappyFlow SquareShift diff --git a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt index 9c86e500e1..65d3bf30f7 100644 --- a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt +++ b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt @@ -4,7 +4,7 @@ [Aa]utopopulate [Aa]utoscaler? [Bb]ackoff -[Bb]ackport +[Bb]ackport(s|ing)? [Bb]ackpressure [Bb]asemap [Bb]igram @@ -59,6 +59,7 @@ Levenshtein [Ll]ookups? [Ll]ossy [Ll]owercases?d? +[Mm]acrobenchmarks? [Mm]isorder [Mm]odularization [Mm]ultifield @@ -88,12 +89,14 @@ 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 diff --git a/.vale.ini b/.vale.ini index 88d5a6ed94..e854c5b38f 100644 --- a/.vale.ini +++ b/.vale.ini @@ -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 diff --git a/_posts/2023-07-06-optimize-opensearch-index-shard-size.markdown b/_posts/2023-07-06-optimize-opensearch-index-shard-size.markdown index 96a8777e12..bc06569f8e 100644 --- a/_posts/2023-07-06-optimize-opensearch-index-shard-size.markdown +++ b/_posts/2023-07-06-optimize-opensearch-index-shard-size.markdown @@ -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. \ No newline at end of file +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 \ No newline at end of file From 7537f6b5fa390ee374ea7ecb217579dea6ca44db Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Mon, 31 Jul 2023 11:38:27 -0400 Subject: [PATCH 2/2] Add more words Signed-off-by: Fanit Kolchina --- .github/vale/styles/Vocab/OpenSearch/Words/accept.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt index 65d3bf30f7..c44c0e9d19 100644 --- a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt +++ b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt @@ -16,6 +16,7 @@ Boolean [Cc]onfig [Cc]ron [Cc]ybersecurity +[Dd]ashboarding [Dd]atagram [Dd]eallocate [Dd]eduplication @@ -53,6 +54,7 @@ k-NN [Kk]eystore kibibyte mebibyte +[Ll]earnings [Ll]emmatization Levenshtein [Ll]inestring @@ -104,6 +106,7 @@ stdout [Ss]ubcommands? [Ss]ubfield [Ss]ubquery +[Ss]ubstrings? [Ss]ubtag [Ss]ubtree [Ss]ubvector