Skip to content

docs(streams): update Discovery settings labels and help text#258328

Merged
ruflin merged 3 commits intoelastic:mainfrom
ruflin:docs/streams-discovery-settings-labels
Mar 18, 2026
Merged

docs(streams): update Discovery settings labels and help text#258328
ruflin merged 3 commits intoelastic:mainfrom
ruflin:docs/streams-discovery-settings-labels

Conversation

@ruflin
Copy link
Copy Markdown
Contributor

@ruflin ruflin commented Mar 18, 2026

  • Rename "Knowledge indicator extraction" to "Knowledge Indicator feature extraction"
  • Rename "Rule generation" to "Knowledge Indicator Query generation"
  • Update help text for Discovery model and KI query generation

Summary by CodeRabbit

  • Style
    • Updated UI labels and help text in settings for improved clarity:
      • Knowledge indicator extraction → Knowledge Indicator Feature extraction
      • Rule generation → Knowledge Indicator Query generation
      • Discovery → Discovery & Significant Event generation
      • Updated corresponding help descriptions

- Rename "Knowledge indicator extraction" to "Knowledge Indicator feature extraction"
- Rename "Rule generation" to "Knowledge Indicator Query generation"
- Update help text for Discovery model and KI query generation
@ruflin ruflin self-assigned this Mar 18, 2026
@ruflin ruflin added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting Feature:SigEvents Significant events feature, related to streams and rules/alerts (RnA) Team:SigEvents Project team working on Significant Events labels Mar 18, 2026
@ruflin ruflin marked this pull request as ready for review March 18, 2026 12:42
@ruflin ruflin requested review from a team as code owners March 18, 2026 12:42
@ruflin ruflin enabled auto-merge (squash) March 18, 2026 12:49
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 18, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 4d263796-7cc0-4e5d-b512-f5a800d2c239

📥 Commits

Reviewing files that changed from the base of the PR and between 33fc415 and cf4488e.

📒 Files selected for processing (1)
  • x-pack/platform/plugins/shared/streams_app/public/components/significant_events_discovery/components/settings/tab.tsx

📝 Walkthrough

Walkthrough

This PR updates UI text labels and help descriptions in the Significant Events Discovery settings component to reflect updated terminology around Knowledge Indicator features. All changes are string literal updates with no modifications to control flow or data handling.

Changes

Cohort / File(s) Summary
Settings Tab UI Text Updates
x-pack/platform/plugins/shared/streams_app/public/components/significant_events_discovery/components/settings/tab.tsx
Updated labels and help text: "Knowledge indicator extraction" → "Knowledge Indicator Feature extraction", "Rule generation" → "Knowledge Indicator Query generation", "Discovery" → "Discovery & Significant Event generation", and corresponding help text descriptions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • tonyghiani
🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating UI labels and help text in Discovery settings for terminology clarity.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@x-pack/platform/plugins/shared/streams_app/public/components/significant_events_discovery/components/settings/tab.tsx`:
- Around line 244-245: Update the i18n defaultMessage strings in the Significant
Events settings tab to use the canonical plural "Significant Events" and ensure
help text ends with terminal punctuation: replace occurrences like 'Discovery &
Significant Event generation' (in the JSX i18n entries inside tab.tsx, e.g., the
label/defaultMessage and the help/defaultMessage in the settings Tab component)
with 'Discovery & Significant Events generation' and add a period at the end of
the help text defaultMessage; search for other nearby defaultMessage instances
in this file (the entries around the current block) and apply the same
pluralization and punctuation consistently.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: ff8a0d72-d47c-4bc6-ae9e-7ede08791bc9

📥 Commits

Reviewing files that changed from the base of the PR and between 33fc415 and cf4488e.

📒 Files selected for processing (1)
  • x-pack/platform/plugins/shared/streams_app/public/components/significant_events_discovery/components/settings/tab.tsx

Comment on lines +244 to 245
{ defaultMessage: 'Discovery & Significant Event generation' }
)}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Use the canonical “Significant Events” term in these i18n strings.

Line 244 and Line 250 use singular “Significant Event”. Please use “Significant Events” consistently in user-facing text here (and add terminal punctuation for the help text).

💬 Suggested text update
               label={i18n.translate(
                 'xpack.streams.significantEventsDiscovery.settings.discoveryLabel',
-                { defaultMessage: 'Discovery & Significant Event generation' }
+                { defaultMessage: 'Discovery & Significant Events generation' }
               )}
               helpText={i18n.translate(
                 'xpack.streams.significantEventsDiscovery.settings.discoveryHelp',
                 {
                   defaultMessage:
-                    'Model used during Discovery phase and Significant Event generation',
+                    'Model used during Discovery phase and Significant Events generation.',
                 }
               )}

Based on learnings: In Streams app user-facing i18n defaultMessage strings, the term must be written as “Significant Events” (title case).

Also applies to: 249-250

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@x-pack/platform/plugins/shared/streams_app/public/components/significant_events_discovery/components/settings/tab.tsx`
around lines 244 - 245, Update the i18n defaultMessage strings in the
Significant Events settings tab to use the canonical plural "Significant Events"
and ensure help text ends with terminal punctuation: replace occurrences like
'Discovery & Significant Event generation' (in the JSX i18n entries inside
tab.tsx, e.g., the label/defaultMessage and the help/defaultMessage in the
settings Tab component) with 'Discovery & Significant Events generation' and add
a period at the end of the help text defaultMessage; search for other nearby
defaultMessage instances in this file (the entries around the current block) and
apply the same pluralization and punctuation consistently.

@ruflin ruflin merged commit 976ac44 into elastic:main Mar 18, 2026
15 checks passed
@elasticmachine
Copy link
Copy Markdown
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] Scout: [ platform / workflows_management ] plugin / local-serverless-security_complete - Workflow execution - Alert triggers - should trigger workflow from alert
  • [job] [logs] Scout: [ platform / dashboard-stateful-classic ] plugin / local-stateful-classic - dashboard REST schema - Registered embeddable schemas have not changed

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
streamsApp 1.8MB 1.8MB +121.0B

cc @ruflin

@ruflin ruflin deleted the docs/streams-discovery-settings-labels branch March 18, 2026 14:49
mbondyra added a commit to mbondyra/kibana that referenced this pull request Mar 18, 2026
…d_agent_navigation2

* commit 'b511b784a89644463497411bc8cfac03522d43a9': (40 commits)
  skip failing test suite (elastic#252959)
  skip failing test suite (elastic#255548)
  skip failing test suite (elastic#256140)
  skip failing test suite (elastic#257103)
  skip failing test suite (elastic#258148)
  [SharedUX] Add solution view switch callout to spaces plugin (elastic#258093)
  skip tests consistently failing on ECH (elastic#258157)
  [EDR Workflows][Osquery] Disable tags for scheduled queries (elastic#258222)
  [Security solution][Attacks] Add navigation E2E test  (elastic#255373)
  [canvas] fix unable to load embeddable when no references are provided (elastic#257779)
  docs(streams): update Discovery settings labels and help text (elastic#258328)
  [ResponseOps] Fixes x-pack/platform/test/alerting_api_integration/spaces_only/tests/alerting/group4/alert_severity.ts flaky test (elastic#258226)
  [Lens as Code] Fix legend truncation issues (elastic#258216)
  Upgraded flatted (elastic#258252)
  [One Discover][Logs UX] Update OpenTelemetry Semantic Conventions (elastic#256613)
  add Agent Builder compatibility to connectors (elastic#257491)
  [Obs AI] Add o11y data-generators (OpenRCA and RCAEval) for producing logs, metrics, traces (elastic#256591)
  [One Workflow] Update execution history UI: show nested workflows steps (elastic#257352)
  [One Workflow] bulkUpdateSchedules should be called with request to follow auth (elastic#258150)
  [Agent Builder] Semantic Meta Layer (elastic#254849)
  ...
qn895 pushed a commit to qn895/kibana that referenced this pull request Mar 18, 2026
…c#258328)

- Rename "Knowledge indicator extraction" to "Knowledge Indicator
feature extraction"
- Rename "Rule generation" to "Knowledge Indicator Query generation"
- Update help text for Discovery model and KI query generation
jeramysoucy pushed a commit to jeramysoucy/kibana that referenced this pull request Mar 26, 2026
…c#258328)

- Rename "Knowledge indicator extraction" to "Knowledge Indicator
feature extraction"
- Rename "Rule generation" to "Knowledge Indicator Query generation"
- Update help text for Discovery model and KI query generation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip This PR does not require backporting Feature:SigEvents Significant events feature, related to streams and rules/alerts (RnA) release_note:skip Skip the PR/issue when compiling release notes Team:SigEvents Project team working on Significant Events v9.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants