Skip to content

[Rule Details] Update tooltip copy for Investigation Guide/Related Dashboards#224142

Merged
justinkambic merged 5 commits intoelastic:mainfrom
justinkambic:221426/tooltips-for-investigation-guide-and-linked-dashboards-on-create-rule-detail-step
Jun 23, 2025
Merged

[Rule Details] Update tooltip copy for Investigation Guide/Related Dashboards#224142
justinkambic merged 5 commits intoelastic:mainfrom
justinkambic:221426/tooltips-for-investigation-guide-and-linked-dashboards-on-create-rule-detail-step

Conversation

@justinkambic
Copy link
Contributor

@justinkambic justinkambic commented Jun 16, 2025 •
edited by kibanamachine
Loading

Summary

Resolves #221426.

Adds tooltip content for the Related Dashboards and Investigation Guide fields on the Details segment of the rule create/edit flow.

image

Testing this PR

Hover over the info tips on the form row for the Investigation Guide and Related Dashboard fields.

Ensure that they work and you can view the copy.

Technical Writer Feedback

The tooltips for these two fields are the main area we'd like additional feedback/refinement. If you have thoughts, please leave a review:

For additional context:

  • Investigation guide: at the moment it is a basic text field that allows users to include links and other information related to their rule to help with diagnosing/managing alerts.
  • Related dashboards: the user may choose to associate existing dashboards with their rule. These dashboards are likewise then shown on alerts that are subsequently triggered by the rule.

@justinkambic justinkambic self-assigned this Jun 16, 2025
@justinkambic justinkambic requested a review from a team as a code owner June 16, 2025 20:53
@justinkambic justinkambic added release_note:skip Skip the PR/issue when compiling release notes Team:actionable-obs Formerly "obs-ux-management", responsible for SLO, o11y alerting, significant events, & synthetics. backport:version Backport to applied version labels v9.1.0 v8.19.0 labels Jun 16, 2025
@elasticmachine
Copy link
Contributor

elasticmachine commented Jun 16, 2025

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

@github-actions github-actions bot added the author:obs-ux-management PRs authored by the obs ux management team label Jun 16, 2025
@justinkambic justinkambic force-pushed the 221426/tooltips-for-investigation-guide-and-linked-dashboards-on-create-rule-detail-step branch from 6d162b9 to a97ce38 Compare June 16, 2025 21:04
@justinkambic
Copy link
Contributor Author

justinkambic commented Jun 17, 2025

/oblt-deploy

nastasha-solomon
nastasha-solomon approved these changes Jun 17, 2025
View reviewed changes
Copy link
Contributor

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

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

Left some suggestions - hope they help!

@mgiota mgiota self-requested a review June 20, 2025 08:27
@mgiota
Copy link
Contributor

mgiota commented Jun 20, 2025

@elasticmachine merge upstream

mgiota
mgiota approved these changes Jun 20, 2025
View reviewed changes
Copy link
Contributor

@mgiota mgiota left a comment

Choose a reason for hiding this comment

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

LGTM! I couldn't build the project because of a minor issue in the translation copy that contained an apostrophe. I fixed in this commit and was able to verify that everything works as expected.

Screenshot 2025-06-20 at 12 18 19 Screenshot 2025-06-20 at 12 18 33

doakalexi
doakalexi approved these changes Jun 20, 2025
View reviewed changes
Copy link
Contributor

@doakalexi doakalexi left a comment

Choose a reason for hiding this comment

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

LGTM!

@justinkambic justinkambic force-pushed the 221426/tooltips-for-investigation-guide-and-linked-dashboards-on-create-rule-detail-step branch from 2128ad8 to 60c707b Compare June 23, 2025 17:33
@justinkambic justinkambic enabled auto-merge (squash) June 23, 2025 19:14
@justinkambic justinkambic merged commit 69a57a7 into elastic:main Jun 23, 2025
10 checks passed
@kibanamachine
Copy link
Contributor

kibanamachine commented Jun 23, 2025

Starting backport for target branches: 8.19

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

@elasticmachine
Copy link
Contributor

elasticmachine commented Jun 23, 2025

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
apm 1926 1927 +1
datasetQuality 739 740 +1
discover 1323 1324 +1
infra 1444 1445 +1
ml 2407 2408 +1
monitoring 632 633 +1
observability 1312 1313 +1
slo 1184 1185 +1
synthetics 1248 1249 +1
transform 695 696 +1
triggersActionsUi 877 878 +1
uptime 774 775 +1
total +12

Async chunks

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

id before after diff
apm 2.6MB 2.6MB +396.0B
datasetQuality 418.5KB 418.9KB +398.0B
discover 1.1MB 1.1MB +400.0B
infra 1.1MB 1.1MB +403.0B
ml 5.4MB 5.4MB +402.0B
monitoring 630.0KB 630.4KB +398.0B
observability 1.3MB 1.3MB +426.0B
slo 988.1KB 988.5KB +400.0B
synthetics 1.0MB 1.0MB +400.0B
transform 623.4KB 623.8KB +400.0B
triggersActionsUi 1.5MB 1.5MB +419.0B
uptime 490.4KB 490.8KB +398.0B
total +4.7KB

