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.

Sign up for GitHub

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

Jump to bottom

Add keep words token filter docs #8064 #8124

Merged
merged 8 commits into from
Nov 14, 2024
Merged

Add keep words token filter docs #8064 #8124

merged 8 commits into from
Nov 14, 2024

Conversation

AntonEliatra
Copy link
Contributor

Description

Add keep words token filter docs

Issues Resolved

Closes #8064

Version

All

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.

@github-actions GitHub Actions
Copy link

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.

@AntonEliatra
Copy link
Contributor Author

In this case the actual filter "type" is "keep", not "keep_words"
"keep_words" is a parameter that can be passed in.

I thought about renaming this to "keep" token filter across the changes, but it looks strange, especially since it uses KeepWordFilter Class. Just thought I'm mention it - in case anyone wants to change this.

@AntonEliatra
fixing vale errors
208ba7c 
Signed-off-by: Anton Rubin <[email protected]>
@kolchfa-aws kolchfa-aws assigned vagimeli and unassigned kolchfa-aws Aug 29, 2024
@vagimeli vagimeli added 3 - Tech review PR: Tech review in progress Needs SME Waiting on input from subject matter expert labels Aug 29, 2024
@vagimeli
Copy link
Contributor

@udabhas Will you review this PR for technical accuracy? Thank you.

@AntonEliatra
Update keep-words.md
6c17e4f 
Signed-off-by: AntonEliatra <[email protected]>
@vagimeli
Copy link
Contributor

vagimeli commented Oct 3, 2024

@udabhas Will you review this PR for technical accuracy? Thank you.

@udabhas @varun-lodaya This is over a month old. We need tech review approval to move it forward in the documentation process. Please review this week or provide a peer who can review it. Thank you.

@AntonEliatra
updating parameter table
f8e5bf3 
Signed-off-by: Anton Rubin <[email protected]>
@AntonEliatra
Update keep-words.md
e3f7f15 
Signed-off-by: AntonEliatra <[email protected]>
kolchfa-aws
kolchfa-aws approved these changes Nov 11, 2024
View reviewed changes
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, @AntonEliatra! A couple of suggestions.

_analyzers/token-filters/keep-words.md Outdated Show resolved Hide resolved
_analyzers/token-filters/keep-words.md Outdated Show resolved Hide resolved
_analyzers/token-filters/keep-words.md Outdated Show resolved Hide resolved
@kolchfa-aws kolchfa-aws assigned kolchfa-aws and unassigned vagimeli Nov 11, 2024
@AntonEliatra @kolchfa-aws
Apply suggestions from code review
91e9d9d 
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>
natebower
natebower reviewed Nov 14, 2024
View reviewed changes
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.

@kolchfa-aws Please see my changes and let me know if you have any questions. Thanks!

_analyzers/token-filters/index.md Outdated Show resolved Hide resolved
_analyzers/token-filters/keep-words.md Outdated Show resolved Hide resolved
_analyzers/token-filters/keep-words.md Outdated Show resolved Hide resolved
@kolchfa-aws @natebower
Apply suggestions from code review
f5602d8 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
@kolchfa-aws kolchfa-aws merged commit 1bb7f3e into opensearch-project:main Nov 14, 2024
5 checks passed
@kolchfa-aws kolchfa-aws added the backport 2.18 PR: Backport label for 2.18 label Nov 14, 2024
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 14, 2024
@github-actions @kolchfa-aws @natebower
Add keep words token filter docs #8064 (#8124)
9a52a36 
* adding keep words token filter docs #8064

Signed-off-by: Anton Rubin <[email protected]>

* fixing vale errors

Signed-off-by: Anton Rubin <[email protected]>

* Update keep-words.md

Signed-off-by: AntonEliatra <[email protected]>

* updating parameter table

Signed-off-by: Anton Rubin <[email protected]>

* Update keep-words.md

Signed-off-by: AntonEliatra <[email protected]>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Anton Rubin <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 1bb7f3e)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Nov 14, 2024
Merged
github-actions bot pushed a commit that referenced this pull request Nov 14, 2024
@opensearch-trigger-bot
Add keep words token filter docs #8064 (#8124) (#8754)
f3ae03a
epugh pushed a commit to o19s/documentation-website that referenced this pull request Nov 23, 2024
@AntonEliatra @kolchfa-aws
@natebower @epugh
Add keep words token filter docs opensearch-project#8064 (opensearch-…
59f1ab0 
…project#8124)

* adding keep words token filter docs opensearch-project#8064

Signed-off-by: Anton Rubin <[email protected]>

* fixing vale errors

Signed-off-by: Anton Rubin <[email protected]>

* Update keep-words.md

Signed-off-by: AntonEliatra <[email protected]>

* updating parameter table

Signed-off-by: Anton Rubin <[email protected]>

* Update keep-words.md

Signed-off-by: AntonEliatra <[email protected]>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Anton Rubin <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[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
Reviewers

@natebower natebower natebower left review comments

@kolchfa-aws kolchfa-aws kolchfa-aws approved these changes

@Naarcha-AWS Naarcha-AWS Awaiting requested review from Naarcha-AWS Naarcha-AWS is a code owner

@vagimeli vagimeli Awaiting requested review from vagimeli

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@stephen-crawford stephen-crawford Awaiting requested review from stephen-crawford

@epugh epugh Awaiting requested review from epugh epugh is a code owner

Assignees

@kolchfa-aws kolchfa-aws

Labels
3 - Tech review PR: Tech review in progress analyzers backport 2.18 PR: Backport label for 2.18 Content gap Needs SME Waiting on input from subject matter expert
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Token filters - keep_word [DOC]
4 participants
@AntonEliatra @vagimeli @natebower @kolchfa-aws