docs: fix ECH quickstart architecture note and rebrand miss in apm/otel index - #7920
Draft
alexandra5000 wants to merge 1 commit into
Draft
docs: fix ECH quickstart architecture note and rebrand miss in apm/otel index#7920alexandra5000 wants to merge 1 commit into
alexandra5000 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. |
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 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
elasticsearchexporter writing directly to Elasticsearch. This contradicts the architecture docs (ECH → Managed OTLP Endpoint) and the modes reference ("the only case where theelasticsearchexporter is recommended" = self-managed gateway).Rather than rewriting the full quickstarts, added a
noteadmonition 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