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] Add ES|QL doc structure #860

Merged
merged 4 commits into from
Jun 7, 2024

Conversation

marciw
Copy link
Contributor

@marciw marciw commented May 22, 2024

Adds an esql.asciidoc file that sets up a basic structure for the ES|QL documentation. Based on @szabosteve's Java client docs PR (#789).

@Anaethelion This needs expanding and tailoring for the Go client (it's really just placeholder text from the Java client docs). All feedback is welcome, especially because I'm still so new to Elastic and to the client docs.

Preview

@marciw marciw self-assigned this May 22, 2024
@marciw marciw marked this pull request as ready for review May 23, 2024 00:01
@marciw marciw requested review from Anaethelion and szabosteve May 23, 2024 00:02
@Anaethelion
Copy link
Contributor

@marciw I've reworded a bit the document and added relevant examples for the Go use cases.

I've not found the dataset used by the Java example so I've reworked it a bit to fit this one.

@marciw
Copy link
Contributor Author

marciw commented Jun 6, 2024

@Anaethelion Thanks, looks good! I just pushed one more small tweak to the phrasing. Take a look and then I think this is ready to merge. ✨

@Anaethelion Anaethelion merged commit 4d8fe93 into elastic:main Jun 7, 2024
13 checks passed
Anaethelion added a commit that referenced this pull request Jun 7, 2024
* Add ES|QL docs structure

* Fix variable; adjust TOC entry

* add examples to ES|QL documentation

* Small edit

---------

Co-authored-by: Laurent Saint-Félix <laurent.saintfelix@elastic.co>
Anaethelion added a commit that referenced this pull request Jun 7, 2024
* Add ES|QL docs structure

* Fix variable; adjust TOC entry

* add examples to ES|QL documentation

* Small edit

---------

Co-authored-by: marciw <333176+marciw@users.noreply.github.com>
@marciw marciw deleted the esql-docs-structure-go branch June 12, 2024 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants