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.

Sign up for GitHub

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

Jump to bottom

[PROPOSAL] Build documents #92

Open
ylwu-amzn opened this issue Dec 20, 2024 · 2 comments
Open

[PROPOSAL] Build documents #92

ylwu-amzn opened this issue Dec 20, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@ylwu-amzn
Copy link
Collaborator

Suggest build documents :

  1. Add a docs/tutorials folder, build tutorials to explain how to use LTR.
  2. Add DEVELOPER_GUIDE doc , explain how to contribute for developers. Like how to set up dev env, how to debug etc.
@JohannesDaniel
Copy link
Collaborator

@ylwu-amzn There are comprehensive descriptions in https://opensearch.org/docs/latest/search-plugins/ltr/index/
Why would we need another tutorial section? I think this would rather lead to confusion as the doc/tutorial section will never be as comprehensive and complete as the documentation?

+1 for the developer guide!

@JohannesDaniel JohannesDaniel added documentation Improvements or additions to documentation and removed untriaged labels Dec 22, 2024
@ylwu-amzn
Copy link
Collaborator Author

Make sense to use https://opensearch.org/docs/latest/search-plugins/ltr/index/. Sometimes we see outdated doc, can you help check if the doc still up to date and correct ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
Search Project Board
Status: 🆕 New
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JohannesDaniel @ylwu-amzn