Skip to content

docs: fix ECH quickstart architecture note and rebrand miss in apm/otel index - #7920

Draft
alexandra5000 wants to merge 1 commit into
elastic:mainfrom
alexandra5000:docs/fix-contradictions-7874
Draft

docs: fix ECH quickstart architecture note and rebrand miss in apm/otel index#7920
alexandra5000 wants to merge 1 commit into
elastic:mainfrom
alexandra5000:docs/fix-contradictions-7874

Conversation

@alexandra5000

@alexandra5000 alexandra5000 commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes two docs contradictions identified in #7874 (items 4 and 5).

Item 4 — ECH quickstart architecture mismatch (quickstart/ech/*.md):
The three ECH quickstarts (hosts/VMs, Docker, Kubernetes) instruct users to use Elastic Agent with the elasticsearch exporter writing directly to Elasticsearch. This contradicts the architecture docs (ECH → Managed OTLP Endpoint) and the modes reference ("the only case where the elasticsearch exporter is recommended" = self-managed gateway).

Rather than rewriting the full quickstarts, added a note admonition to each pointing to the Managed OTLP Endpoint as the recommended path for ECH 9.0+, with a link to the mOTLP quickstart. The existing content remains for users on earlier versions.

Item 5 — Rebrand miss in apm/opentelemetry/index.md:
The 9.5 rebrand updated the {{edot}} substitution value, but this page still contained literal strings: the H2 heading "Why use the Elastic Distributions of OpenTelemetry?" and six SDK link labels ("Elastic Distribution of OpenTelemetry Java/.NET/Node.js/Python/PHP/Browser"). Replaced all with the {{edot}} substitution.

Fixes #7874

🤖 Generated with Claude Code

@alexandra5000 alexandra5000 self-assigned this Aug 12, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

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

  • Review docs changes (docs-review). Status: not started.

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

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.

Fix contradictions and stale content found during 'Start using OTel' guide authoring

1 participant