Document the OS LTR plugin #8074

epugh · 2024-08-22T21:44:31Z

Description

The OpenSearch LTR plugin doesn't have any information in the documentation website.

See this spreadsheet to track the migration effort: https://docs.google.com/spreadsheets/d/1b81JlMCurjhPi-kaGW8eBkiV7s3x4NrtHpyPO3mlghg/edit?gid=0#gid=0

Issues Resolved

Version

2.17? We need to update the LTR plugin before this get's merged, it's very out of date.

See opensearch-project/opensearch-learning-to-rank-base#38 for the issue tracking the work to get a updated plugin released.

Checklist

[x ] 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 · 2024-08-22T21:44:44Z

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.

epugh · 2024-08-23T13:47:16Z

We will be tracking the work in this spreadsheet https://docs.google.com/spreadsheets/d/1b81JlMCurjhPi-kaGW8eBkiV7s3x4NrtHpyPO3mlghg/edit?gid=0#gid=0

…ion-website#8074 Signed-off-by: jzonthemtn <[email protected]>

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

* Add common operations section to User Guide. Signed-off-by: Archer <[email protected]> * Fix link Signed-off-by: Archer <[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]> Signed-off-by: Eric Pugh <[email protected]>

* Update known limitations for kNN based indexes Signed-off-by: Kunal Kotwani <[email protected]> * Update _tuning-your-cluster/availability-and-recovery/snapshots/searchable_snapshot.md Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Kunal Kotwani <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

According the code, the default value of `hasDocValues` is false https://github.com/opensearch-project/OpenSearch/blob/03d9a249e47b99b33c6de3625f43b12bef29c1cb/server/src/main/java/org/opensearch/index/mapper/BinaryFieldMapper.java#L85 Signed-off-by: kkewwei <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

Closes opensearch-project#8144 Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

…ject#8113) * added full file paths for security config files Signed-off-by: [email protected] <[email protected]> Signed-off-by: [email protected] <[email protected]> * added full file paths for security config files Signed-off-by: [email protected] <[email protected]> Signed-off-by: [email protected] <[email protected]> # Conflicts: # _security/configuration/yaml.md * small edits to full file paths for security config files Signed-off-by: [email protected] <[email protected]> Signed-off-by: [email protected] <[email protected]> * updates to file paths following tech review Signed-off-by: [email protected] <[email protected]> Signed-off-by: [email protected] <[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]> * Take into account previous changes Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: [email protected] <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

The original Data Prepper roadmap was a project linked to the repository. GitHub has been removing these and migrated it to a project linked to the organization instead. With this change on GitHub, the old URL became invalid and now shows a 404 page. Now commit is updating all occurrences of the old URL to use the new URL. Signed-off-by: David Venable <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

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

* Delete graphs and copy edit Signed-off-by: Melissa Vagi <[email protected]> * Delete graphs and copy edit Signed-off-by: Melissa Vagi <[email protected]> * Delete graphs and copy edit Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

* user accounts manipulation audit example Signed-off-by: jazzl0ver <[email protected]> * user accounts manipulation audit example Signed-off-by: jazzl0ver <[email protected]> * user accounts manipulation audit example Signed-off-by: jazzl0ver <[email protected]> * Update _security/audit-logs/index.md Co-authored-by: Craig Perkins <[email protected]> Signed-off-by: jazzl0ver <[email protected]> * Update _security/audit-logs/index.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: jazzl0ver <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Craig Perkins <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

…t#8198) * Fix heading levels in geoshape query documentation Signed-off-by: Fanit Kolchina <[email protected]> * One more Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

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

* Add documentation for max_number_processors Signed-off-by: Rai <[email protected]> * Refined the documentation Signed-off-by: Rai <[email protected]> * Doc review Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/index-processors.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _ingest-pipelines/processors/index-processors.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: Rai <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Rai <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

…ion (opensearch-project#8213) Signed-off-by: hainenber <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

…earch-project#8218) Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

* Doc update for concurrent search Signed-off-by: Ganesh Ramadurai <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Ganesh Krishna Ramadurai <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Ganesh Ramadurai <[email protected]> Signed-off-by: Ganesh Krishna Ramadurai <[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]>

* Add new settings for remote publication Signed-off-by: Sooraj Sinha <[email protected]> * Update remote-cluster-state.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * remove redundant lines Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Sooraj Sinha <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

…#8207) * Add documentation changes for shallow snapshot Signed-off-by: Anshu Agarwal <[email protected]> * Update create-repository.md Signed-off-by: Naarcha-AWS <[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]> * Update snapshot-interoperability.md Signed-off-by: Naarcha-AWS <[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: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Anshu Agarwal <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Anshu Agarwal <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

* adding asciifolding token filter page opensearch-project#7873 Signed-off-by: AntonEliatra <[email protected]> * updating the naming Signed-off-by: AntonEliatra <[email protected]> * updating as per PR comments Signed-off-by: AntonEliatra <[email protected]> * updating the heading Signed-off-by: AntonEliatra <[email protected]> * Updating details as per comments Signed-off-by: AntonEliatra <[email protected]> * Updating details as per comments Signed-off-by: AntonEliatra <[email protected]> * Updating details as per comments Signed-off-by: AntonEliatra <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: AntonEliatra <[email protected]> * updating as per comments Signed-off-by: Anton Rubin <[email protected]> * Apply suggestions from code review Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: AntonEliatra <[email protected]> * Update asciifolding.md Signed-off-by: AntonEliatra <[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: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

…search-project#8196) * Create documentation for snapshots with hashed prefix path type Signed-off-by: Ashish Singh <[email protected]> * Add documentation on new cluster settings for fixed prefix Signed-off-by: Ashish Singh <[email protected]> * Update create-repository.md * Update create-repository.md * 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: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Ashish Singh <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

* 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]>

