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 type docs #8063 #8122

Merged
merged 8 commits into from
Nov 12, 2024
Merged

Add keep type docs #8063 #8122

merged 8 commits into from
Nov 12, 2024

Conversation

AntonEliatra
Copy link
Contributor

Description

Add keep type docs

Issues Resolved

Closes #8063

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.

@AntonEliatra
adding keep type docs opensearch-project#8063
7c8fe7d 
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
@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.

@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-types.md
959f234 
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
@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
8ed65b7 
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
@AntonEliatra
Update keep-types.md
d1e346d 
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
kolchfa-aws
kolchfa-aws requested 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! Please see my comments and let me know if you have any questions.

_analyzers/token-filters/keep-types.md Outdated Show resolved Hide resolved
_analyzers/token-filters/keep-types.md Outdated Show resolved Hide resolved
_analyzers/token-filters/keep-types.md Outdated Show resolved Hide resolved
_analyzers/token-filters/keep-types.md Outdated Show resolved Hide resolved
_analyzers/token-filters/keep-types.md Outdated Show resolved Hide resolved
_analyzers/token-filters/keep-types.md Outdated Show resolved Hide resolved
@kolchfa-aws kolchfa-aws assigned kolchfa-aws and unassigned vagimeli Nov 11, 2024
AntonEliatra and others added 2 commits November 12, 2024 14:00
@AntonEliatra @kolchfa-aws
Apply suggestions from code review
de596fc 
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
@AntonEliatra
fixing types
0fc5f11 
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
@AntonEliatra
Copy link
Contributor Author

@kolchfa-aws the comments have now been addressed

kolchfa-aws
kolchfa-aws approved these changes Nov 12, 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.

Thanks! LGTM

natebower
natebower reviewed Nov 12, 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.

@AntonEliatra @kolchfa-aws One comment and one change. Thanks!

_analyzers/token-filters/keep-types.md Outdated Show resolved Hide resolved
_analyzers/token-filters/keep-types.md Outdated

Parameter | Required/Optional | Data type | Description
:--- | :--- | :--- | :---
`types` | Required | List of strings | List of token types to be kept or removed (determined by the `mode`).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit: On line 10 we use "discarded" instead of "removed". We should probably use the same word in both instances.

kolchfa-aws and others added 2 commits November 12, 2024 13:06
@kolchfa-aws @natebower
Apply suggestions from code review
85c6268 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
@kolchfa-aws
Merge branch 'main' into adding-keep-types-token-filter
c2b2781
@kolchfa-aws kolchfa-aws merged commit 8d3ec41 into opensearch-project:main Nov 12, 2024
5 checks passed
@kolchfa-aws kolchfa-aws added the backport 2.18 PR: Backport label for 2.18 label Nov 12, 2024
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 12, 2024
@github-actions @kolchfa-aws @natebower
Add keep type docs #8063 (#8122)
b5b9e86 
* adding keep type docs #8063

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Update keep-types.md

Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>

* updating parameter table

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Update keep-types.md

Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>

* fixing types

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
(cherry picked from commit 8d3ec41)
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 12, 2024
Merged
github-actions bot pushed a commit that referenced this pull request Nov 12, 2024
@opensearch-trigger-bot
Add keep type docs #8063 (#8122) (#8735)
a135a7f
@AntonEliatra AntonEliatra deleted the adding-keep-types-token-filter branch November 13, 2024 10:55
epugh pushed a commit to o19s/documentation-website that referenced this pull request Nov 23, 2024
@AntonEliatra @kolchfa-aws
@natebower @epugh
Add keep type docs opensearch-project#8063 (opensearch-project#8122)
9582102 
* adding keep type docs opensearch-project#8063

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Update keep-types.md

Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>

* updating parameter table

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Update keep-types.md

Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>

* fixing types

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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

@natebower natebower natebower left review comments

@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_types [DOC]
4 participants
@AntonEliatra @vagimeli @natebower @kolchfa-aws