add synonym token filter docs #8447 by AntonEliatra · Pull Request #8457 · opensearch-project/documentation-website

AntonEliatra · 2024-10-02T16:23:45Z

Description

add synonym token filter docs

Issues Resolved

Closes #8447

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.

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

github-actions · 2024-10-02T16:23:56Z

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.

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

vagimeli · 2024-10-03T16:21:37Z

@udabhas @varun-lodaya Please provide tech review approval to move this PR forward in the documentation process. Please review this week or provide a peer who can review it. Thank you.

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

…iatra/documentation-website into adding-synonym-token-filter-docs

prudhvigodithi · 2024-11-19T21:00:21Z

Hey just checking on this, can we please get this merged. I have a new configuration setting synonym_analyzer (Related PR opensearch-project/OpenSearch#16488) added to synonym_graph (related existing PR #8458) and synonym. I would like to add this settings details (targeted for 2.19.0 release) to the doc once merged. I'm happy to review the PR if required.
Thank you
@kolchfa-aws @vagimeli @getsaurabh02 @msfroh

kolchfa-aws · 2024-11-19T21:41:02Z

Hey @prudhvigodithi I am doing a doc review on this PR. Once it goes through editorial review, we'll merge. Editorial review will happen next week. Please feel free to add your comments/suggestions. Thanks!

prudhvigodithi · 2024-11-19T22:31:51Z

Nice, thanks @kolchfa-aws.

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

natebower

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

natebower · 2024-11-25T12:24:39Z

_analyzers/token-filters/synonym.md

+Parameter | Required/Optional | Data type | Description
+:--- | :--- | :--- | :--- 
+`synonyms` | Either `synonyms` or `synonyms_path` must be specified | String | A list of synonym rules defined directly in the configuration.
+`synonyms_path` | Either `synonyms` or `synonyms_path` must be specified | String |  The file path to a file containing synonym rules (either an absolute path or a path relative to the config directory).


Should "config" be "configuration" or "config"?

_analyzers/token-filters/synonym.md

natebower · 2024-11-25T12:27:10Z

_analyzers/token-filters/synonym.md

+
+Parameter | Required/Optional | Data type | Description
+:--- | :--- | :--- | :--- 
+`synonyms` | Either `synonyms` or `synonyms_path` must be specified | String | A list of synonym rules defined directly in the configuration.


Nit: Here and on the following line, because they are technically complete sentences, the "Either" sentences should end with a period (I believe, however, that we may not do this on the other pages).

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

* add synonym token filter docs #8447 Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> * adding more explanation to expand parameter Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> * updating parameter table Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> * Doc review Signed-off-by: Fanit Kolchina <kolchfa@amazon.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: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.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 e6abc60) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…ject#8457) * add synonym token filter docs opensearch-project#8447 Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> * adding more explanation to expand parameter Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> * updating parameter table Signed-off-by: Anton Rubin <anton.rubin@eliatra.com> * Doc review Signed-off-by: Fanit Kolchina <kolchfa@amazon.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: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.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>

add synonym token filter docs opensearch-project#8447

0fb8dda

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

AntonEliatra requested review from AMoo-Miki, Naarcha-AWS, dlvenable, epugh, kolchfa-aws, natebower, stephen-crawford and vagimeli as code owners October 2, 2024 16:23

github-actions bot assigned kolchfa-aws Oct 2, 2024

kolchfa-aws assigned vagimeli and unassigned kolchfa-aws Oct 2, 2024

adding more explanation to expand parameter

80e07ca

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

vagimeli added Tech review PR: Tech review in progress Needs SME backport 2.17 Backport for version 2.17 labels Oct 3, 2024

AntonEliatra added 3 commits October 3, 2024 20:47

Merge branch 'main' into adding-synonym-token-filter-docs

1db3203

updating parameter table

aaa5fdd

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

Merge branch 'adding-synonym-token-filter-docs' of github.com:AntonEl…

de1f8fe

…iatra/documentation-website into adding-synonym-token-filter-docs

Doc review

8784138

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

kolchfa-aws assigned kolchfa-aws and unassigned vagimeli Nov 21, 2024

kolchfa-aws removed Tech review PR: Tech review in progress Needs SME labels Nov 21, 2024

kolchfa-aws added 5 - Editorial review backport 2.18 PR: Backport label for 2.18 labels Nov 21, 2024

natebower reviewed Nov 25, 2024

View reviewed changes

kolchfa-aws and others added 2 commits November 25, 2024 09:46

Apply suggestions from code review

0892ddb

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

Merge branch 'main' into adding-synonym-token-filter-docs

85bb255

kolchfa-aws approved these changes Nov 25, 2024

View reviewed changes

kolchfa-aws merged commit e6abc60 into opensearch-project:main Nov 25, 2024

opensearch-trigger-bot bot mentioned this pull request Nov 25, 2024

[Backport 2.17] add synonym token filter docs #8447 #8802

Merged

opensearch-trigger-bot bot mentioned this pull request Nov 25, 2024

[Backport 2.18] add synonym token filter docs #8447 #8803

Merged

github-actions bot pushed a commit that referenced this pull request Nov 25, 2024

add synonym token filter docs #8447 (#8457) (#8802)

f2bd194

github-actions bot pushed a commit that referenced this pull request Nov 25, 2024

add synonym token filter docs #8447 (#8457) (#8803)

fe080a6

AntonEliatra deleted the adding-synonym-token-filter-docs branch April 23, 2025 08:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add synonym token filter docs #8447#8457

add synonym token filter docs #8447#8457
kolchfa-aws merged 8 commits intoopensearch-project:mainfrom
AntonEliatra:adding-synonym-token-filter-docs

AntonEliatra commented Oct 2, 2024

Uh oh!

github-actions bot commented Oct 2, 2024

Uh oh!

vagimeli commented Oct 3, 2024

Uh oh!

prudhvigodithi commented Nov 19, 2024

Uh oh!

kolchfa-aws commented Nov 19, 2024

Uh oh!

prudhvigodithi commented Nov 19, 2024

Uh oh!

natebower left a comment

Uh oh!

natebower Nov 25, 2024

Uh oh!

Uh oh!

natebower Nov 25, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

AntonEliatra commented Oct 2, 2024

Description

Issues Resolved

Version

Checklist

Uh oh!

github-actions bot commented Oct 2, 2024

Uh oh!

vagimeli commented Oct 3, 2024

Uh oh!

prudhvigodithi commented Nov 19, 2024

Uh oh!

kolchfa-aws commented Nov 19, 2024

Uh oh!

prudhvigodithi commented Nov 19, 2024

Uh oh!

natebower left a comment

Choose a reason for hiding this comment

Uh oh!

natebower Nov 25, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

natebower Nov 25, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants