opensearch-project
PPL reference manual should be part of docset [DOC]
What do you want to do?
- [ X] Request a change to existing documentation
- [ ] Add new documentation
- [ ] Report a technical problem with the documentation
- [ ] Other
Tell us about your request. Provide a summary of the request.
Currently, in https://opensearch.org/docs/latest/search-plugins/sql/ppl/index/, OpenSearch PPL Reference Manual links to a github repo. This means that there is no easy way to search within it. (Maybe there is some way in github to search a subtree, but I don't know it.)
*Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.
2.15
What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
It isn't clear what the relationship is between the PPL doc on the OpenSearch site (https://opensearch.org/docs/latest/search-plugins/sql/ppl/index/) and the Reference Manual. Is the Reference Manual supposed to be more definitive or more complete?
Hi @smacrakis, ideally, the content in the reference guide (the guide is linked in the UI, as well) would be part of the PPL content on opensearch.org. But we don't have the bandwidth to move it all over. You're right that we should explain how the GitHub information supplements the content we have in the documentation. @nitincd @vagimeli - thoughts?
