Additional support for docs for ES|QL operators and version-specific differentiation #125251
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
craigtaverner
added
>docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-analytical-engine (Team:Analytics) |
And doing a bunch of related cleanups on examples formatting and capitalization.
craigtaverner
changed the title
I noticed that their internal hard-coded examples all had this.
nik9000
approved these changes
Mar 21, 2025
drewdaemon
reviewed
Mar 21, 2025
There was a problem hiding this comment.
The Kibana stuff looks great. I like the links and it's great to have these MD files for the inline docs.
There are some incorrect return types in the new operator JSON definitions. It would be nice to see those be accurate, but if it looks too hard, we can explore a plan B.
docs/reference/query-languages/esql/kibana/definition/operators/cast.json
Outdated
Show resolved
Hide resolved
docs/reference/query-languages/esql/kibana/definition/operators/predicates.json
Outdated
Show resolved
Hide resolved
stratoula
reviewed
Mar 24, 2025
| @@ -5,7 +5,7 @@ This is generated by ESQL’s AbstractFunctionTestCase. Do no edit it. See ../RE | |||
| ### ABS | |||
| Returns the absolute value. | |||
|
|
|||
| ``` | |||
| ```esql | |||
There was a problem hiding this comment.
I have a script that already adds it on the kibana side. If you are going to add it always I can remove it from the kibana implementation but if this is something that wil get missed is better to remove it from here and let kibana handle it. Is it added manually or by a script?
There was a problem hiding this comment.
Added by script. It turned out that the two places I added the back-ticks were not identical. We need it for the normal docs, but missed it for the Kibana docs. Considering how I'd like to try move the two places closer together (reuse more code), it is better if I keep adding it.
There was a problem hiding this comment.
ok makes sense, I will remove it from our script then
craigtaverner
added a commit
to craigtaverner/elasticsearch
that referenced
this pull request
Mar 24, 2025
…pecific differentiation (elastic#125251)" This reverts commit 8ffecb4.
stratoula
added a commit
to elastic/kibana
that referenced
this pull request
Mar 24, 2025
…S docs already (#215631) ## Summary This PR elastic/elasticsearch#125251 adds highlighting for the code blocks so it is not needed to be added on the kibana side. This PR removes it. I didnt run the script because it will remove the highlighting. It will run next Monday with @craigtaverner 's PR being merged
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Mar 24, 2025
…S docs already (elastic#215631) ## Summary This PR elastic/elasticsearch#125251 adds highlighting for the code blocks so it is not needed to be added on the kibana side. This PR removes it. I didnt run the script because it will remove the highlighting. It will run next Monday with @craigtaverner 's PR being merged (cherry picked from commit 935fc0f)
JoseLuisGJ
pushed a commit
to JoseLuisGJ/kibana
that referenced
this pull request
Mar 24, 2025
…S docs already (elastic#215631) ## Summary This PR elastic/elasticsearch#125251 adds highlighting for the code blocks so it is not needed to be added on the kibana side. This PR removes it. I didnt run the script because it will remove the highlighting. It will run next Monday with @craigtaverner 's PR being merged
kibanamachine
added a commit
to elastic/kibana
that referenced
this pull request
Mar 24, 2025
…d by ES docs already (#215631) (#215720) # Backport This will backport the following commits from `main` to `8.x`: - [[ES|QL] Removes highlighting from script as it is being provided by ES docs already (#215631)](#215631) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Stratoula Kalafateli","email":"efstratia.kalafateli@elastic.co"},"sourceCommit":{"committedDate":"2025-03-24T14:17:12Z","message":"[ES|QL] Removes highlighting from script as it is being provided by ES docs already (#215631)\n\n## Summary\n\nThis PR elastic/elasticsearch#125251 adds\nhighlighting for the code blocks so it is not needed to be added on the\nkibana side. This PR removes it.\n\nI didnt run the script because it will remove the highlighting. It will\nrun next Monday with @craigtaverner 's PR being merged","sha":"935fc0f7588f0efd06a40a98b929a28933869743","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:ES|QL","Team:ESQL","backport:version","v9.1.0","v8.19.0"],"title":"[ES|QL] Removes highlighting from script as it is being provided by ES docs already","number":215631,"url":"https://github.com/elastic/kibana/pull/215631","mergeCommit":{"message":"[ES|QL] Removes highlighting from script as it is being provided by ES docs already (#215631)\n\n## Summary\n\nThis PR elastic/elasticsearch#125251 adds\nhighlighting for the code blocks so it is not needed to be added on the\nkibana side. This PR removes it.\n\nI didnt run the script because it will remove the highlighting. It will\nrun next Monday with @craigtaverner 's PR being merged","sha":"935fc0f7588f0efd06a40a98b929a28933869743"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/215631","number":215631,"mergeCommit":{"message":"[ES|QL] Removes highlighting from script as it is being provided by ES docs already (#215631)\n\n## Summary\n\nThis PR elastic/elasticsearch#125251 adds\nhighlighting for the code blocks so it is not needed to be added on the\nkibana side. This PR removes it.\n\nI didnt run the script because it will remove the highlighting. It will\nrun next Monday with @craigtaverner 's PR being merged","sha":"935fc0f7588f0efd06a40a98b929a28933869743"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Stratoula Kalafateli <efstratia.kalafateli@elastic.co>
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.
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:
applies_tofor 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.