History

cc @justinkambic

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jun 23, 2025
@justinkambic
[Rule Details] Update tooltip copy for Investigation Guide/Related Da…
b3c08b7 
…shboards (elastic#224142)

## Summary

Resolves elastic#221426.

Adds tooltip content for the Related Dashboards and Investigation Guide
fields on the Details segment of the rule create/edit flow.

<img width="1039" alt="image"
src="https://github.com/user-attachments/assets/6f812ebc-7a4c-42d5-ae20-c557665a7f17"
/>

## Testing this PR

Hover over the info tips on the form row for the Investigation Guide and
Related Dashboard fields.

Ensure that they work and you can view the copy.

### Technical Writer Feedback

The tooltips for these two fields are the main area we'd like additional
feedback/refinement. If you have thoughts, please leave a review:

- [Investigation
guide](https://github.com/elastic/kibana/pull/224142/files#diff-f61636ed67a25004232d29347e88ca18b9ef0c8551dab5e192c64b524c6f077eR326)
- [Related
dashboards](https://github.com/elastic/kibana/pull/224142/files#diff-f61636ed67a25004232d29347e88ca18b9ef0c8551dab5e192c64b524c6f077eR117)

For additional context:

- Investigation guide: at the moment it is a basic text field that
allows users to include links and other information related to their
rule to help with diagnosing/managing alerts.
- Related dashboards: the user may choose to associate existing
dashboards with their rule. These dashboards are likewise then shown on
alerts that are subsequently triggered by the rule.

(cherry picked from commit 69a57a7)
@kibanamachine kibanamachine mentioned this pull request Jun 23, 2025
Merged
@kibanamachine
Copy link
Contributor

kibanamachine commented Jun 23, 2025

💚 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 23, 2025
@kibanamachine @justinkambic
[8.19] [Rule Details] Update tooltip copy for Investigation Guide/Rel…
4dcda7c 
…ated Dashboards (#224142) (#224952)

# Backport

This will backport the following commits from `main` to `8.19`:
- [[Rule Details] Update tooltip copy for Investigation Guide/Related
Dashboards (#224142)](#224142)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Justin
Kambic","email":"jk@elastic.co"},"sourceCommit":{"committedDate":"2025-06-23T19:39:05Z","message":"[Rule
Details] Update tooltip copy for Investigation Guide/Related Dashboards
(#224142)\n\n## Summary\n\nResolves #221426.\n\nAdds tooltip content for
the Related Dashboards and Investigation Guide\nfields on the Details
segment of the rule create/edit flow.\n\n<img width=\"1039\"
alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/6f812ebc-7a4c-42d5-ae20-c557665a7f17\"\n/>\n\n\n##
Testing this PR\n\nHover over the info tips on the form row for the
Investigation Guide and\nRelated Dashboard fields.\n\nEnsure that they
work and you can view the copy.\n\n### Technical Writer Feedback\n\nThe
tooltips for these two fields are the main area we'd like
additional\nfeedback/refinement. If you have thoughts, please leave a
review:\n\n-
[Investigation\nguide](https://github.com/elastic/kibana/pull/224142/files#diff-f61636ed67a25004232d29347e88ca18b9ef0c8551dab5e192c64b524c6f077eR326)\n-
[Related\ndashboards](https://github.com/elastic/kibana/pull/224142/files#diff-f61636ed67a25004232d29347e88ca18b9ef0c8551dab5e192c64b524c6f077eR117)\n\nFor
additional context:\n\n- Investigation guide: at the moment it is a
basic text field that\nallows users to include links and other
information related to their\nrule to help with diagnosing/managing
alerts.\n- Related dashboards: the user may choose to associate
existing\ndashboards with their rule. These dashboards are likewise then
shown on\nalerts that are subsequently triggered by the
rule.","sha":"69a57a7f9f28a968e69cabba91afe3cd1585e7f4","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:obs-ux-management","backport:version","v9.1.0","v8.19.0","author:obs-ux-management"],"title":"[Rule
Details] Update tooltip copy for Investigation Guide/Related
Dashboards","number":224142,"url":"https://github.com/elastic/kibana/pull/224142","mergeCommit":{"message":"[Rule
Details] Update tooltip copy for Investigation Guide/Related Dashboards
(#224142)\n\n## Summary\n\nResolves #221426.\n\nAdds tooltip content for
the Related Dashboards and Investigation Guide\nfields on the Details
segment of the rule create/edit flow.\n\n<img width=\"1039\"
alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/6f812ebc-7a4c-42d5-ae20-c557665a7f17\"\n/>\n\n\n##
Testing this PR\n\nHover over the info tips on the form row for the
Investigation Guide and\nRelated Dashboard fields.\n\nEnsure that they
work and you can view the copy.\n\n### Technical Writer Feedback\n\nThe
tooltips for these two fields are the main area we'd like
additional\nfeedback/refinement. If you have thoughts, please leave a
review:\n\n-
[Investigation\nguide](https://github.com/elastic/kibana/pull/224142/files#diff-f61636ed67a25004232d29347e88ca18b9ef0c8551dab5e192c64b524c6f077eR326)\n-
[Related\ndashboards](https://github.com/elastic/kibana/pull/224142/files#diff-f61636ed67a25004232d29347e88ca18b9ef0c8551dab5e192c64b524c6f077eR117)\n\nFor
additional context:\n\n- Investigation guide: at the moment it is a
basic text field that\nallows users to include links and other
information related to their\nrule to help with diagnosing/managing
alerts.\n- Related dashboards: the user may choose to associate
existing\ndashboards with their rule. These dashboards are likewise then
shown on\nalerts that are subsequently triggered by the
rule.","sha":"69a57a7f9f28a968e69cabba91afe3cd1585e7f4"}},"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/224142","number":224142,"mergeCommit":{"message":"[Rule
Details] Update tooltip copy for Investigation Guide/Related Dashboards
(#224142)\n\n## Summary\n\nResolves #221426.\n\nAdds tooltip content for
the Related Dashboards and Investigation Guide\nfields on the Details
segment of the rule create/edit flow.\n\n<img width=\"1039\"
alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/6f812ebc-7a4c-42d5-ae20-c557665a7f17\"\n/>\n\n\n##
Testing this PR\n\nHover over the info tips on the form row for the
Investigation Guide and\nRelated Dashboard fields.\n\nEnsure that they
work and you can view the copy.\n\n### Technical Writer Feedback\n\nThe
tooltips for these two fields are the main area we'd like
additional\nfeedback/refinement. If you have thoughts, please leave a
review:\n\n-
[Investigation\nguide](https://github.com/elastic/kibana/pull/224142/files#diff-f61636ed67a25004232d29347e88ca18b9ef0c8551dab5e192c64b524c6f077eR326)\n-
[Related\ndashboards](https://github.com/elastic/kibana/pull/224142/files#diff-f61636ed67a25004232d29347e88ca18b9ef0c8551dab5e192c64b524c6f077eR117)\n\nFor
additional context:\n\n- Investigation guide: at the moment it is a
basic text field that\nallows users to include links and other
information related to their\nrule to help with diagnosing/managing
alerts.\n- Related dashboards: the user may choose to associate
existing\ndashboards with their rule. These dashboards are likewise then
shown on\nalerts that are subsequently triggered by the
rule.","sha":"69a57a7f9f28a968e69cabba91afe3cd1585e7f4"}},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Justin Kambic <jk@elastic.co>
@justinkambic justinkambic deleted the 221426/tooltips-for-investigation-guide-and-linked-dashboards-on-create-rule-detail-step branch June 24, 2025 17:37
akowalska622 pushed a commit to akowalska622/kibana that referenced this pull request Jun 25, 2025
@justinkambic @akowalska622
[Rule Details] Update tooltip copy for Investigation Guide/Related Da…
2a62895 
…shboards (elastic#224142)

## Summary

Resolves elastic#221426.

Adds tooltip content for the Related Dashboards and Investigation Guide
fields on the Details segment of the rule create/edit flow.

<img width="1039" alt="image"
src="https://github.com/user-attachments/assets/6f812ebc-7a4c-42d5-ae20-c557665a7f17"
/>


## Testing this PR

Hover over the info tips on the form row for the Investigation Guide and
Related Dashboard fields.

Ensure that they work and you can view the copy.

### Technical Writer Feedback

The tooltips for these two fields are the main area we'd like additional
feedback/refinement. If you have thoughts, please leave a review:

- [Investigation
guide](https://github.com/elastic/kibana/pull/224142/files#diff-f61636ed67a25004232d29347e88ca18b9ef0c8551dab5e192c64b524c6f077eR326)
- [Related
dashboards](https://github.com/elastic/kibana/pull/224142/files#diff-f61636ed67a25004232d29347e88ca18b9ef0c8551dab5e192c64b524c6f077eR117)

For additional context:

- Investigation guide: at the moment it is a basic text field that
allows users to include links and other information related to their
rule to help with diagnosing/managing alerts.
- Related dashboards: the user may choose to associate existing
dashboards with their rule. These dashboards are likewise then shown on
alerts that are subsequently triggered by the rule.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@benakansara benakansara benakansara left review comments

@nastasha-solomon nastasha-solomon nastasha-solomon approved these changes

@mgiota mgiota mgiota approved these changes

@doakalexi doakalexi doakalexi approved these changes

@mdbirnstiehl mdbirnstiehl Awaiting requested review from mdbirnstiehl

Assignees

@justinkambic justinkambic

Labels

author:obs-ux-management PRs authored by the obs ux management team backport:version Backport to applied version labels release_note:skip Skip the PR/issue when compiling release notes Team:actionable-obs Formerly "obs-ux-management", responsible for SLO, o11y alerting, significant events, & synthetics. v8.19.0 v9.1.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Alerting] Update info copy for investigation guide and add similar tooltip to Dashboards field

7 participants

@justinkambic @elasticmachine @mgiota @kibanamachine @benakansara @nastasha-solomon @doakalexi