Skip to content

Commit

Permalink
Merge branch 'main' into CJK-bigram-token-filter-page
Browse files Browse the repository at this point in the history
  • Loading branch information
AntonEliatra authored Aug 6, 2024
2 parents c0fae6c + 6eccc88 commit 9a085c6
Show file tree
Hide file tree
Showing 592 changed files with 23,900 additions and 2,882 deletions.
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/issue_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ assignees: ''
- [ ] Report a technical problem with the documentation
- [ ] Other

**Tell us about your request.** Provide a summary of the request and all versions that are affected.

**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.

**What other resources are available?** Provide links to related issues, POCs, steps for testing, etc.

5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ _Describe what this change achieves._
### Issues Resolved
_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).
Expand Down
2 changes: 2 additions & 0 deletions .github/vale/styles/OpenSearch/DashSpacing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,7 @@ message: "There should be no spaces around the dash in '%s'."
ignorecase: true
nonword: true
level: error
scope:
- ~list
tokens:
- '\w+ +-{2,3} +\w+'
3 changes: 2 additions & 1 deletion .github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ Search Relevance plugin
Security plugin
Security Analytics plugin
SQL plugin
Trace Analytics plugin
Trace Analytics plugin
User Behavior Insights
9 changes: 8 additions & 1 deletion .github/vale/styles/Vocab/OpenSearch/Products/accept.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
Active Directory
Adoptium
AI21 Labs Jurassic
Amazon
Amazon OpenSearch Serverless
Amazon OpenSearch Service
Amazon Bedrock
Amazon SageMaker
Ansible
Anthropic Claude
Auditbeat
AWS Cloud
Cohere Command
Cohere Embed English
Cohere Embed Multilingual
Cognito
Dashboards Query Language
Data Prepper
Expand Down Expand Up @@ -75,7 +80,6 @@ Painless
Peer Forwarder
Performance Analyzer
Piped Processing Language
Point in Time
Powershell
Python
PyTorch
Expand All @@ -86,6 +90,9 @@ RPM Package Manager
Ruby
Simple Schema for Observability
Tableau
Textract
Titan Multimodal Embeddings
Titan Text Embeddings
TorchScript
Tribuo
VisBuilder
Expand Down
3 changes: 2 additions & 1 deletion .github/vale/styles/Vocab/OpenSearch/Words/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,8 @@ pebibyte
[Pp]reprocess
[Pp]retrain
[Pp]seudocode
[Quantiz](e|ation|ing|er)
[Qq]uantiles?
[Qq]uantiz(e|ation|ing|er)
[Rr]ebalance
[Rr]ebalancing
[Rr]edownload
Expand Down
4 changes: 4 additions & 0 deletions .github/vale/tests/test-style-neg.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ This sentence tests cybersecurity.

This sentence tests dash---spacing.

This sentence tests:

- Dash --- spacing in a list.

This sentence tests numbers above 1.2 in versions 1.2 and earlier.

This sentence tests upper-right and lower left.
Expand Down
43 changes: 43 additions & 0 deletions .github/workflows/pr_checklist.yml
Original file line number Diff line number Diff line change
@@ -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]
});
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ _site
.DS_Store
Gemfile.lock
.idea
*.iml
.jekyll-cache
.project
1 change: 1 addition & 0 deletions .ruby-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.3.2
4 changes: 2 additions & 2 deletions API_STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Follow these steps to set up your local copy of the repository:

```
curl -sSL https://get.rvm.io | bash -s stable
rvm install 3.2
rvm install 3.2.4
ruby -v
```

Expand All @@ -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`.



Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ This project has adopted an [Open Source Code of Conduct](https://opensearch.org

## Security

If you discover a potential security issue in this project, we ask that you notify AWS/Amazon Security using our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Do **not** create a public GitHub issue.

If you discover a potential security issue in this project, notify OpenSearch Security directly by emailing [email protected]. To prevent any additional risk caused by the potential issue, do **not** create a public GitHub issue.

## License

Expand Down
Loading

0 comments on commit 9a085c6

Please sign in to comment.