LTR documentation #8336
LTR documentation #8336
Conversation
Signed-off-by: Eric Pugh <[email protected]>
epugh
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
stephen-crawford
as code owners
|
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: Eric Pugh <[email protected]>
|
@epugh Please let us know when you're ready for doc review. Thanks. |
Signed-off-by: Eric Pugh <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
|
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]>
I'm starting the review. The SLA is 5 days due to the volume of content. Thank you. |
|
@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. |
|
@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 |
|
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. |
|
Doc review complete on building-features.md. See attached file for rewrites and edits. |
|
Doc review complete on core-concepts.md. See attached file for rewrites and edits. |
|
Doc review complete on feature-engineering.md. See attached file for rewrites and edits. |
|
Doc review complete on logging-features.md. See attached file for rewrites and edits. |
vagimeli
added
4 - Doc review
|
Doc review complete on fits-in.md. See attached file for rewrites and edits. |
|
Doc review complete on index.md. See attached file for rewrites and edits. |
|
Doc review complete on searching-with-your-model.md. See attached file for rewrites and edits. |
|
Doc review complete on training-models.md. See attached file for rewrites and edits. |
vagimeli
added
2 - In progress
| has_children: false | ||
| --- | ||
|
|
||
| # Advanced Functionality |
There was a problem hiding this comment.
Global comment: Rewrites and edits made to align to OpenSearch Project writing standards and style. We use a professional, concise, and simple language tone that considers a developer audience of all skill and English language levels. We also write for software documentation, not marketing.
Please see OpenSearch writing style guide . See also the Contributing OpenSearch documentation: a quick guide for developers
Feel free to reach out with any questions.
| logging fetch phase. Any values added to this Map will be returned with | ||
| the logged features: | ||
|
|
||
| @Override |
There was a problem hiding this comment.
Please check this example. I get errors during validation.
| For the sake of discussing logging, let's say we created a feature set | ||
| like so that works with the TMDB data set from the | ||
| [demo](http://github.com/opensearch-project/opensearch-learning-to-rank-base/tree/main/demo/): | ||
|
|
There was a problem hiding this comment.
Deleted demo language. The link doesn't exist.
There was a problem hiding this comment.
thanks... There is a ticket out there to add this back into the repo...
Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Eric Pugh <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Eric Pugh <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
|
@vagimeli I'm catching up on this PR after an exciting week at OpenSearchCon! I just added you to the https://github.com/o19s/documentation-website/ repo, which should let you push directly! Having said that, I'll also go through your attached files and get them committed, and then maybe another once over and we are good? |
Signed-off-by: Eric Pugh <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
|
@vagimeli what do you think about having @sstults and @JohannesDaniel do the technical review of the content? I think at this point, especially after your rewrite, we are done with the content phase. |
Signed-off-by: Eric Pugh <[email protected]>
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.