* Grouping Top N queries documentation Signed-off-by: Siddhant Deshmukh <[email protected]> * Fix dead links Signed-off-by: Siddhant Deshmukh <[email protected]> * Fix dead link Signed-off-by: Siddhant Deshmukh <[email protected]> * Fix dead links Signed-off-by: Siddhant Deshmukh <[email protected]> * Address reviewdog comments Signed-off-by: Siddhant Deshmukh <[email protected]> * reviewdog fix Signed-off-by: Siddhant Deshmukh <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * Add table Signed-off-by: Siddhant Deshmukh <[email protected]> * Table review and added ability to collapse the response Signed-off-by: Fanit Kolchina <[email protected]> * More explanation to a couple of parameters Signed-off-by: Fanit Kolchina <[email protected]> * Typo fix 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]> * Editorial comment Signed-off-by: Fanit Kolchina <[email protected]> * Update _observing-your-data/query-insights/grouping-top-n-queries.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Siddhant Deshmukh <[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: Eric Pugh <[email protected]>

…t#8172) * Document reprovision param for Update Workflow API Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> --------- Signed-off-by: Daniel Widdis <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

* Update GET top N api documentation Signed-off-by: David Zane <[email protected]> * Update _observing-your-data/query-insights/top-n-queries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: David Zane <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: David Zane <[email protected]> Signed-off-by: David Zane <[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]>

opensearch-project#8127) * Update doc for adding new param in cat shards action for cancellation support Signed-off-by: Somesh Gupta <[email protected]> * Fixed comment Signed-off-by: Somesh Gupta <[email protected]> --------- Signed-off-by: Somesh Gupta <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

opensearch-project#8118) * add doc: skip_validating_missing_parameters Signed-off-by: yuye-aws <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * update: make both description consistent Signed-off-by: yuye-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: yuye-aws <[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: Eric Pugh <[email protected]>

opensearch-project#8171) * Document use_case param for Create Workflow API, link to existing docs Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Daniel Widdis <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

epugh · 2024-09-18T18:44:14Z

Closing in favour of #8336

epugh requested review from kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower, dlvenable and stephen-crawford as code owners August 22, 2024 21:44

github-actions bot assigned kolchfa-aws Aug 22, 2024

epugh force-pushed the introduce_ltr_plugin branch from 08d0af6 to 02d7b58 Compare August 23, 2024 13:49

epugh marked this pull request as draft August 23, 2024 13:49

epugh force-pushed the introduce_ltr_plugin branch 2 times, most recently from 7e3d176 to b629ea8 Compare August 23, 2024 17:37

epugh changed the title ~~Introduce LTR plugin~~ Document the OS LTR plugin Aug 23, 2024

epugh mentioned this pull request Aug 23, 2024

[BUG] the ./docs directory is a straight copy of the Elasticsearch docs and should be removed in favour of the documentation-website opensearch-project/opensearch-learning-to-rank-base#39

Closed

kolchfa-aws added the 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. label Aug 30, 2024

jzonthemtn added a commit to jzonthemtn/opensearch-learning-to-rank-base that referenced this pull request Sep 5, 2024

opensearch-project#39 Removing docs for opensearch-project/documentat…

fd6225d

…ion-website#8074 Signed-off-by: jzonthemtn <[email protected]>

jzonthemtn added a commit to jzonthemtn/opensearch-learning-to-rank-base that referenced this pull request Sep 5, 2024

opensearch-project#39 Removing docs for opensearch-project/documentat…

572590b

…ion-website#8074 Signed-off-by: jzonthemtn <[email protected]>

jzonthemtn mentioned this pull request Sep 5, 2024

Remove docs directory opensearch-project/opensearch-learning-to-rank-base#40

Merged

epugh added 10 commits September 12, 2024 10:39

Introduce LTR plugin

e51dd42

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

Introduce index page for LTR search.

406ff83

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

Mention two model tools that we will refer to in more docs..

d917e43

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

Tweak text, test signoff!

f666e0b

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

Core concepts of LTR page

5efa02d

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

Add how the plugin fits in, establish links between pages

8dfde6c

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

respond to vale warnings

9e4e34b

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

Add how the plugin fits in, establish links between pages

2809117

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

Vale lint

cdb1971

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

port over working with features page

7100f76

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

Naarcha-AWS and others added 26 commits September 12, 2024 10:40

Fix broken links (opensearch-project#8147)

31c2d0c

Closes opensearch-project#8144 Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

Fix type in query insights documentation (opensearch-project#8182)

1a22dd0

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

Remove ODFE color scheme (opensearch-project#8208)

a0b3c53

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

Allow copy as curl for Query DSL example in "Updating documents" sect…

93201e5

…ion (opensearch-project#8213) Signed-off-by: hainenber <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

Explicitly insert text that links PR with issue in PR template (opens…

5521731

…earch-project#8218) Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

epugh force-pushed the introduce_ltr_plugin branch from 3fc4cf0 to 444a813 Compare September 12, 2024 14:41

epugh mentioned this pull request Sep 18, 2024

LTR documentation #8336

Merged

epugh closed this Sep 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document the OS LTR plugin #8074

Document the OS LTR plugin #8074

epugh commented Aug 22, 2024 •

edited

Loading

github-actions bot commented Aug 22, 2024

epugh commented Aug 23, 2024

epugh commented Sep 18, 2024

Document the OS LTR plugin #8074

Document the OS LTR plugin #8074

Conversation

epugh commented Aug 22, 2024 • edited Loading

Description

Issues Resolved

Version

Checklist

github-actions bot commented Aug 22, 2024

epugh commented Aug 23, 2024

epugh commented Sep 18, 2024

epugh commented Aug 22, 2024 •

edited

Loading