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.

Sign up for GitHub

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

Jump to bottom

ESQL: Documentation meta issue #99072

Closed
11 of 13 tasks
costin opened this issue Aug 31, 2023 · 6 comments
Closed
11 of 13 tasks

ESQL: Documentation meta issue #99072

costin opened this issue Aug 31, 2023 · 6 comments
Assignees
@leemthompo
Labels
:Analytics/ES|QL AKA ESQL >docs General docs changes >enhancement Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team

Comments

@costin
Copy link
Member

costin commented Aug 31, 2023 •
edited by abdonpijpelink
Loading

Description

There are a number of gaps in the ES|QL documentation that need addressing.
I'm pointing them out in this ticket in no particular order:

Pre 8.11 release:

  • Overview / Introductory page - what and why is ES|QL
  • Getting started with ESQL - basic ingestion plus querying and examples
  • Limitations (we already have a paragraph - this needs to be extracted out)
  • Improve the consistency of functions page
  • section on Task management
  • section on Kibana interaction / screenshots
  • self-contained section on Enrich, Dissect and Grok
  • Security (role/permissions)
  • REST Endpoint (including different data formats, passing params to the query and the various other options like time_zone) - see ESQL: Document REST endpoint #99071 / ESQL: document request parameters #99284
  • Add release highlight content - Added release highlights to ESQL #100191

Post 8.11 release:

  • section on Multi-value handling and semantics
  • Validate all code snippets are in spec files (so they're tested) and move them if not
  • Expand Examples page (observability examples)
@costin costin added >enhancement >docs General docs changes :Analytics/ES|QL AKA ESQL labels Aug 31, 2023
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:QL (Deprecated) Meta label for query languages team labels Aug 31, 2023
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-ql (Team:QL)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/elasticsearch-esql (:Query Languages/ES|QL)

@abdonpijpelink abdonpijpelink mentioned this issue Oct 17, 2023
Merged
@costin costin added this to the 8.12 milestone Nov 16, 2023
@wchaparro wchaparro removed this from the 8.12 milestone Dec 20, 2023
@wchaparro wchaparro added the Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) label Jan 2, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-analytics-geo (Team:Analytics)

@elasticsearchmachine elasticsearchmachine removed the Team:QL (Deprecated) Meta label for query languages team label Jan 2, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-analytical-engine (Team:Analytics)

@abdonpijpelink
Copy link
Contributor

I'm going to close this issue, as all items have been addressed, except:

@nik9000 nik9000 assigned leemthompo and unassigned abdonpijpelink Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@leemthompo leemthompo

Labels
:Analytics/ES|QL AKA ESQL >docs General docs changes >enhancement Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@costin @wchaparro @abdonpijpelink @leemthompo @elasticsearchmachine