docs: retire EDOT brand across all reference docs (9.5)#640
Draft
alexandra5000 wants to merge 3 commits into
Draft
docs: retire EDOT brand across all reference docs (9.5)#640alexandra5000 wants to merge 3 commits into
alexandra5000 wants to merge 3 commits into
Conversation
Renames all user-facing prose per the 9.5 product-naming decision:
- "EDOT Collector" → {{agent}} (Elastic Agent)
- "EDOT SDKs / EDOT {Language}" → "Elastic OTel SDKs / Elastic OTel {Language}"
- "EDOT Cloud Forwarder" → {{edot-cf}} (Elastic Cloud Forwarder)
- Generic "EDOT" brand → {{edot}} (Elastic OpenTelemetry)
Updates docset.yml: edot sub → "Elastic OpenTelemetry", edot-cf sub →
"Elastic Cloud Forwarder", adds agent sub, renames project title.
All URL slugs, machine product-IDs, cross-repo link paths, and
auto-generated blocks (% start:/% end:) are left unchanged.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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. |
The heading "Comparison with classic {{product.apm}} data streams" generates
a different anchor than the original "Comparison with classic APM data streams",
breaking an inbound link from docs-content. Add explicit anchor to preserve it.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Contributor
Elastic Docs Style Checker (Vale)Summary: 1 warning, 5 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| docs/reference/compatibility/collectors.md | 88 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'. |
💡 Suggestions (5): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| docs/reference/compatibility/limitations.md | 38 | Elastic.Negations | Consider rephrasing to avoid negative constructions like 'can't access fields that have a dot in their name without'. Try stating what something IS rather than what it is NOT. |
| docs/reference/compatibility/limitations.md | 52 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| docs/reference/compatibility/limitations.md | 52 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| docs/reference/compatibility/limitations.md | 55 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| docs/reference/compatibility/sdks.md | 38 | Elastic.Versions | Use 'or later' instead of 'or higher' when referring to versions. |
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.
4 tasks
Replaces EDOT naming with the new canonical terms: Elastic OpenTelemetry,
Elastic OTel SDKs, Elastic OTel {language}, Elastic Agent (OTel mode),
and Elastic Cloud Forwarder. Adds a note that EDOT is a legacy term
not to be used in new content.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
What does this PR do?
Renames all user-facing prose across the opentelemetry docs hub per the 9.5 product-naming decision (elastic/docs-content-internal#1242):
{{agent}}→ Elastic Agent{{edot-cf}}→ Elastic Cloud Forwarder{{edot}}→ Elastic OpenTelemetryAlso updates
docs/docset.yml: flipsedotandedot-cfsub values, addsagentsub, renames the project title.22 files changed:
compatibility/,architecture/,edot-cloud-forwarder/,managed-inputs/, and the hub pages (index.md,central-configuration.md,data-streams.md,edot-sdks/index.md).Why is it important?
This is the hub repo for all EDOT/OTel reference content. It needs to consistently reflect the new names before the 9.5 GA cutover.
How to test
Build docs locally with
docs-builderand verify:EDOT-SDKs-Collector.png){{edot}}renders as "Elastic OpenTelemetry",{{agent}}as "Elastic Agent",{{edot-cf}}as "Elastic Cloud Forwarder"Notes
elastic-agent,docs-content, anddocs-builderPRs on 9.5 GA (July 28, 2026)