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

[Infra UI] Asset Details Flyout: Add tooltip with documentation link in metadata summary #162132

Conversation

jennypavlova
Copy link
Member

@jennypavlova jennypavlova commented Jul 18, 2023

Summary

This PR adds a tooltip with a documentation link in the metadata summary inside the asset details overview section. It should appear only if we have defined documentation link so currently only for the host.ip field

Screenshot 2023-07-18 at 13 13 25

Storybook

image

Testing

  • Go to host view and open the asset details flyout for any host
  • Go to the overview tab
  • A question mark icon should appear next to the host ip title inside the metadata section
  • Click on the icon and check the tooltip
  • the host.ip link should open the documentation page for the field in a new tab
metadata_tooltip.mov

@jennypavlova jennypavlova added Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting labels Jul 18, 2023
@jennypavlova jennypavlova self-assigned this Jul 18, 2023
@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@jennypavlova jennypavlova marked this pull request as ready for review July 18, 2023 12:25
@jennypavlova jennypavlova requested a review from a team as a code owner July 18, 2023 12:25
@elasticmachine
Copy link
Contributor

Pinging @elastic/infra-monitoring-ui (Team:Infra Monitoring UI)

@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
infra 1.9MB 1.9MB +828.0B

History

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

cc @jennypavlova

Comment on lines +49 to +50
tooltipLinkLabel: 'host.ip',
tooltipLink: 'https://www.elastic.co/guide/en/ecs/current/ecs-host.html#field-host-ip',
Copy link
Contributor

Choose a reason for hiding this comment

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

For now, I think it's ok, but once we start integrating more asset types, we might have to rely on what findInventoryModel(nodeType) returns. ip info might sit in a different field name depending on the asset type. The same goes for the translations.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, we should revisit this once we have more asset types 👍

Copy link
Contributor

@crespocarlos crespocarlos left a comment

Choose a reason for hiding this comment

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

LGMT! 🚀

@jennypavlova jennypavlova merged commit 8f2d23f into elastic:main Jul 19, 2023
@jennypavlova jennypavlova deleted the 1135-infra-ui-show-fields-used-for-metadata-definition-in-overview-tab branch July 19, 2023 09:55
ThomThomson pushed a commit to ThomThomson/kibana that referenced this pull request Aug 1, 2023
…in metadata summary (elastic#162132)

## Summary

This PR adds a tooltip with a documentation link in the metadata summary
inside the asset details overview section. It should appear only if we
have defined documentation link so currently only for the `host.ip`
field

<img width="1918" alt="Screenshot 2023-07-18 at 13 13 25"
src="https://github.com/elastic/kibana/assets/14139027/e5ef2067-3a3b-48fd-a395-b763a6832bd1">

## Storybook

<img width="1917" alt="image"
src="https://github.com/elastic/kibana/assets/14139027/dfbd0118-b0ff-475b-a545-9e7278815098">


## Testing
- Go to host view and open the asset details flyout for any host
- Go to the overview tab
- A question mark icon should appear next to the host ip title inside
the metadata section
- Click on the icon and check the tooltip
- the `host.ip` link should open the documentation page for the field in
a new tab



https://github.com/elastic/kibana/assets/14139027/c83dcefd-34b1-4f61-aa96-b9fd0e6ef07b
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 release_note:skip Skip the PR/issue when compiling release notes Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v8.10.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants