Skip to content

Conversation

@craigtaverner
Copy link
Contributor

Manual backport of two PRs:

Even though the docs are not needed in 9.0, due to all docs being published off main, doing the backport makes future backports of non-docs, but docs-adjacent PRs easier.

Did a few things:
* Rewrite Kibana docs asciidoc links to be MD links
* Make kibana docs links absolute to planned publication path
* Clarify which operators are generated and which are static
* Removed the trailing .md from kibana docs links
…differentiation (elastic#125251)

This PR was originally focused on improving support for Kibana docs, in particular the missing operator docs, but it has expanded to cover a bunch of related things:

* Primarily the main work was to improve operators support. ESQL generated docs cover all functions and most operators for which their is a clear operator class and test class. However, some are built-in behaviour and need additional support. This PR adds more generated content for those operators.
* Various specific operators requested by Kibana: Cast & null-predicates, and in particular the addition of examples
* Two functions without examples: mv_append and to_date_nanos
* Many small visual document cleanups (spelling, grammar, capitalization, etc.)
* Initial support for `applies_to` for multi-version differentiation.

This last point requires more work, as it is not yet agreed on just how we want this to look. We'll probably need to do refinements in followup PR. Consider the version in this PR as a first step into how this could look.
@craigtaverner craigtaverner added >docs General docs changes 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 Mar 28, 2025
@craigtaverner craigtaverner requested review from a team as code owners March 28, 2025 09:22
@craigtaverner craigtaverner changed the base branch from main to 9.0 March 28, 2025 09:23
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Mar 28, 2025
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine elasticsearchmachine merged commit 0722687 into elastic:9.0 Mar 28, 2025
16 checks passed
@craigtaverner craigtaverner deleted the 9.0_esql_docs_backport branch March 28, 2025 10:22
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!) >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team v9.0.1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants