Merge branch 'opensearch-project:main' into patch-5

opensearch-project · Jul 26, 2024 · 510dfe3 · 510dfe3
2 parents eedfd0e + fdfd53f
commit 510dfe3
Show file tree

Hide file tree

Showing 321 changed files with 6,715 additions and 1,212 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -7,6 +7,9 @@ _List any issues this PR will resolve, e.g. Closes [...]._
 ### Version
 _List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all._
 
+### Frontend features
+_If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional._ 
+
 ### Checklist
 - [ ] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the [Developers Certificate of Origin](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).
 For more information on following Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).
diff --git a/.github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt
@@ -26,4 +26,5 @@ Search Relevance plugin
 Security plugin
 Security Analytics plugin
 SQL plugin
-Trace Analytics plugin
+Trace Analytics plugin
+User Behavior Insights
diff --git a/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Products/accept.txt
@@ -76,7 +76,6 @@ Painless
 Peer Forwarder
 Performance Analyzer
 Piped Processing Language
-Point in Time
 Powershell
 Python
 PyTorch

diff --git a/.github/workflows/pr_checklist.yml b/.github/workflows/pr_checklist.yml
@@ -0,0 +1,43 @@
+name: PR Checklist
+
+on:
+  pull_request_target:
+    types: [opened]
+
+permissions:
+  pull-requests: write
+
+jobs:
+  add-checklist:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Comment PR with checklist
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: |
+            Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.
+            
+            Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a [maintainer](https://github.com/opensearch-project/documentation-website/blob/main/MAINTAINERS.md).
+
+            **When you're ready for doc review, tag the assignee of this PR**. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.
+
+      - name: Auto assign PR to repo owner
+        uses: actions/github-script@v6
+        with:
+          script: |
+            let assignee = context.payload.pull_request.user.login;
+            const prOwners = ['Naarcha-AWS', 'kolchfa-aws', 'vagimeli', 'natebower'];
+            
+            if (!prOwners.includes(assignee)) {
+              assignee = 'hdhalter'
+            }
+
+            github.rest.issues.addAssignees({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                assignees: [assignee]
+              });
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,6 @@ _site
 .DS_Store
 Gemfile.lock
 .idea
+*.iml
 .jekyll-cache
+.project
diff --git a/.ruby-version b/.ruby-version
@@ -0,0 +1 @@
+3.3.2
diff --git a/API_STYLE_GUIDE.md b/API_STYLE_GUIDE.md
@@ -115,7 +115,7 @@ Include a table with these columns:
 Field | Data type | Description
 :--- | :--- | :--- 
 
-#### Example request
+## Example request
 
 Provide a sentence that describes what is shown in the example, followed by a cut-and-paste-ready API request in JSON format. Make sure that you test the request yourself in the Dashboards Dev Tools console to make sure it works. See the following examples.
 
@@ -139,7 +139,7 @@ POST _reindex
 }
 ```
 
-#### Example response
+## Example response
 
 Include a JSON example response to show what the API returns. See the following examples.
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -100,10 +100,10 @@ Follow these steps to set up your local copy of the repository:
 
 #### Troubleshooting
 
-If you encounter an error while trying to build the documentation website, find the error in the following troubleshooting list: 
+Try the following troubleshooting steps if you encounter an error when trying to build the documentation website:  
 
-- When running `rvm install 3.2` if you receive a `Error running '__rvm_make -j10'`, resolve this by running `rvm install 3.2.0 -C --with-openssl-dir=/opt/homebrew/opt/[email protected]` instead of `rvm install 3.2`.
-- If receive a `bundle install`: `An error occurred while installing posix-spawn (0.3.15), and Bundler cannot continue.` error when trying to run `bundle install`, resolve this by running `gem install posix-spawn -v 0.3.15 -- --with-cflags=\"-Wno-incompatible-function-pointer-types\"`. Then, run `bundle install`.
+- If you see the `Error running '__rvm_make -j10'` error when running `rvm install 3.2`, you can resolve it by running `rvm install 3.2.0 -C --with-openssl-dir=/opt/homebrew/opt/[email protected]` instead of `rvm install 3.2`.
+- If you see the `bundle install`: `An error occurred while installing posix-spawn (0.3.15), and Bundler cannot continue.` error when trying to run `bundle install`, you can resolve it by running `gem install posix-spawn -v 0.3.15 -- --with-cflags=\"-Wno-incompatible-function-pointer-types\"` and then `bundle install`.
 
 
 

diff --git a/_about/version-history.md b/_about/version-history.md
@@ -9,6 +9,7 @@ permalink: /version-history/
 
 OpenSearch version | Release highlights | Release date  
 :--- | :--- | :--- 
+[2.15.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.15.0.md) | Includes parallel ingestion processing, SIMD support for exact search, and the ability to disable doc values for the k-NN field. Adds wildcard and derived field types. Improves performance for single-cardinality aggregations, rolling upgrades to remote-backed clusters, and more metrics for top N queries. For a full list of release highlights, see the Release Notes. | 25 June 2024
 [2.14.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.14.0.md) | Includes performance improvements to hybrid search and date histogram queries with multi-range traversal, ML model integration within the Ingest API, semantic cache for LangChain applications, low-level vector query interface for neural sparse queries, and improved k-NN search filtering. Provides an experimental tiered cache feature. For a full list of release highlights, see the Release Notes. | 14 May 2024
 [2.13.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.13.0.md) | Makes agents and tools and the OpenSearch Assistant Toolkit generally available. Introduces vector quantization within OpenSearch. Adds LLM guardrails and hybrid search with aggregations. Adds the Bloom filter skipping index for Apache Spark data sources, I/O-based admission control, and the ability to add an alerting cluster that manages all alerting tasks. For a full list of release highlights, see the Release Notes. | 2 April 2024
 [2.12.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.12.0.md) | Makes concurrent segment search and conversational search generally available. Provides an experimental OpenSearch Assistant Toolkit, including agents and tools, workflow automation, and OpenSearch Assistant for OpenSearch Dashboards UI. Adds a new match-only text field, query insights to monitor top N queries, and k-NN search on nested fields. For a full list of release highlights, see the Release Notes. | 20 February 2024
@@ -29,6 +30,7 @@ OpenSearch version | Release highlights | Release date
 [2.0.1](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.0.1.md) | Includes bug fixes and maintenance updates for Alerting and Anomaly Detection. | 16 June 2022
 [2.0.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.0.0.md) | Includes document-level monitors for alerting, OpenSearch Notifications plugins, and Geo Map Tiles in OpenSearch Dashboards. Also adds support for Lucene 9 and bug fixes for all OpenSearch plugins. For a full list of release highlights, see the Release Notes. | 26 May 2022
 [2.0.0-rc1](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.0.0-rc1.md) | The Release Candidate for 2.0.0. This version allows you to preview the upcoming 2.0.0 release before the GA release. The preview release adds document-level alerting, support for Lucene 9, and the ability to use term lookup queries in document level security. | 03 May 2022
+[1.3.18](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-1.3.18.md) | Includes maintenance updates for OpenSearch security. | 16 July 2024
 [1.3.17](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-1.3.17.md) | Includes maintenance updates for OpenSearch security and OpenSearch Dashboards security. | 06 June 2024
 [1.3.16](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-1.3.16.md) | Includes bug fixes and maintenance updates for OpenSearch security, index management, performance analyzer, and reporting. | 23 April 2024
 [1.3.15](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-1.3.15.md) | Includes bug fixes and maintenance updates for cross-cluster replication, SQL, OpenSearch Dashboards reporting, and alerting.  | 05 March 2024

diff --git a/_aggregations/bucket/adjacency-matrix.md b/_aggregations/bucket/adjacency-matrix.md
@@ -2,7 +2,6 @@
 layout: default
 title: Adjacency matrix
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 10
 redirect_from:
   - /query-dsl/aggregations/bucket/adjacency-matrix/

diff --git a/_aggregations/bucket/date-histogram.md b/_aggregations/bucket/date-histogram.md
@@ -2,7 +2,6 @@
 layout: default
 title: Date histogram
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 20
 redirect_from:
   - /query-dsl/aggregations/bucket/date-histogram/

diff --git a/_aggregations/bucket/date-range.md b/_aggregations/bucket/date-range.md
@@ -2,7 +2,6 @@
 layout: default
 title: Date range
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 30
 redirect_from:
   - /query-dsl/aggregations/bucket/date-range/

diff --git a/_aggregations/bucket/diversified-sampler.md b/_aggregations/bucket/diversified-sampler.md
@@ -2,7 +2,6 @@
 layout: default
 title: Diversified sampler
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 40
 redirect_from:
   - /query-dsl/aggregations/bucket/diversified-sampler/

diff --git a/_aggregations/bucket/filter.md b/_aggregations/bucket/filter.md
@@ -2,7 +2,6 @@
 layout: default
 title: Filter
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 50
 redirect_from:
   - /query-dsl/aggregations/bucket/filter/

diff --git a/_aggregations/bucket/filters.md b/_aggregations/bucket/filters.md
@@ -2,7 +2,6 @@
 layout: default
 title: Filters
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 60
 redirect_from:
   - /query-dsl/aggregations/bucket/filters/

diff --git a/_aggregations/bucket/geo-distance.md b/_aggregations/bucket/geo-distance.md
@@ -2,7 +2,6 @@
 layout: default
 title: Geodistance
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 70
 redirect_from:
   - /query-dsl/aggregations/bucket/geo-distance/

diff --git a/_aggregations/bucket/geohash-grid.md b/_aggregations/bucket/geohash-grid.md
@@ -2,7 +2,6 @@
 layout: default
 title: Geohash grid
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 80
 redirect_from:
   - /query-dsl/aggregations/bucket/geohash-grid/

diff --git a/_aggregations/bucket/geohex-grid.md b/_aggregations/bucket/geohex-grid.md
@@ -2,7 +2,6 @@
 layout: default
 title: Geohex grid
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 85
 redirect_from:
   - /opensearch/geohexgrid-agg/

diff --git a/_aggregations/bucket/geotile-grid.md b/_aggregations/bucket/geotile-grid.md
@@ -2,7 +2,6 @@
 layout: default
 title: Geotile grid
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 87
 redirect_from:
   - /query-dsl/aggregations/bucket/geotile-grid/

diff --git a/_aggregations/bucket/global.md b/_aggregations/bucket/global.md
@@ -2,7 +2,6 @@
 layout: default
 title: Global
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 90
 redirect_from:
   - /query-dsl/aggregations/bucket/global/

diff --git a/_aggregations/bucket/histogram.md b/_aggregations/bucket/histogram.md
@@ -2,7 +2,6 @@
 layout: default
 title: Histogram
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 100
 redirect_from:
   - /query-dsl/aggregations/bucket/histogram/

diff --git a/_aggregations/bucket/ip-range.md b/_aggregations/bucket/ip-range.md
@@ -2,7 +2,6 @@
 layout: default
 title: IP range
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 110
 redirect_from:
   - /query-dsl/aggregations/bucket/ip-range/

diff --git a/_aggregations/bucket/missing.md b/_aggregations/bucket/missing.md
@@ -2,7 +2,6 @@
 layout: default
 title: Missing
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 120
 redirect_from:
   - /query-dsl/aggregations/bucket/missing/

diff --git a/_aggregations/bucket/multi-terms.md b/_aggregations/bucket/multi-terms.md
@@ -2,7 +2,6 @@
 layout: default
 title: Multi-terms
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 130
 redirect_from:
   - /query-dsl/aggregations/bucket/multi-terms/

diff --git a/_aggregations/bucket/nested.md b/_aggregations/bucket/nested.md
@@ -2,7 +2,6 @@
 layout: default
 title: Nested
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 140
 redirect_from:
   - /query-dsl/aggregations/bucket/nested/

diff --git a/_aggregations/bucket/range.md b/_aggregations/bucket/range.md
@@ -2,7 +2,6 @@
 layout: default
 title: Range
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 150
 redirect_from:
   - /query-dsl/aggregations/bucket/date-range/

diff --git a/_aggregations/bucket/reverse-nested.md b/_aggregations/bucket/reverse-nested.md
@@ -2,7 +2,6 @@
 layout: default
 title: Reverse nested
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 160
 redirect_from:
   - /query-dsl/aggregations/bucket/reverse-nested/

diff --git a/_aggregations/bucket/sampler.md b/_aggregations/bucket/sampler.md
@@ -2,7 +2,6 @@
 layout: default
 title: Sampler
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 170
 redirect_from:
   - /query-dsl/aggregations/bucket/diversified-sampler/

diff --git a/_aggregations/bucket/significant-terms.md b/_aggregations/bucket/significant-terms.md
@@ -2,7 +2,6 @@
 layout: default
 title: Significant terms
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 180
 redirect_from:
   - /query-dsl/aggregations/bucket/significant-terms/

diff --git a/_aggregations/bucket/significant-text.md b/_aggregations/bucket/significant-text.md
@@ -2,7 +2,6 @@
 layout: default
 title: Significant text
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 190
 redirect_from:
   - /query-dsl/aggregations/bucket/significant-text/

diff --git a/_aggregations/bucket/terms.md b/_aggregations/bucket/terms.md
@@ -2,7 +2,6 @@
 layout: default
 title: Terms
 parent: Bucket aggregations
-grand_parent: Aggregations
 nav_order: 200
 redirect_from:
   - /query-dsl/aggregations/bucket/terms/

diff --git a/_aggregations/index.md b/_aggregations/index.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Aggregations
-has_children: true
+has_children: false
 nav_order: 5
 nav_exclude: true
 permalink: /aggregations/

diff --git a/_aggregations/metric/average.md b/_aggregations/metric/average.md
@@ -2,7 +2,6 @@
 layout: default
 title: Average
 parent: Metric aggregations
-grand_parent: Aggregations
 nav_order: 10
 redirect_from:
   - /query-dsl/aggregations/metric/average/

diff --git a/_aggregations/metric/cardinality.md b/_aggregations/metric/cardinality.md
@@ -2,7 +2,6 @@
 layout: default
 title: Cardinality
 parent: Metric aggregations
-grand_parent: Aggregations
 nav_order: 20
 redirect_from:
   - /query-dsl/aggregations/metric/cardinality/

diff --git a/_aggregations/metric/extended-stats.md b/_aggregations/metric/extended-stats.md
@@ -2,7 +2,6 @@
 layout: default
 title: Extended stats
 parent: Metric aggregations
-grand_parent: Aggregations
 nav_order: 30
 redirect_from:
   - /query-dsl/aggregations/metric/extended-stats/

diff --git a/_aggregations/metric/geobounds.md b/_aggregations/metric/geobounds.md
@@ -2,7 +2,6 @@
 layout: default
 title: Geobounds
 parent: Metric aggregations
-grand_parent: Aggregations
 nav_order: 40
 redirect_from:
   - /query-dsl/aggregations/metric/geobounds/