Skip to content
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

[Console] Implement documentation action button #181057

Merged
merged 6 commits into from
Apr 22, 2024

Conversation

yuliacech
Copy link
Contributor

@yuliacech yuliacech commented Apr 17, 2024

Summary

Closes #180209

This PR implements the "view documentation" button in the new Monaco editor in Console. The code re-use the existing autocomplete functionality and gets the documentation link for the current request from autocomplete definitions. The current request is the 1st request of the user selection in the editor. The link is opened in the new tab and if no link is available or the request is unknown, then nothing happens (existing functionality, we might want to hide the button in that case in a follow up work)

Screen recording

Screen.Recording.2024-04-17.at.17.04.42.mov

How to test

  1. Add console.dev.enableMonaco: true to the config/kibana.dev.yml file
  2. Start Kibana and ES locally
  3. Navigate to the Dev tools Console and try using the "view documentation" button for various requests

@yuliacech yuliacech added Feature:Console Dev Tools Console Feature Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more labels Apr 17, 2024
@yuliacech yuliacech added the release_note:skip Skip the PR/issue when compiling release notes label Apr 17, 2024
@yuliacech yuliacech marked this pull request as ready for review April 17, 2024 15:50
@yuliacech yuliacech requested a review from a team as a code owner April 17, 2024 15:50
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-management (Team:Kibana Management)

@yuliacech yuliacech requested a review from a team as a code owner April 17, 2024 19:43
@botelastic botelastic bot added the Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team label Apr 17, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

@yuliacech yuliacech removed the request for review from a team April 18, 2024 07:36
@smith smith removed the Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team label Apr 18, 2024
@ElenaStoeva ElenaStoeva self-requested a review April 22, 2024 09:48
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

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
console 439.2KB 439.8KB +603.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Copy link
Contributor

@ElenaStoeva ElenaStoeva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work @yuliacech! Tested locally and it works as expected. Code changes also LGTM.

@yuliacech yuliacech merged commit e18d19f into elastic:main Apr 22, 2024
16 checks passed
@kibanamachine kibanamachine added v8.15.0 backport:skip This commit does not require backporting labels Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting Feature:Console Dev Tools Console Feature release_note:skip Skip the PR/issue when compiling release notes Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Console Monaco migration] Action button to open documentation
6 participants