Skip to content

[9.0] Split ES|QL functions/operators/commands into separate pages for similar functions and make commands examples generated (#126279) #126624

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

Conversation

craigtaverner
Copy link
Contributor

This is a manual backport of #126279

…lar functions and make commands examples generated (elastic#126279)

While the internal structure of the docs is already split into many (over 1000) sub-pages, the final display for the `Functions and Operators` page is a single giant page, making navigation harder. This PR splits it into separate pages, one for each group of similar functions and one for the operators. Twelve new pages.

This PR also bundles a few other related changes. In total what is done is:
* Split functions/operators into 12 pages, one for each group, maintaining the existing split of each function/operator into a snippet with dynamically generated examples
* Split esql-commands.md into source-commands.md and processing-commands.md, each of which is split into individual snippets, one for each command
* Each command snippet has it's examples split out into separate files, if they were examples that were dynamically generated in the older asciidoc system
* The examples files are overwritten by the ES|QL unit tests, using a similar mechanism to the examples written for functions and operators)
* Some additional refinements to the Kibana definition and markdown files (nicer operator headings, and display text)
@craigtaverner craigtaverner added >docs General docs changes backport Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) :Analytics/ES|QL AKA ESQL v9.0.1 labels Apr 10, 2025
@elasticsearchmachine elasticsearchmachine merged commit 942640e into elastic:9.0 Apr 10, 2025
16 checks passed
@craigtaverner craigtaverner deleted the 9.0_esql_split_docs_pages_functions_operators branch April 10, 2025 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Analytics/ES|QL AKA ESQL auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) backport >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) v9.0.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants