Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding new cluster search setting docs #8180

Merged
merged 5 commits into from
Sep 11, 2024

Conversation

harshavamsi
Copy link
Contributor

@harshavamsi harshavamsi commented Sep 5, 2024

Description

Adds docs around new cluster search setting

Issues Resolved

Resolves #8175

Version

2.17

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.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
Copy link

github-actions bot commented Sep 5, 2024

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.

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.

@harshavamsi harshavamsi added v2.17.0 release-notes PR: Include this PR in the automated release notes labels Sep 9, 2024
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @harshavamsi! We want to avoid Java class names in documentation and just explain what the term means. Could you please clarify what is meant by "index or doc_values query"?

@harshavamsi
Copy link
Contributor Author

@kolchfa-aws IndexOrDocValuesQuery essentially will make a decision during query time to decide whether to use the index structure to run the query or the doc_values. It comes from Apache Lucene, I wasn't sure how we could better describe here since it really is an implementation detail and the class name is as verbose as it gets.

@kolchfa-aws
Copy link
Collaborator

Thank you! I updated my suggestion.

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @harshavamsi! LGTM

@kolchfa-aws kolchfa-aws added 6 - Done but waiting to merge PR: The work is done and ready to merge 5 - Editorial review PR: Editorial review in progress labels Sep 10, 2024
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kolchfa-aws kolchfa-aws merged commit 1fe62b0 into opensearch-project:main Sep 11, 2024
9 checks passed
epugh pushed a commit to o19s/documentation-website that referenced this pull request Sep 12, 2024
* Adding new cluster search setting docs

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>

* Update _install-and-configure/configuring-opensearch/search-settings.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Harsha Vamsi Kalluri <[email protected]>

---------

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress 6 - Done but waiting to merge PR: The work is done and ready to merge release-notes PR: Include this PR in the automated release notes v2.17.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC]New cluster settings for keyword MultiTermQueries
3 participants