Skip to content

Docs: make aspire otel the primary telemetry command and rename traces reference to trace#1165

Open
Copilot wants to merge 2 commits into
mainfrom
copilot/update-docs-aspire-otel
Open

Docs: make aspire otel the primary telemetry command and rename traces reference to trace#1165
Copilot wants to merge 2 commits into
mainfrom
copilot/update-docs-aspire-otel

Conversation

Copilot AI commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

The CLI docs were still inconsistent with the command rename from aspire telemetry to aspire otel, and the trace subcommand naming needed to reflect the current aspire otel trace shape. This updates command reference pages, nav, and links so docs present the new primary names while preserving alias/back-compat guidance.

  • CLI command reference alignment

    • Renamed the trace command reference page route from aspire-otel-traces to aspire-otel-trace.
    • Updated command tables/see-also links and command text to use aspire otel trace.
    • Clarified wording to reference the Dashboard OpenTelemetry API on otel command pages.
  • Backward-compatibility handling

    • Added a dedicated aspire telemetry alias page that points readers to aspire otel.
    • Added an explicit alias note on the primary aspire otel page (aspire telemetry remains supported as a backward-compatible alias).
  • Navigation and cross-doc link updates

    • Updated sidebar CLI entries to aspire otel trace and the new slug.
    • Updated prose/examples across related docs (search/filter, dashboard, telemetry, what’s new) to point to aspire otel trace.
    • Added redirect from /reference/cli/commands/aspire-otel-traces/ to /reference/cli/commands/aspire-otel-trace/.
:::note
`aspire telemetry` is a backward-compatible alias for `aspire otel`.
:::

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation for aspire otel command Docs: make aspire otel the primary telemetry command and rename traces reference to trace Jun 2, 2026
Copilot AI requested a review from IEvangelist June 2, 2026 02:58
@IEvangelist IEvangelist marked this pull request as ready for review June 30, 2026 08:38
@IEvangelist IEvangelist requested a review from mitchdenny as a code owner June 30, 2026 08:38
Copilot AI review requested due to automatic review settings June 30, 2026 08:38
@IEvangelist IEvangelist requested a review from JamesNK as a code owner June 30, 2026 08:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the aspire.dev documentation to make aspire otel the primary telemetry command, rename the trace command references to match aspire otel trace, and preserve backward compatibility guidance (including redirects and an alias page).

Changes:

  • Renames docs references from aspire otel tracesaspire otel trace and updates command reference links accordingly.
  • Adds an aspire telemetry alias reference page and updates aspire otel docs to note the alias.
  • Updates sidebar navigation and adds a redirect from the old aspire-otel-traces route to the new aspire-otel-trace route.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/frontend/src/content/docs/whats-new/aspire-13-4.mdx Updates release-note examples to use aspire otel trace.
src/frontend/src/content/docs/whats-new/aspire-13-3.mdx Updates standalone-dashboard examples and text to use aspire otel trace.
src/frontend/src/content/docs/reference/cli/search-filter.mdx Updates search/filter docs to link to and show aspire otel trace.
src/frontend/src/content/docs/reference/cli/commands/aspire-telemetry.mdx Adds a dedicated alias/reference page pointing to aspire otel.
src/frontend/src/content/docs/reference/cli/commands/aspire-otel.mdx Makes aspire telemetry alias guidance explicit and updates trace links.
src/frontend/src/content/docs/reference/cli/commands/aspire-otel-trace.mdx Updates command reference content to the aspire otel trace naming.
src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx Updates API naming text and “see also” links to the new trace page.
src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx Updates API naming text and “see also” links to the new trace page.
src/frontend/src/content/docs/ja/whats-new/aspire-13-3.mdx Updates Japanese release-note examples and text to use aspire otel trace.
src/frontend/src/content/docs/fundamentals/telemetry.mdx Updates telemetry overview references to use aspire otel trace.
src/frontend/src/content/docs/dashboard/standalone.mdx Updates standalone dashboard doc examples/links to aspire otel trace.
src/frontend/src/content/docs/dashboard/apis.mdx Updates dashboard API page command table link to aspire otel trace.
src/frontend/src/content/docs/dashboard/ai-coding-agents.mdx Updates AI agent workflow text/examples to use aspire otel trace.
src/frontend/config/sidebar/reference.topics.ts Updates sidebar nav entry label/slug to aspire otel trace.
src/frontend/config/redirects.mjs Adds redirect from /aspire-otel-traces/ to /aspire-otel-trace/.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@@ -0,0 +1,19 @@
---
title: aspire telemetry command
description: Learn about the aspire telemetry command alias and use aspire otel as the primary command name.
Comment on lines +27 to +29
:::note
`aspire telemetry` is a backward-compatible alias for `aspire otel`.
:::
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.

CLI: Update docs for 'aspire telemetry' renamed to 'aspire otel'

3 participants