[DOCS] Update ES|QL generated docs to consistently use the applies_to metadata#128576
Merged
leemthompo merged 48 commits intoelastic:mainfrom Jun 23, 2025
Merged
[DOCS] Update ES|QL generated docs to consistently use the applies_to metadata#128576leemthompo merged 48 commits intoelastic:mainfrom
applies_to metadata#128576leemthompo merged 48 commits intoelastic:mainfrom
Conversation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the documentation generation system for ESQL functions to correctly generate
applies_tometadata in DocsV3, namely to support multiple versions and lifecycles.This metadata is needed to signal version differentiation in the new docs, because we don't publish version-branched docs in 9.x (we don't duplicate every page for every minor).
For example, if something is preview in 9.0 and GA in 9.1 we need all this information on single, live 9.x page, that's what
applies_toenables. Importantly, this also enables us to correctly signal serverless feature availability in the new docs.We need different levels of
applies_todiscrimination for this:Important
Once this PR is merged, we will use this new documentation generation logic to properly GA full-text search functions in a follow-up PR.
Key changes
1. Documentation generation code
x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/Example.java- Addedapplies_to()field for version-specific examplesx-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3Support.java- Updated to generate standardizedapplies_toblocks instead of manual calloutsNote
DocsV3Support.javacontains the most significant docs gen code changes:2. Function status corrections
applies_tosyntaxST_*): Added missingpreview = trueflags, and now use properapplies_tosyntax3. Generated documentation updates
As a result all of the function code adjusted results in updated markdown and Kibana JSON file updates
Result
The documentation system now correctly generates version-aware metadata, enabling proper lifecycle tracking across versions. All full-text search functions are consistently marked as technical preview with the correct
applies_tosyntax, to enable us flipping them to GA for 9.1.👀 URL preview