Merge branch 'main' into refresh_ubi_docs_part_deux

Author: kolchfa-aws

.github/CODEOWNERS

@@ -1 +1 @@
-*  @kolchfa-aws @Naarcha-AWS @vagimeli @AMoo-Miki @natebower @dlvenable @stephen-crawford @epugh
+*  @kolchfa-aws @Naarcha-AWS @AMoo-Miki @natebower @dlvenable @epugh

.github/ISSUE_TEMPLATE/issue_template.md

@@ -15,7 +15,6 @@ assignees: ''
 
 **Tell us about your request.** Provide a summary of the request.
 
-***Version:** List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.
+**Version:** List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.
 
 **What other resources are available?** Provide links to related issues, POCs, steps for testing, etc.
-

.github/vale/styles/Vocab/OpenSearch/Products/accept.txt

@@ -85,6 +85,7 @@ Python
 PyTorch
 Querqy
 Query Workbench
+RankLib
 RCF Summarize
 RPM Package Manager
 Ruby
@@ -97,4 +98,5 @@ TorchScript
 Tribuo
 VisBuilder
 Winlogbeat
-Zstandard
+XGBoost
+Zstandard

.github/vale/styles/Vocab/OpenSearch/Words/accept.txt

@@ -85,6 +85,8 @@ p\d{2}
 [Pp]erformant
 [Pp]laintext
 [Pp]luggable
+[Pp]reaggregate(s|d)?
+[Pp]recompute(s|d)?
 [Pp]reconfigure
 [Pp]refetch
 [Pp]refilter

.github/workflows/jekyll-spec-insert.yml

@@ -0,0 +1,20 @@
+name: Lint and Test Jekyll Spec Insert
+on:
+  push:
+    paths:
+      - 'spec-insert/**'
+  pull_request:
+    paths:
+      - 'spec-insert/**'
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with: { ruby-version: 3.3.0 }
+      - run: bundle install
+      - working-directory: spec-insert
+        run: |
+          bundle exec rubocop
+          bundle exec rspec

.github/workflows/pr_checklist.yml

@@ -29,7 +29,7 @@ jobs:
         with:
           script: |
             let assignee = context.payload.pull_request.user.login;
-            const prOwners = ['Naarcha-AWS', 'kolchfa-aws', 'vagimeli', 'natebower'];
+            const prOwners = ['Naarcha-AWS', 'kolchfa-aws', 'natebower'];
             
             if (!prOwners.includes(assignee)) {
               assignee = 'kolchfa-aws'
@@ -40,4 +40,4 @@ jobs:
                 owner: context.repo.owner,
                 repo: context.repo.repo,
                 assignees: [assignee]
-              });
+              });

.github/workflows/update-api-components.yml

@@ -0,0 +1,52 @@
+name: Update API Components
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * 0" # Every Sunday at midnight GMT
+jobs:
+  update-api-components:
+    if: ${{ github.repository == 'opensearch-project/documentation-website' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+
+      - run: git config --global pull.rebase true
+
+      - uses: ruby/setup-ruby@v1
+        with: { ruby-version: 3.3.0 }
+
+      - run: bundle install
+
+      - name: Download spec and insert into documentation
+        run: bundle exec jekyll spec-insert
+
+      - name: Get current date
+        id: date
+        run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_ENV
+
+      - name: GitHub App token
+        id: github_app_token
+        uses: tibdex/github-app-token@v2.1.0
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+
+      - name: Create pull request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ steps.github_app_token.outputs.token }}
+          commit-message: "Updated API components to reflect the latest OpenSearch API spec (${{ env.date }})"
+          title: "[AUTOCUT] Update API components to reflect the latest OpenSearch API spec (${{ env.date }})"
+          body: |
+            Update API components to reflect the latest [OpenSearch API spec](https://github.com/opensearch-project/opensearch-api-specification/releases/download/main-latest/opensearch-openapi.yaml).
+            Date: ${{ env.date }}
+          branch: update-api-components-${{ env.date }}
+          base: main
+          signoff: true
+          labels: autocut

.ruby-version

@@ -31,13 +31,13 @@ The following sections describe the basic API documentation structure. Each sect
 Depending on where the documentation appears within a section or subsection, heading levels may be adjusted to fit with other content.
 
 1. Name of API (heading level 2)
-1. (Optional) Path and HTTP methods (heading level 3)
-1. Path parameters (heading level 3)
-1. Query parameters (heading level 3)
-1. Request fields (heading level 3)
+1. Endpoints (heading level 3)
+1. (Optional) Path parameters (heading level 3)
+1. (Optional) Query parameters (heading level 3)
+1. (Optional) Request fields (heading level 3)
 1. Example request (heading level 4)
-1. Example response (heading level 4)
-1. Response fields (heading level 3)
+1. (Optional) Example response (heading level 4)
+1. (Optional) Response fields (heading level 3)
 
 ## API name
 
@@ -55,7 +55,7 @@ If applicable, provide any caveats to its usage with a note or tip, as in the fo
 "If you use the Security plugin, make sure you have the appropriate permissions."
 (To set this point in note-style format, follow the text on the next line with {: .note})
 
-### Path and HTTP methods
+### Endpoints
 
 For relatively complex API calls that include path parameters, it's sometimes a good idea to provide an example so that users can visualize how the request is properly formed. This section is optional and includes examples that illustrate how the endpoint and path parameters fit together in the request. The following is an example of this section for the nodes stats API:
 

API_STYLE_GUIDE.md

@@ -78,13 +78,13 @@ Follow these steps to set up your local copy of the repository:
 
 1. Navigate to your cloned repository.
 
-##### Building using locally installed packages 
+##### Building by using locally installed packages 
 
 1. Install [Ruby](https://www.ruby-lang.org/en/) if you don't already have it. We recommend [RVM](https://rvm.io/), but you can use any method you prefer:
 
    ```
    curl -sSL https://get.rvm.io | bash -s stable
-   rvm install 3.2.4
+   rvm install 3.3.2
    ruby -v
    ```
 
@@ -100,7 +100,7 @@ Follow these steps to set up your local copy of the repository:
    bundle install
    ```
 
-##### Building using containerization
+##### Building by using containerization
 
 Assuming you have `docker-compose` installed, run the following command:
 
@@ -158,6 +158,23 @@ To ensure that our documentation adheres to the [OpenSearch Project Style Guidel
 
 Optionally, you can install the [Vale VSCode](https://github.com/chrischinchilla/vale-vscode) extension, which integrates Vale with Visual Studio Code. By default, only _errors_ and _warnings_ are underlined. To change the minimum alert level to include _suggestions_, go to **Vale VSCode** > **Extension Settings** and select **suggestion** in the **Vale > Vale CLI: Min Alert Level** dropdown list. 
 
+## Troubleshooting
+
+This section provides information about potential solutions for known issues.
+
+### Installing Ruby on an Apple silicon machine
+
+If you're having trouble installing Ruby with `rvm` on an Apple silicon machine, it could be because of an OpenSSL version misalignment. To fix this issue, use the following command, replacing `<openssl-version>` with your [desired version](https://github.com/ruby/openssl/blob/master/README.md):
+
+```
+# Assumes Brew is installed
+curl -sSL https://get.rvm.io | bash -s stable
+rvm install 3.2.4 --with-openssl-dir=$(brew --prefix openssl@<openssl-version>)
+ruby -v
+```
+
 ## Getting help
 
 For help with the contribution process, reach out to one of the [points of contact](README.md#points-of-contact).
+
+