Skip to content

docs: retire EDOT brand across all reference docs (9.5)#640

Draft
alexandra5000 wants to merge 3 commits into
elastic:mainfrom
alexandra5000:docs/edot-rebrand
Draft

docs: retire EDOT brand across all reference docs (9.5)#640
alexandra5000 wants to merge 3 commits into
elastic:mainfrom
alexandra5000:docs/edot-rebrand

Conversation

@alexandra5000

Copy link
Copy Markdown
Contributor

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):

Old New
EDOT Collector {{agent}} → Elastic Agent
EDOT SDKs / EDOT {Language} Elastic OTel SDKs / Elastic OTel {Language}
EDOT Cloud Forwarder {{edot-cf}} → Elastic Cloud Forwarder
EDOT (generic brand) {{edot}} → Elastic OpenTelemetry

Also updates docs/docset.yml: flips edot and edot-cf sub values, adds agent sub, 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-builder and verify:

  • No "EDOT" prose in rendered output (excluding the image filename EDOT-SDKs-Collector.png)
  • {{edot}} renders as "Elastic OpenTelemetry", {{agent}} as "Elastic Agent", {{edot-cf}} as "Elastic Cloud Forwarder"

Notes

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>
@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.

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>
@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 1 warning, 5 suggestions found

⚠️ Warnings (1): Fix when the suggestion improves clarity or correctness.
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.

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>
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.

1 participant