elastic/kibana

[Security Solution] Refine tooltip message for Related Integrations

Open

#153,228 opened on Mar 15, 2023

View on GitHub
 (9 comments) (0 reactions) (0 assignees)TypeScript (8,021 forks)batch import
Feature:Prebuilt Detection RulesFeature:Related IntegrationsTeam: SecuritySolutionTeam:Detection EngineeringTeam:Detection Rule ManagementTeam:Detections and Respenhancementgood first issuesdh-linked

Repository metrics

Stars
 (19,065 stars)
PR merge metrics
 (Avg merge 1d 16h) (999 merged PRs in 30d)

Description

Summary

The current tooltip message for related integrations is causing confusion among users. The message displayed is:

"Install and configure one or more of the below integrations to ingest the necessary data for this detection rule."

However, this message might lead users to believe that installing any single integration would be sufficient for the rule to function properly. In reality, certain rules may require multiple integrations to work correctly. To clarify the requirements, the tooltip message should be updated.

See the linked SDH for more detail.

Proposed Solution

Update the tooltip message to:

"One or more integrations may be required for this rule to work correctly. Please refer to the setup guide section of the rule for more information."

This new message will better inform users that multiple integrations might be necessary for the rule to function properly and direct them to the setup guide for more information.

Contributor guide

Research direction
Find the tooltip component for related integrations in the Security Solution UI and update the message string to the proposed text.
Tech stack
typescript
Domain
security
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90