Skip to content

Publish specs at specs.opentelemetry.io, an exploratory proposal #5049

Description

@chalin

This issue is an exploratory proposal to publish the main OTel and semantic convention specs from a dedicated specs site, such as https://specs.opentelemetry.io.

Why:

  • Simplify and speed up the main opentelemetry.io build
  • Make it clearer that specs are not currently an i18n target of the main site.
  • Let spec maintainers publish without depending on the main site build; they would only need to ensure that the specs site builds correctly.
  • Support cleaner, more self-contained Markdown for agent-friendly docs.
  • Give OTel specs and semantic conventions focused navigation while keeping a unified OTel look.

Initial idea:

  • Keep existing opentelemetry.io/docs/specs/ pages as redirects or link-outs.
  • Publish OTel and semantic convention specs from simpler Hugo + Docsy builds.
  • Use top-level paths such as specs.opentelemetry.io/otel/ and specs.opentelemetry.io/semconv/ for differentiation. An alternative is separate subdomains, but that may be overkill and could complicate UX.

Open questions:

  • Ownership and publishing responsibilities. Initially, the Comms SIG could be custodians.
  • Exact URL structure.
  • Unified styling and navigation expectations.
  • Impact on Ask AI / docs AI features.

Suggested next steps:

  • Gather feedback from spec maintainers and other stakeholders.
  • Once there is general consensus, build a small proof of concept to validate the approach before fully committing.

/cc @open-telemetry/docs-maintainers @open-telemetry/specs-semconv-maintainers

Related:

Metadata

Metadata

Assignees

No one assigned

    Labels

    triage:accepted:readyReady to be implemented. Small enough or uncontroversial enough to be implemented without sponsor

    Type

    No type

    Projects

    Status
    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions