Skip to content

[CPS] Core CPS in ML AD content - #7814

Open
shainaraskas wants to merge 7 commits into
mainfrom
ml-ad-cps-feature-docs
Open

[CPS] Core CPS in ML AD content#7814
shainaraskas wants to merge 7 commits into
mainfrom
ml-ad-cps-feature-docs

Conversation

@shainaraskas

@shainaraskas shainaraskas commented Aug 5, 2026

Copy link
Copy Markdown
Member

Summary

Adds core CPS (cross-project search) content to the ML anomaly detection docs and updates related CPS pages to reference ML support.

Changes

  • ml-ad-run-jobs.md: New ## CPS scope section covering setting project scope at creation (UI vs API defaults, clone behavior), changing scope on existing jobs (Kibana/API tabs with procedures), model instability on scope change, legacy job updates, and how to check project scope.
  • cps-limitations-core.md: Updates the ML limitation to clarify that legacy jobs default to origin-only and must be manually updated.
  • cross-project-search-manage-scope.md: Adds ML Anomaly Detection row to the CPS availability table
  • cross-project-search-project-routing.md: Adds note that ML and transforms use project_routing as stored configuration rather than a per-query parameter

Preview links

Related

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 2 suggestions found

💡 Suggestions (2): Optional style improvements. Apply when helpful.
File Line Rule Message
explore-analyze/machine-learning/anomaly-detection/ml-ad-run-jobs.md 176 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
explore-analyze/machine-learning/anomaly-detection/ml-ad-run-jobs.md 178 Elastic.Clone Use cloning only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'.

The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

@shainaraskas
shainaraskas requested a review from valeriy42 August 5, 2026 21:29

@github-actions github-actions Bot left a comment

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.

Docs review summary

Focus areas

  • Style and clarity: Mostly solid; new CPS content is clear and well-structured. Flagged an unresolved authoring TODO comment and an undefined term ("flat-world").
  • Jargon: One instance of unexplained internal shorthand ("flat-world") used twice without definition.
  • Frontmatter and applies_to: No frontmatter issues in changed files; the new applies_to block on the CPS scope section follows the correct pattern (block directive right after the H2).
  • Content type fit: Good fit for the how-to/reference style of the surrounding page; the new heading structure in cross-project-search-project-routing.md skips a level (H1 → H3).
  • Parent issue satisfaction: Not applicable — no linked GitHub issue in this repo to check against (the PR references an internal tracking issue and a blocking Kibana PR, both outside this review's scope).

Nits

  • Line 34: Vale suggests replacing "simple" per word-choice guidance.
  • Line 48: Vale suggests "consider" instead of "take into account."
  • Line 77: Vale suggests "efficiently" instead of "easily."
  • Line 80: Vale suggests "often" instead of "In many cases."
  • Line 113: Vale suggests "select, press, visits" instead of "hit."
  • Lines 119, 176: Vale suggests "can, might" instead of "may."
  • Line 178: Vale flags "cloning" — this instance describes cloning a job in Kibana (a copy linked to the original), which matches the term's intended usage, so likely a false positive; leave as is.

Notes

  • The <!--TO BE CONFIRMED ^^^ --> and % TODO: inline comments in ml-ad-run-jobs.md suggest parts of this content (clone default-scope behavior, troubleshooting cross-links) are still pending confirmation or blocked on other PRs (#7403, kibana#251270). Worth confirming these are intentionally left in before merge, or tracked to be resolved.
  • Did not flag the % TODO: comments referencing PR #7403 separately since they're clearly intentional placeholders for a known blocked cross-reference.

Generated by Docs review agent for #7814 · sonnet50 · 93.8 AIC · ⌖ 6.6 AIC · ⊞ 15.9K

Comment thread explore-analyze/cross-project-search/cross-project-search-project-routing.md Outdated
@shainaraskas shainaraskas mentioned this pull request Aug 6, 2026
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant