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

[DOC] Character filters - Pattern replace #8347

Conversation

leanneeliatra
Copy link
Contributor

Description

Updating the OpenSearch documentation to include a page on Pattern Replace filters in the Character filter analyzers section.

Issues Resolved

Part of #1483 addressed in this PR.

Version

all

Frontend features

n/a

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.

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.

leanneeliatra and others added 5 commits September 23, 2024 14:33
* Add doc on disk-based vector search

Signed-off-by: John Mazanec <[email protected]>

* Add training example

Signed-off-by: John Mazanec <[email protected]>

* Address comments

Signed-off-by: John Mazanec <[email protected]>

* Doc review

Signed-off-by: Fanit Kolchina <[email protected]>

* Typo

Signed-off-by: Fanit Kolchina <[email protected]>

* Another typo

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

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

---------

Signed-off-by: John Mazanec <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: [email protected] <[email protected]>
* Add Benchmark glossary

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

* Add text

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

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

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

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: [email protected] <[email protected]>
@leanneeliatra leanneeliatra force-pushed the addition-pattern-replace-character-filter branch from 5c26a6e to adf7611 Compare September 23, 2024 13:33
@leanneeliatra leanneeliatra changed the title Pattern replace character filter page added to documentation Character filters - Pattern replace Sep 23, 2024
@leanneeliatra leanneeliatra changed the title Character filters - Pattern replace [DOC] Character filters - Pattern replace Sep 23, 2024
@vagimeli vagimeli added 2 - In progress Issue/PR: The issue or PR is in progress. Content gap labels Sep 24, 2024
leanneeliatra and others added 15 commits October 4, 2024 14:18
…project#8266)

* feat: add ignore missing to text chunking processor

Signed-off-by: Ian Menendez <[email protected]>

* Update _ingest-pipelines/processors/text-chunking.md

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

---------

Signed-off-by: Ian Menendez <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
* Rework Becnhmark user guide IA

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

* More IA tweaks

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

* Add index pages.

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

* Add redirects

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

* Fix redirects. Add index page.

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

* Fix link

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

---------

Signed-off-by: Archer <[email protected]>
* adding classic token filter docs opensearch-project#7876

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

* Updating details as per comments

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

* Update classic.md

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

* Update classic.md

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

* Update classic.md

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

* Update _analyzers/token-filters/classic.md

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

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: AntonEliatra <[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]>
* Fix API template consistency.

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

* Fix broken links

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

* Rename request body headers

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

* Fix broken links

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

* Remove copy button from paths

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

* Add path parameters

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

* Additional doc feedback.

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

* Change parameter text.

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

* One more parameter.

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

---------

Signed-off-by: Archer <[email protected]>
…f_replicas (opensearch-project#8526)

* Document cluster.default_number_of_replicas and update index.number_of_replicas

Signed-off-by: Liyun Xiu <[email protected]>

* Apply suggestions from code review

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

---------

Signed-off-by: Liyun Xiu <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
* Add mapping parameters documentation

Signed-off-by: Melissa Vagi <[email protected]>

* Add mapping parameters documentation

Signed-off-by: Melissa Vagi <[email protected]>

* Add mapping parameters documentation

Signed-off-by: Melissa Vagi <[email protected]>

* Add mapping parameters documentation

Signed-off-by: Melissa Vagi <[email protected]>

* Add mapping parameters documentation

Signed-off-by: Melissa Vagi <[email protected]>

* Add files

Signed-off-by: Melissa Vagi <[email protected]>

* Add files

Signed-off-by: Melissa Vagi <[email protected]>

* Add files

Signed-off-by: Melissa Vagi <[email protected]>

* Write first-pass draft

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/analyzer.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/copy-to.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/coerce.md

Signed-off-by: Melissa Vagi <[email protected]>

* Address final tech review comments

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/copy-to.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/analyzer.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/analyzer.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/analyzer.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/coerce.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/copy-to.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update analyzer.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update boost.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update coerce.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update copy-to.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/analyzer.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/analyzer.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/analyzer.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/analyzer.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/analyzer.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/analyzer.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/boost.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/boost.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/boost.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/boost.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/boost.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/coerce.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/coerce.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/coerce.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/coerce.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/copy-to.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/copy-to.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update front matter

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/analyzer.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/boost.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/coerce.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _field-types/mapping-parameters/copy-to.md

Signed-off-by: Melissa Vagi <[email protected]>

* Delete empty files

Signed-off-by: Melissa Vagi <[email protected]>

* Delete empty files

Signed-off-by: Melissa Vagi <[email protected]>

* Delete empty files

Signed-off-by: Melissa Vagi <[email protected]>

* Delete empty files

Signed-off-by: Melissa Vagi <[email protected]>

* Delete empty files

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
* Add children aggregation documentation

Signed-off-by: Melissa Vagi <[email protected]>

* Add children aggregation documentation

Signed-off-by: Melissa Vagi <[email protected]>

* Add children aggregation documentation

Signed-off-by: Melissa Vagi <[email protected]>

* Add content gaps to list

Signed-off-by: Melissa Vagi <[email protected]>

* Update examples to include data samples

Signed-off-by: Melissa Vagi <[email protected]>

* Update _aggregations/bucket/children.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _aggregations/bucket/children.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _aggregations/bucket/children.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _aggregations/bucket/children.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _aggregations/bucket/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _aggregations/bucket/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _aggregations/bucket/children.md

Signed-off-by: Melissa Vagi <[email protected]>

* Fix dead links

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
leanneeliatra and others added 5 commits October 17, 2024 11:42
* Addition of Character filter documentation
Signed-off-by: [email protected] <[email protected]>

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

* Updates for readability and flow.

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

* Addding and testing examples for the HTML analyser page.

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

* updates for custom analyzer

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

* correcting page flow and headings

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

* updating nav order

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

* Update _analyzers/character-filters/html-character-filter.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _analyzers/character-filters/html-character-filter.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _analyzers/character-filters/html-character-filter.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _analyzers/character-filters/html-character-filter.md

Signed-off-by: Melissa Vagi <[email protected]>

* Doc review completed

Signed-off-by: Melissa Vagi <[email protected]>

* Doc review completed

Signed-off-by: Melissa Vagi <[email protected]>

* Update _analyzers/character-filters/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* review comments addressed

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

* Apply suggestions from code review

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

* apply review suggestions

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

* Update _analyzers/character-filters/html-character-filter.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _analyzers/character-filters/index.md

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: [email protected] <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: leanneeliatra <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
…ect#7900)

* adding documentation for filter search in OpenSearch

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

* Update _search-plugins/filter-search.md

Signed-off-by: Heather Halter <[email protected]>

* reviewdog updates

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

* Update filter-search.md

Doc review completed

Signed-off-by: Melissa Vagi <[email protected]>

* Incorporating review comments.

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

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: [email protected] <[email protected]>
Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
…-project#7933)

* adding common_gram token filter page opensearch-project#7923

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

* Update common_gram.md

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

* addressing the PR comments

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

* addressing the PR comments

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

* addressing the PR comments

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

* Apply suggestions from code review

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

* addressing the PR comments

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

* updating parameter table structure

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

* Apply suggestions from code review

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

---------

Signed-off-by: AntonEliatra <[email protected]>
Signed-off-by: Anton Rubin <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
@leanneeliatra
Copy link
Contributor Author

closed in favour of opening a new PR due to confusing merge conflicts.

#8557

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress. Content gap
Projects
None yet
Development

Successfully merging this pull request may close these issues.