From 1e50c4d629a8f3c3ef2416398eb70b97e3eccb1a Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Fri, 30 Jun 2023 16:21:39 -0400 Subject: [PATCH 1/6] Update style workflow with sigv4 and sharding Signed-off-by: Fanit Kolchina --- .github/vale/styles/OpenSearch/AcronymParentheses.yml | 1 + .github/vale/styles/OpenSearch/SignatureV4.yml | 11 +++++++++++ .../vale/styles/Vocab/OpenSearch/Products/accept.txt | 1 - .github/vale/styles/Vocab/OpenSearch/Words/accept.txt | 1 + .github/vale/tests/test-style-neg.md | 2 ++ .github/vale/tests/test-style-pos.md | 2 ++ .vale.ini | 1 + 7 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 .github/vale/styles/OpenSearch/SignatureV4.yml diff --git a/.github/vale/styles/OpenSearch/AcronymParentheses.yml b/.github/vale/styles/OpenSearch/AcronymParentheses.yml index 4c515914e3..bebef2c77d 100644 --- a/.github/vale/styles/OpenSearch/AcronymParentheses.yml +++ b/.github/vale/styles/OpenSearch/AcronymParentheses.yml @@ -11,6 +11,7 @@ second: '(?:\b[A-Za-z-]+ )+\(([A-Z]{1,3}\/?[A-Z]{1,3}\d{0,2})\)' exceptions: - API - ASCII + - AWS - BASIC - BM25 - CPU diff --git a/.github/vale/styles/OpenSearch/SignatureV4.yml b/.github/vale/styles/OpenSearch/SignatureV4.yml new file mode 100644 index 0000000000..c3a3573a74 --- /dev/null +++ b/.github/vale/styles/OpenSearch/SignatureV4.yml @@ -0,0 +1,11 @@ +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/Vocab/OpenSearch/Products/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt index 0e2a566db1..35a1229383 100644 --- a/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt +++ b/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt @@ -73,7 +73,6 @@ Querqy Query Workbench RPM Package Manager Ruby -SigV4 Simple Schema for Observability Tableau TorchScript diff --git a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt index 26b9d99616..5ed98e880a 100644 --- a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt +++ b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt @@ -83,6 +83,7 @@ pebibyte [Rr]ewriter [Rr]ollup [Rr]unbooks? +[Ss]harding [Ss]erverless [Ss]ignificand stdout diff --git a/.github/vale/tests/test-style-neg.md b/.github/vale/tests/test-style-neg.md index 81a91e99ae..98f5837bc1 100644 --- a/.github/vale/tests/test-style-neg.md +++ b/.github/vale/tests/test-style-neg.md @@ -54,6 +54,8 @@ This sentence tests rollover as a noun. To roll over, we test this as a verb. This sentence tests setup as a noun. To set up, we test this as a verb. +This sentence tests AWS Signature Version 4. + This sentence tests the "simple" rule by doing it. These two sentences. Test the spacing punctuation. diff --git a/.github/vale/tests/test-style-pos.md b/.github/vale/tests/test-style-pos.md index a435cb0244..f9ac0e716e 100644 --- a/.github/vale/tests/test-style-pos.md +++ b/.github/vale/tests/test-style-pos.md @@ -54,6 +54,8 @@ This sentence tests roll-over as a noun. To rollover, we test this as a verb. This sentence tests set-up as a noun. To setup, we test this as a verb. +This sentence tests AWS SigV4 and sigv4. + This sentence simply tests the "simple" rule by just doing it. These two sentences. Test the spacing punctuation. diff --git a/.vale.ini b/.vale.ini index 02f16dd372..2b195b4daf 100644 --- a/.vale.ini +++ b/.vale.ini @@ -52,6 +52,7 @@ OpenSearch.RolloverNoun = YES OpenSearch.RolloverVerb = YES OpenSearch.SetupNoun = YES OpenSearch.SetupVerb = YES +OpenSearch.SignatureV4 = YES OpenSearch.Simple = YES OpenSearch.SpacingPunctuation = YES OpenSearch.SpacingSlash = YES From 9a35f1f465a9a84f9868dc4fad5bd068e693b14f Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Sat, 1 Jul 2023 18:12:02 -0400 Subject: [PATCH 2/6] Change heading capitalization to work with colons Signed-off-by: Fanit Kolchina --- .../OpenSearch/HeadingCapitalization.yml | 5 +- .github/vale/tests/test-headings.md | 61 +++++++++++++++++++ 2 files changed, 65 insertions(+), 1 deletion(-) create mode 100644 .github/vale/tests/test-headings.md diff --git a/.github/vale/styles/OpenSearch/HeadingCapitalization.yml b/.github/vale/styles/OpenSearch/HeadingCapitalization.yml index 28ff0aa023..bb604490b3 100644 --- a/.github/vale/styles/OpenSearch/HeadingCapitalization.yml +++ b/.github/vale/styles/OpenSearch/HeadingCapitalization.yml @@ -2,4 +2,7 @@ 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: + - ":" \ No newline at end of file diff --git a/.github/vale/tests/test-headings.md b/.github/vale/tests/test-headings.md new file mode 100644 index 0000000000..6991caf183 --- /dev/null +++ b/.github/vale/tests/test-headings.md @@ -0,0 +1,61 @@ +# This should not be flagged + +--- + +# Example with OpenSearch should not be flagged + +--- + +# Example with Canada should not be flagged + +--- + +# Example with: OpenSearch should not be flagged + +--- + +# This: Should not be flagged + +--- + +# Step 2: (Optional) Test OpenSearch should not be flagged + +--- + +# Example with something else: Should not be flagged + +--- + +# Example 2: Should not be flagged + +--- + +# Example: should be flagged + +--- + +# Example 3: should be flagged + +--- + +# Example with something else: should be Flagged twice + +--- + +# Example With something else: should be flagged twice + +--- + +# Example: with OpenSearch should be flagged + +--- + +# this should be flagged + +--- + +# This Should Be Flagged + +--- + +The King of England should not be flagged. \ No newline at end of file From 8ddef02e1316fbb8d764693cccdae9e70b8c8c77 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Sat, 1 Jul 2023 21:15:32 -0400 Subject: [PATCH 3/6] Add more words Signed-off-by: Fanit Kolchina --- .github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt | 1 + .github/vale/styles/Vocab/OpenSearch/Products/accept.txt | 1 + .github/vale/styles/Vocab/OpenSearch/Words/accept.txt | 1 + _benchmark/index.md | 2 +- 4 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt index e74261cdac..b905a30f20 100644 --- a/.github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt +++ b/.github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt @@ -1,6 +1,7 @@ Alerting plugin Anomaly Detection plugin Asynchronous Search plugin +Crypto plugin Cross-Cluster Replication plugin Maps plugin Notebooks plugin diff --git a/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt index 35a1229383..25e824ce49 100644 --- a/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt +++ b/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt @@ -53,6 +53,7 @@ Okta Open Distro OpenID Connect OpenSearch +OpenSearch Benchmark OpenSearch Dashboards OpenSearch Project OpenSearch Service diff --git a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt index 5ed98e880a..b58ce5446d 100644 --- a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt +++ b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt @@ -53,6 +53,7 @@ Levenshtein [Ll]ookups? [Ll]ossy [Ll]owercases?d? +[Mm]acrobenchmarks? [Mm]isorder [Mm]ultifield [Mm]ultiline diff --git a/_benchmark/index.md b/_benchmark/index.md index 010aa8b170..dcfa629c5d 100644 --- a/_benchmark/index.md +++ b/_benchmark/index.md @@ -13,7 +13,7 @@ OpenSearch Benchmark is a macrobenchmark utility provided by the [OpenSearch Pro - Tracking the overall performance of an OpenSearch cluster. - Informing decisions about when to upgrade your cluster to a new version. -- Determining how changes to your workflow—such as modifying mappings or queries—might impact your cluster. +- Determining how changes to your workflow---such as modifying mappings or queries---might impact your cluster. OpenSearch Benchmark can be installed directly on a compatible host running Linux and macOS. You can also run OpenSearch Benchmark in a Docker container. See [Installing OpenSearch Benchmark]({{site.url}}{{site.baseurl}}/benchmark/installing-benchmark/) for more information. From 346e464025390a4afdf0013c854e1851eef61d52 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Mon, 3 Jul 2023 13:17:11 -0400 Subject: [PATCH 4/6] Ignore lowercase k in k-NN Signed-off-by: Fanit Kolchina --- .github/vale/styles/OpenSearch/HeadingCapitalization.yml | 4 +++- .github/vale/styles/OpenSearch/TableHeadings.yml | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/vale/styles/OpenSearch/HeadingCapitalization.yml b/.github/vale/styles/OpenSearch/HeadingCapitalization.yml index bb604490b3..a6b80b9d75 100644 --- a/.github/vale/styles/OpenSearch/HeadingCapitalization.yml +++ b/.github/vale/styles/OpenSearch/HeadingCapitalization.yml @@ -5,4 +5,6 @@ scope: heading match: $sentence threshold: 1 indicators: - - ":" \ No newline at end of file + - ":" +exceptions: + - k # ignores lowercase k-NN \ No newline at end of file diff --git a/.github/vale/styles/OpenSearch/TableHeadings.yml b/.github/vale/styles/OpenSearch/TableHeadings.yml index 49e1e96f99..96cb8621fc 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 From 4d2a66abe42fe37391854dd7d13e393d6883e894 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Wed, 5 Jul 2023 09:59:26 -0400 Subject: [PATCH 5/6] Add sharding Signed-off-by: Fanit Kolchina --- .github/vale/styles/Vocab/OpenSearch/Words/accept.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt index b58ce5446d..5383b25e6b 100644 --- a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt +++ b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt @@ -86,6 +86,7 @@ pebibyte [Rr]unbooks? [Ss]harding [Ss]erverless +[Ss]harding [Ss]ignificand stdout [Ss]ubaggregation From 8640dbb0caeeca48791042408f26a1ce03d33bcc Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Wed, 5 Jul 2023 10:00:51 -0400 Subject: [PATCH 6/6] Add backporting Signed-off-by: Fanit Kolchina --- .github/vale/styles/Vocab/OpenSearch/Words/accept.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt index 5383b25e6b..c2e46b8db0 100644 --- a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt +++ b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt @@ -2,6 +2,7 @@ [Aa]utomapping [Aa]utopopulate [Bb]ackoff +[Bb]ackporting [Bb]ackpressure [Bb]asemap [Bb]igram