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

[DOCS] Adds the structure of the ES|QL docs #789

Merged
merged 14 commits into from
Jun 3, 2024

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Apr 29, 2024

Overview

This PR adds an esql.asciidoc file to the docs that contains the basic structure of the ES|QL documentation. As the helpers are documented under the Usage section in the Java book, the ES|QL documentation is proposed to be under the Usage 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

@szabosteve szabosteve added the Area: Documentation Improvements or additions to documentation label Apr 29, 2024
@szabosteve szabosteve self-assigned this Apr 29, 2024
@szabosteve szabosteve marked this pull request as ready for review April 29, 2024 13:46
@szabosteve szabosteve requested review from swallez and marciw and removed request for marciw April 29, 2024 13:46
Copy link
Contributor

@marciw marciw left a 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

docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
Copy link
Member

@swallez swallez left a 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)

docs/usage/esql.asciidoc Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@marciw marciw left a 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!

docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
Co-authored-by: Marci Windsheimer <[email protected]>
docs/usage/esql.asciidoc Outdated Show resolved Hide resolved
@swallez
Copy link
Member

swallez commented May 22, 2024

@l-trotta can you create sample code for the various sections? Some of it can be imported from the blog post you wrote.

@l-trotta
Copy link
Contributor

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.

@swallez
Copy link
Member

swallez commented May 29, 2024

@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.

@l-trotta
Copy link
Contributor

l-trotta commented Jun 3, 2024

@szabosteve ready!

@l-trotta l-trotta merged commit f3fbf3c into main Jun 3, 2024
7 checks passed
@l-trotta l-trotta deleted the szabosteve/esql-docs-structure branch June 3, 2024 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants