Conversation
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. |
🔍 Preview links for changed docs |
✅ Vale Linting ResultsNo 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. |
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: Vale reported no findings (files were outside the default
docs/scope path). Manual review found minor issues — "Note that" filler and "via" where the style guide prefers "through". - Jargon:
{{heartbeat}},{{agent}},{{uptime-app}},{{k8s}},{{synthetics-app}}are all substitution variables; no unexplained jargon introduced. - Frontmatter and applies_to: Frontmatter is unchanged. The new section in
scale-architect-synthetics-deployment.mdcorrectly omits a section-levelapplies_tooverride (the CCS/CCR section above it hasstack: gabecause it's stateful-only; the new k8s section applies to both stack and serverless, matching the file-level frontmatter). - Content type fit: Both additions fit their context — an
importantadmonition in the index page and a parallel "Do not use" section in the scale/architect page, consistent with the existing CCS/CCR section pattern. - Parent issue satisfaction: Closes #1879. The PR adds the requested admonition to the index and a matching section to the scale/architect doc. Satisfied.
Nits
- Both changed files use
viawhere the style guide prefersthrough(e.g., "monitoring via autodiscovery" → "monitoring through autodiscovery"). - "Note that" appears in both bullets recommending the Uptime Monitors integration — inline suggestions posted above.
Notes
- The pre-fetched Vale data shows
eligible_count: 0because the default scope isdocs-subtree(docs/), and these files live undersolutions/. Review was performed manually as this repo's docs span the full repository. - The PR body already flags the Uptime app deprecation tension: both new sections link to the Uptime app while noting it's deprecated as of 8.15. Authors should confirm with
@eedugon/@emilioalvapwhether a non-deprecated landing page exists, or whether the link should be dropped entirely from the alternatives list.
Generated by Docs review agent for issue #6367 · ● 301.4K
eedugon
left a comment
There was a problem hiding this comment.
LGTM! I've suggested some small changes to make the note shorter, plus fixed some links.
Also the elastic agent suggestion links to autodiscover doc.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…deployment.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
…deployment.md Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
…deployment.md Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
Heartbeat docs live in the beats repo, not in docs-content. Updated the heartbeat and autodiscover links to use the beats:// cross-link prefix. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
florent-leborgne
left a comment
There was a problem hiding this comment.
I strongly disagree that we should start any overview page of a major feature with a succession of big notes on what the capability is "NOT" for. Please consider the following alternatives:
-
Start the page with regular text defining what Synthetics is, is for, and does. This is healthier, better for introducing the feature and tell its user value, and it opens the path to a smaller note further down, a decision paragraph (preferred IMO), or even a specific page, about "When to use Synthetics", including alternatives for cases such as the one described in the important note there.
-
Side comment: we can turn the 1st note on the page into regular text too
I strongly agree :) |
Clarify that the Uptime app is not available in Serverless.
Clarified the deprecation status of the Uptime app in the agent integration section.
florent-leborgne
left a comment
There was a problem hiding this comment.
I think this is still too high/prominent for what it tells but it's in a better shape. We can merge this one and maybe plan a follow up to have a clearer decision making section instead of the admonition?
Summary
Add a short "Not for infrastructure or Kubernetes monitoring" note/admonition to solutions/observability/synthetics/index.md. State clearly that the Synthetics app is designed for active synthetic checks of URLs and user journeys, not for host/pod availability monitoring via autodiscovery. Link to the Heartbeat / Elastic Agent alternatives.
Add a matching section to solutions/observability/synthetics/scale-architect-synthetics-deployment.md (alongside the existing CCS/CCR "do not use" section) documenting the k8s infra monitoring limitation and recommended alternatives.
Note for reviewers
@emilioalvap @eedugon can you confirm whether the recommended alternatives to document are correct:
The Uptime app (/solutions/observability/uptime/) is deprecated as of 8.15 and should not be promoted as the primary destination. I added a note about deprecation.
Closes #1879.
Generative AI disclosure