[CPS] Core CPS in ML AD content - #7814
Open
shainaraskas wants to merge 7 commits into
Open
Conversation
Contributor
Elastic Docs AI PR menuCheck 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. |
Contributor
Contributor
Elastic Docs Style Checker (Vale)Summary: 2 suggestions found 💡 Suggestions (2): Optional style improvements. Apply when helpful.
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. |
…ent into ml-ad-cps-feature-docs
shainaraskas
marked this pull request as ready for review
August 5, 2026 21:37
Contributor
There was a problem hiding this comment.
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_toblock 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.mdskips 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 inml-ad-run-jobs.mdsuggest 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds core CPS (cross-project search) content to the ML anomaly detection docs and updates related CPS pages to reference ML support.
Changes
## CPS scopesection 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.Preview links
Related
Generative AI disclosure