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 #2563

Closed
wants to merge 1 commit into from

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

This includes adding a folder structure for helpers instead of keeping the docs all on one page (but we can undo that).

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

Preview
coming soon

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@marciw marciw self-assigned this May 22, 2024
@marciw marciw marked this pull request as ready for review May 23, 2024 00:10
@pquentin
Copy link
Member

Thank you @marciw! The main issue here is that Python does not have ES|QL helpers yet and there are no immediate plans to add some. The Java text does not really apply. However I would like to add ES|QL docs. One option would be to add https://www.elastic.co/search-labs/blog/esql-pandas-dataframes-python under "Integrations -> Pandas".

Another option would be to add a new page explaining how to make queries, including the Query DSL and ES|QL. Any thoughts?

@pquentin pquentin removed their request for review May 24, 2024 06:46
@marciw
Copy link
Contributor Author

marciw commented May 24, 2024

The main issue here is that Python does not have ES|QL helpers yet and there are no immediate plans to add some.

Ohhhhhh, ha, thanks for clarifying 👍

One option would be to add https://www.elastic.co/search-labs/blog/esql-pandas-dataframes-python under "Integrations -> Pandas".

This sounds like a great idea in the short term!

Another option would be to add a new page explaining how to make queries, including the Query DSL and ES|QL. Any thoughts?

... and then this sounds like a great idea in the long (or medium) term, at which point we could decide whether to keep the Pandas integration doc with tweaks, or move the content to the new queries page.

WDYT? Either way, I can start the PR(s) w/ some structure and placeholder text, if you like. (Will probably close this one)

@pquentin
Copy link
Member

That sounds good! Let's start with the Pandas integration, ideally adding ES|QL in the page title too. Thanks!

@marciw marciw closed this May 28, 2024
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.

None yet

2 participants