Skip to content

[ES|QL] Add query description in the documentation prop#224195

Merged
stratoula merged 2 commits intoelastic:mainfrom
stratoula:recommended-queries-description-fix
Jun 18, 2025
Merged

[ES|QL] Add query description in the documentation prop#224195
stratoula merged 2 commits intoelastic:mainfrom
stratoula:recommended-queries-description-fix

Conversation

@stratoula
Copy link
Contributor

@stratoula stratoula commented Jun 17, 2025

Summary

Display the description on the documentation prop mostly for allowing markdown.

(There is also a monaco bug that I cant replicate but I hope this is fixing it)

Update: It is not fixing it but is def better

image

@elasticmachine
Copy link
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #61 / Agents fleet_list_agent should return metrics if available and called with withMetrics

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
unifiedSearch 363.4KB 363.5KB +51.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
kbnUiSharedDeps-srcJs 3.7MB 3.7MB +102.0B

@stratoula stratoula added v9.1.0 v8.19.0 Feature:ES|QL ES|QL related features in Kibana Team:ESQL ES|QL related features in Kibana t// backport:version Backport to applied version labels release_note:skip Skip the PR/issue when compiling release notes labels Jun 17, 2025
@stratoula stratoula marked this pull request as ready for review June 17, 2025 13:26
@stratoula stratoula requested a review from a team as a code owner June 17, 2025 13:26
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-esql (Team:ESQL)

@stratoula stratoula merged commit 13d9f49 into elastic:main Jun 18, 2025
22 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.19

https://github.com/elastic/kibana/actions/runs/15726681912

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jun 18, 2025
## Summary

Display the description on the documentation prop mostly for allowing
markdown.

(There is also a [monaco
bug](elastic#224054 (comment))
that I cant replicate but I hope this is fixing it)

Update: It is not fixing it but is def better

<img width="908" alt="image"
src="https://github.com/user-attachments/assets/e843fc23-284b-436c-b199-c43510227cf0"
/>

(cherry picked from commit 13d9f49)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.19

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Jun 18, 2025
…) (#224353)

# Backport

This will backport the following commits from `main` to `8.19`:
- [[ES|QL] Add query description in the documentation prop
(#224195)](#224195)

<!--- 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-06-18T07:31:14Z","message":"[ES|QL]
Add query description in the documentation prop (#224195)\n\n##
Summary\n\nDisplay the description on the documentation prop mostly for
allowing\nmarkdown.\n\n(There is also a
[monaco\nbug](https://github.com/elastic/kibana/pull/224054#issuecomment-2976159805)\nthat
I cant replicate but I hope this is fixing it)\n\nUpdate: It is not
fixing it but is def better \n\n<img width=\"908\"
alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/e843fc23-284b-436c-b199-c43510227cf0\"\n/>","sha":"13d9f4910b524846fa91193774db5678e5ee0b6c","branchLabelMapping":{"^v9.1.0$":"main","^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]
Add query description in the documentation
prop","number":224195,"url":"https://github.com/elastic/kibana/pull/224195","mergeCommit":{"message":"[ES|QL]
Add query description in the documentation prop (#224195)\n\n##
Summary\n\nDisplay the description on the documentation prop mostly for
allowing\nmarkdown.\n\n(There is also a
[monaco\nbug](https://github.com/elastic/kibana/pull/224054#issuecomment-2976159805)\nthat
I cant replicate but I hope this is fixing it)\n\nUpdate: It is not
fixing it but is def better \n\n<img width=\"908\"
alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/e843fc23-284b-436c-b199-c43510227cf0\"\n/>","sha":"13d9f4910b524846fa91193774db5678e5ee0b6c"}},"sourceBranch":"main","suggestedTargetBranches":["8.19"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/224195","number":224195,"mergeCommit":{"message":"[ES|QL]
Add query description in the documentation prop (#224195)\n\n##
Summary\n\nDisplay the description on the documentation prop mostly for
allowing\nmarkdown.\n\n(There is also a
[monaco\nbug](https://github.com/elastic/kibana/pull/224054#issuecomment-2976159805)\nthat
I cant replicate but I hope this is fixing it)\n\nUpdate: It is not
fixing it but is def better \n\n<img width=\"908\"
alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/e843fc23-284b-436c-b199-c43510227cf0\"\n/>","sha":"13d9f4910b524846fa91193774db5678e5ee0b6c"}},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","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

Labels

backport:version Backport to applied version labels Feature:ES|QL ES|QL related features in Kibana release_note:skip Skip the PR/issue when compiling release notes Team:ESQL ES|QL related features in Kibana t// v8.19.0 v9.1.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants