-
Notifications
You must be signed in to change notification settings - Fork 243
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
[DOCS] Adds the structure of the ES|QL docs #789
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with minor suggestions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added the text for each of the sections. This doesn't include the actual examples, and can be used a blueprint for other languages (there are few java-specific terms though)
…lasticsearch-java into szabosteve/esql-docs-structure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@szabosteve I did another review for clarity, conciseness, and style.
@swallez My edits are mostly for @szabosteve (I'm trying to get more familiar with our writing style and best practices here) but you're welcome to review too!
Co-authored-by: Marci Windsheimer <[email protected]>
@l-trotta can you create sample code for the various sections? Some of it can be imported from the blog post you wrote. |
code examples added! just one thing, @swallez correct me if I'm wrong, but since we don't have an adapter for the columnar format I think we should move its explanation so that it's not grouped with the adapters. |
@l-trotta indeed. This PR served as a blueprint for all clients documentation. Let's remove the columnar format for now and re-add it once we have the Arrow integration. |
@szabosteve ready! |
Overview
This PR adds an
esql.asciidoc
file to the docs that contains the basic structure of the ES|QL documentation. As thehelpers
are documented under theUsage
section in the Java book, the ES|QL documentation is proposed to be under theUsage
section.@swallez Every feedback is welcome (placement, structure, content, titles, etc). Please let me know what you think!
Preview
ES|QL in the Java client