[CPS] Refactor "Feature impacts" section for ga improvements - #8282
Open
shainaraskas wants to merge 1 commit into
Open
[CPS] Refactor "Feature impacts" section for ga improvements#8282shainaraskas wants to merge 1 commit into
shainaraskas wants to merge 1 commit into
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
🔍 Preview links for changed docs |
Contributor
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! 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. |
Contributor
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: Rewritten section reads well overall — active voice, concise sentences, no Vale findings on modified lines.
- Jargon: No unexplained Elastic-internal jargon introduced;
{{kib}},{{cps-init}}etc. are used as defined product substitutions. - Frontmatter and applies_to: No frontmatter changes in this diff; not applicable.
- Content type fit: The page remains a how-to/reference hybrid consistent with its existing structure; the new warning admonition and bullet restructuring fit the existing content type.
- Contradictions: No contradictions found against published docs (
explore-analyze/cross-project-search-configoverview andexplore-analyze/cross-project-search.mdremain consistent with the new "Feature impacts" wording). - Parent issue satisfaction: Not applicable — no linked issue found in the PR description or closing keywords.
Notes
- One broken link anchor flagged inline in
deploy-manage/cross-project-search-config.md— the new "Query syntax" bullet links to#cps-cap-as-the-default-behavior-for-linked-projects, which doesn't match the actual generated anchor for that heading. - The painless-scripting move to
deploy-manage/_snippets/cps-limitations-core.mdpreserves the cross-reference to#cps-painless-scriptinginexplore-analyze/cross-project-search.md, so no content was lost in the relocation.
Generated by Docs review agent for #8282 · copilot · sonnet50 · 175.6 AIC · ⌖ 21.1 AIC · ⊞ 16.4K
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
fixes https://github.com/elastic/docs-content-internal/issues/1774
The original feature impacts section had four bullet points written when CPS was simpler. Since then, the landscape has grown beyond just dashboards, alerts, and visualizations, so the bullets were either redundant with better content elsewhere or incomplete for the current feature set.
Rather than expanding the bullets to cover every app, I slimmed the section to the two things that actually matter at this level (expanded dataset and user permissions) and cross-referenced the detailed pages. Painless scripting moved to the limitations snippet where it belongs.
The rules warning was added explicitly here because it's the one case that can trigger real-world actions on unexpected data.
Generative AI disclosure