Skip to content

Propose IA changes to nav-v2#3024

Draft
alexandra5000 wants to merge 4 commits intoelastic:nav-v2from
alexandra5000:aleksandra/nav-v2-proposals
Draft

Propose IA changes to nav-v2#3024
alexandra5000 wants to merge 4 commits intoelastic:nav-v2from
alexandra5000:aleksandra/nav-v2-proposals

Conversation

@alexandra5000
Copy link
Copy Markdown
Contributor

@alexandra5000 alexandra5000 commented Apr 2, 2026

To be continued...

Summary

Proposes restructuring the EDOT section in navigation-v2.yml by extracting the individual SDK tocs into a dedicated sibling group.

Before: All EDOT SDK content (Android, .NET, iOS, Java, Node.js, PHP, Python, Browser) is nested inside the Elastic Distributions of OpenTelemetry (EDOT) group, making it hard to navigate and giving EDOT a very long, flat list.

After: A new EDOT SDKs group sits at the same level as Fleet, APM, Beats, etc., with the edot-sdks/index.md page as its root and each SDK as a direct child.

Ingest tools
├── Elastic Distributions of OpenTelemetry (EDOT)  ← core EDOT content only
├── EDOT SDKs                                       ← new group
│   ├── EDOT Android
│   ├── EDOT .NET
│   ├── EDOT iOS
│   ├── EDOT Java
│   ├── EDOT Node.js
│   ├── EDOT PHP
│   ├── EDOT Python
│   └── EDOT Browser
├── Fleet and Elastic Agent
├── ...

Rationale

The SDKs are a distinct product surface from the EDOT observability tooling (Collector, Cloud Forwarder, etc.) — grouping them separately makes each easier to discover, especially for developers who come in looking for a specific language SDK.

Note

This is a proposal on top of #2927 — open to discussion on naming, ordering, and whether the EDOT core group should also have its own index page trimmed.

🤖 Generated with Claude Code

Move the individual EDOT SDK tocs (Android, .NET, iOS, Java, Node.js,
PHP, Python, Browser) out from under the EDOT group and into a
dedicated "EDOT SDKs" sibling group at the same level as Fleet,
APM, Beats, etc. The group links to the existing edot-sdks index page.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@alexandra5000 alexandra5000 requested review from a team as code owners April 2, 2026 12:12
@alexandra5000 alexandra5000 requested a review from reakaleek April 2, 2026 12:12
@alexandra5000 alexandra5000 marked this pull request as draft April 2, 2026 12:14
@alexandra5000 alexandra5000 changed the title Propose: extract EDOT SDKs as a top-level ingest tool group Propose IA changes to nav-v2 Apr 2, 2026
Add TocOverrideNode wrapper in SiteNavigationV2 so that when a toc:
entry in navigation-v2.yml declares explicit children, those are used
instead of the full V1 node tree — without mutating the shared node.

Update navigation-v2.yml to limit opentelemetry://reference children
to motlp, edot-cloud-forwarder, and edot-collector, keeping individual
EDOT SDKs only in the new sibling EDOT SDKs group.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
alexandra5000 and others added 2 commits April 2, 2026 19:01
The edot-sdks deduplication is now handled upstream in elastic/opentelemetry
by removing edot-sdks/index.md from the reference toc. No children override
needed here — toc: opentelemetry://reference renders cleanly without the SDKs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Group the individual SDK tocs under opentelemetry://reference/edot-sdks
in navigation.yml with path_prefix reference/opentelemetry/edot-sdks,
so nav-v2 can reference it as a toc: entry with a correct URL.

Update navigation-v2.yml to use toc: opentelemetry://reference/edot-sdks
instead of group: + page:, which was producing a 404 due to naive URI
path resolution ignoring the path_prefix.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant