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

LTR documentation #8336

Merged
merged 161 commits into from
Oct 24, 2024
Merged

Conversation

epugh
Copy link
Collaborator

@epugh epugh commented Sep 18, 2024

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

No issues, however this replaces a previously opened PR that I messed up: #8074

Version

This documentation actually covers the most recent versions of LTR. So when we cut the 2.17 version, this would cover it, as well as the previous 2.16 and 2.15.

Signed-off-by: Eric Pugh <[email protected]>
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
Copy link
Collaborator

@epugh Please let us know when you're ready for doc review. Thanks.

@epugh
Copy link
Collaborator Author

epugh commented Sep 18, 2024

Okay @kolchfa-aws and colleagues, this PR is ready for review. We have one set of links to a demo in the https://github.com/opensearch-project/opensearch-learning-to-rank-base where that demo hasn't been published yet. However, everything else should be current. Looking forward to feedback.

Signed-off-by: Eric Pugh <[email protected]>
@vagimeli
Copy link
Collaborator

Okay @kolchfa-aws and colleagues, this PR is ready for review. We have one set of links to a demo in the https://github.com/opensearch-project/opensearch-learning-to-rank-base where that demo hasn't been published yet. However, everything else should be current. Looking forward to feedback.

I'm starting the review. The SLA is 5 days due to the volume of content. Thank you.

@epugh
Copy link
Collaborator Author

epugh commented Sep 19, 2024

@vagimeli I think that is a perfectly wonderful SLA! @scottstults will also being a pass through of the technical content as another set of eyes.

@vagimeli
Copy link
Collaborator

vagimeli commented Sep 19, 2024

@epugh Please give me permission to push to your branch. There are too many changes for me to go line by line in GitHib. For example, here's the revised content for advanced-functionality.md. I'd like to push the changes to the branch. This is the standard process for technical writers reviewing and revising contributor content. Thank you, Melissa
advanced-functionality.md

@vagimeli
Copy link
Collaborator

Doc review complete on advanced-functionality.md and faq.md. Files attached, as I don't have permission to commit and push my changes. Because of the many rewrites and edits, please use the attached .md files. I'll upload files as they each complete doc review. Thank you for putting up the initial PR.
advanced-functionality.md
faq.md

@vagimeli
Copy link
Collaborator

Doc review complete on building-features.md. See attached file for rewrites and edits.
building-features.md

@vagimeli
Copy link
Collaborator

Doc review complete on core-concepts.md. See attached file for rewrites and edits.
core-concepts.md

@vagimeli
Copy link
Collaborator

Doc review complete on feature-engineering.md. See attached file for rewrites and edits.
feature-engineering.md

@vagimeli
Copy link
Collaborator

Doc review complete on logging-features.md. See attached file for rewrites and edits.
logging-features.md

vagimeli and others added 5 commits October 24, 2024 17:09
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli and others added 13 commits October 24, 2024 17:15
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli
Copy link
Collaborator

@natebower Thank you for your quick turnaround on the 2,000+ lines :) I accepted all your edits and suggested rewrites.

Copy link
Collaborator

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

@epugh @JohannesDaniel Doc and editorial reviews completed. Thank you for drafting the documentation!

@vagimeli vagimeli merged commit 0242981 into opensearch-project:main Oct 24, 2024
6 checks passed
@vagimeli vagimeli deleted the introduce_ltr_plugin_v2 branch October 24, 2024 23:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress community A label for community-based contributions and tools Machine Learning v2.18.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants