Skip to content

Commit eeadfd9

Browse files
CopilotIEvangelist
andauthored
Add <abbr> tooltip tags to first occurrence of abbreviations in docs (#695)
* Add <abbr> tags to wrap abbreviations in docs (OTEL, OTLP, MCP, BFF, DAG) Agent-Logs-Url: https://github.com/microsoft/aspire.dev/sessions/98918102-f96a-4c97-9946-3b20dd355e27 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Address review: fix OLTP→OTLP typo, remove redundant abbr in bold, fix plural Protocols Agent-Logs-Url: https://github.com/microsoft/aspire.dev/sessions/98918102-f96a-4c97-9946-3b20dd355e27 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Wrap only the first occurrence of each abbreviation per article Agent-Logs-Url: https://github.com/microsoft/aspire.dev/sessions/08d2a005-6c2b-480c-97de-dc9d92e61bf3 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
1 parent 945ed5e commit eeadfd9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+51
-51
lines changed

src/frontend/src/content/docs/app-host/certificate-configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Aspire provides two complementary sets of certificate APIs:
1010
1. **HTTPS endpoint APIs**: Configure the certificates that resources use for their own HTTPS endpoints (server authentication)
1111
2. **Certificate trust APIs**: Configure which certificates resources trust when making outbound HTTPS connections (client authentication)
1212

13-
Both sets of APIs work together to enable secure HTTPS communication during local development. For example, a Vite frontend might use `WithHttpsDeveloperCertificate` to serve HTTPS traffic, while also using `WithDeveloperCertificateTrust` to trust the dashboard's OTLP endpoint certificate.
13+
Both sets of APIs work together to enable secure HTTPS communication during local development. For example, a Vite frontend might use `WithHttpsDeveloperCertificate` to serve HTTPS traffic, while also using `WithDeveloperCertificateTrust` to trust the dashboard's <abbr title="OpenTelemetry Protocol" data-tooltip-placement="top">OTLP</abbr> endpoint certificate.
1414

1515
<Aside type="caution">
1616
Certificate customization only applies at run time. Custom certificates aren't
@@ -371,7 +371,7 @@ Aspire supports the following certificate trust scopes:
371371

372372
Attempts to append the configured certificates to the default trusted certificates for a given resource. This mode is useful when you want to add trust for additional certificates while maintaining trust for the system's default certificates.
373373

374-
This is the default scope for most resources. For Python resources, only OTEL trust configuration will be applied in this mode.
374+
This is the default scope for most resources. For Python resources, only <abbr title="OpenTelemetry" data-tooltip-placement="top">OTEL</abbr> trust configuration will be applied in this mode.
375375

376376
<Tabs syncKey='aspire-lang'>
377377
<TabItem id='csharp' label='C#'>

src/frontend/src/content/docs/app-host/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,10 @@ By default, the dashboard is automatically started by the AppHost. The dashboard
116116
| ------------------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
117117
| `ASPNETCORE_URLS` | `null` | Dashboard address. Must be `https` unless `ASPIRE_ALLOW_UNSECURED_TRANSPORT` or `DistributedApplicationOptions.AllowUnsecuredTransport` is true. Automatically generated with _launchSettings.json_ to have a random port on localhost. The value in launch settings is set on the `applicationUrls` property. |
118118
| `ASPNETCORE_ENVIRONMENT` | `Production` | Configures the environment the dashboard runs as. For more information, see [Use multiple environments in ASP.NET Core](https://learn.microsoft.com/aspnet/core/fundamentals/environments). |
119-
| `ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL` | `http://localhost:18889` if no gRPC endpoint is configured. | Configures the dashboard OTLP gRPC address. Used by the dashboard to receive telemetry over OTLP. Set on resources as the `OTEL_EXPORTER_OTLP_ENDPOINT` env var. The `OTEL_EXPORTER_OTLP_PROTOCOL` env var is `grpc`. Automatically generated with _launchSettings.json_ to have a random port on localhost. |
119+
| `ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL` | `http://localhost:18889` if no gRPC endpoint is configured. | Configures the dashboard <abbr title="OpenTelemetry Protocol" data-tooltip-placement="top">OTLP</abbr> gRPC address. Used by the dashboard to receive telemetry over OTLP. Set on resources as the `OTEL_EXPORTER_OTLP_ENDPOINT` env var. The `OTEL_EXPORTER_OTLP_PROTOCOL` env var is `grpc`. Automatically generated with _launchSettings.json_ to have a random port on localhost. |
120120
| `ASPIRE_DASHBOARD_OTLP_HTTP_ENDPOINT_URL` | `null` | Configures the dashboard OTLP HTTP address. Used by the dashboard to receive telemetry over OTLP. If only `ASPIRE_DASHBOARD_OTLP_HTTP_ENDPOINT_URL` is configured then it is set on resources as the `OTEL_EXPORTER_OTLP_ENDPOINT` env var. The `OTEL_EXPORTER_OTLP_PROTOCOL` env var is `http/protobuf`. |
121121
| `ASPIRE_DASHBOARD_CORS_ALLOWED_ORIGINS` | `null` | Overrides the CORS allowed origins configured in the dashboard. This setting replaces the default behavior of calculating allowed origins based on resource endpoints. |
122-
| `ASPIRE_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS`| `false` | Configures the dashboard to not use authentication and accept anonymous access. Sets frontend, OTLP, MCP, and API auth modes to `Unsecured`. |
122+
| `ASPIRE_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS`| `false` | Configures the dashboard to not use authentication and accept anonymous access. Sets frontend, OTLP, <abbr title="Model Context Protocol" data-tooltip-placement="top">MCP</abbr>, and API auth modes to `Unsecured`. |
123123
| `ASPIRE_DASHBOARD_FRONTEND_BROWSERTOKEN` | Automatically generated 128-bit entropy token. | Configures the frontend browser token. This is the value that must be entered to access the dashboard when the auth mode is BrowserToken. If no browser token is specified then a new token is generated each time the AppHost is launched. |
124124
| `ASPIRE_DASHBOARD_TELEMETRY_OPTOUT` | `false` | Configures the dashboard to never send [usage telemetry](/dashboard/microsoft-collected-dashboard-telemetry/). |
125125
| `ASPIRE_DASHBOARD_AI_DISABLED` | `false` | [GitHub Copilot in the dashboard](/dashboard/copilot/) is available when the AppHost is launched by a supported IDE. When set to `true` Copilot is disabled in the dashboard and no Copilot UI is visible. |

src/frontend/src/content/docs/architecture/resource-hierarchies.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The following scenarios illustrate how Aspire models parent-child relationships:
6565

6666
In Aspire, configuration, connectivity details, and dependencies between distributed resources are modeled using **structured values**. These values capture relationships explicitly—not just as simple strings—making the application graph **portable, inspectable, and evolvable**.
6767

68-
Aspire represents these relationships through a **heterogeneous Directed Acyclic Graph (DAG)**. This graph tracks not only dependency ordering but also how **structured values** are passed between resources at multiple abstraction levels: configuration, connection, and runtime behavior.
68+
Aspire represents these relationships through a **heterogeneous Directed Acyclic Graph (<abbr title="Directed Acyclic Graph" data-tooltip-placement="top">DAG</abbr>)**. This graph tracks not only dependency ordering but also how **structured values** are passed between resources at multiple abstraction levels: configuration, connection, and runtime behavior.
6969

7070
```csharp title="C# — AppHost.cs"
7171
var builder = DistributedApplication.CreateBuilder(args);

src/frontend/src/content/docs/architecture/resource-model.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import LearnMore from '@components/LearnMore.astro';
88

99
Aspire's AppHost represents a collection of resources, known as the "resource model". This model allows developers to define and manage the various components and services that make up their applications, providing a unified way to interact with these resources throughout the development lifecycle.
1010

11-
The resource model is a **directed acyclic graph (DAG)**, where resources are nodes and dependencies are edges. This structure allows Aspire to manage complex relationships between resources, ensuring that they can be started, stopped, and monitored in a predictable manner.
11+
The resource model is a **directed acyclic graph (<abbr title="Directed Acyclic Graph" data-tooltip-placement="top">DAG</abbr>)**, where resources are nodes and dependencies are edges. This structure allows Aspire to manage complex relationships between resources, ensuring that they can be started, stopped, and monitored in a predictable manner.
1212

1313
## Basic example
1414

src/frontend/src/content/docs/dashboard/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { Aside } from '@astrojs/starlight/components';
77
import OsAwareTabs from '@components/OsAwareTabs.astro';
88
import LearnMore from '@components/LearnMore.astro';
99

10-
The dashboard is configured when it starts up. Configuration includes frontend and OpenTelemetry Protocol (OTLP) addresses, the resource service endpoint, authentication, telemetry limits, and more.
10+
The dashboard is configured when it starts up. Configuration includes frontend and OpenTelemetry Protocol (<abbr title="OpenTelemetry Protocol" data-tooltip-placement="top">OTLP</abbr>) addresses, the resource service endpoint, authentication, telemetry limits, and more.
1111

1212
<Aside type="caution">
1313
The dashboard displays information about resources, including their configuration, console logs and in-depth telemetry.
@@ -106,7 +106,7 @@ Alternatively, these same values could be configured using a JSON configuration
106106
| `ASPNETCORE_URLS`<br/>Default: `http://localhost:18888` | One or more HTTP endpoints through which the dashboard frontend is served. The frontend endpoint is used to view the dashboard in a browser. When the dashboard is launched by the Aspire AppHost this address is secured with HTTPS. Securing the dashboard with HTTPS is recommended. |
107107
| `ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL`<br/>Default: `http://localhost:18889` | The [OTLP/gRPC](https://opentelemetry.io/docs/specs/otlp/#otlpgrpc) endpoint. This endpoint hosts an OTLP service and receives telemetry using gRPC. When the dashboard is launched by the Aspire AppHost this address is secured with HTTPS. Securing the dashboard with HTTPS is recommended. |
108108
| `ASPIRE_DASHBOARD_OTLP_HTTP_ENDPOINT_URL`<br/>Default: `http://localhost:18890` | The [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) endpoint. This endpoint hosts an OTLP service and receives telemetry using Protobuf over HTTP. When the dashboard is launched by the Aspire AppHost the OTLP/HTTP endpoint isn't configured by default. To configure an OTLP/HTTP endpoint with the AppHost, set an `ASPIRE_DASHBOARD_OTLP_HTTP_ENDPOINT_URL` env var value in _launchSettings.json_. Securing the dashboard with HTTPS is recommended. |
109-
| `ASPIRE_DASHBOARD_MCP_ENDPOINT_URL`<br/>Default: `http://localhost:18891` | The [Aspire MCP](/dashboard/mcp-server/) endpoint. When this value isn't specified then the MCP server is hosted with an `ASPNETCORE_URLS` endpoint. The MCP server can be disabled by configuring `Dashboard:Mcp:Disabled` to `true`. When the dashboard is launched by the Aspire AppHost this address is secured with HTTPS. Securing the dashboard with HTTPS is recommended. |
109+
| `ASPIRE_DASHBOARD_MCP_ENDPOINT_URL`<br/>Default: `http://localhost:18891` | The [Aspire MCP](/dashboard/mcp-server/) endpoint. When this value isn't specified then the <abbr title="Model Context Protocol" data-tooltip-placement="top">MCP</abbr> server is hosted with an `ASPNETCORE_URLS` endpoint. The MCP server can be disabled by configuring `Dashboard:Mcp:Disabled` to `true`. When the dashboard is launched by the Aspire AppHost this address is secured with HTTPS. Securing the dashboard with HTTPS is recommended. |
110110
| `ASPIRE_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS`<br/>Default: `false` | Configures the dashboard to not use authentication and accepts anonymous access. This setting is a shortcut to configuring `Dashboard:Frontend:AuthMode`, `Dashboard:Otlp:AuthMode`, `Dashboard:Mcp:AuthMode` and `Dashboard:Api:AuthMode` to `Unsecured`. |
111111
| `ASPIRE_DASHBOARD_CONFIG_FILE_PATH`<br/>Default: `null` | The path for a JSON configuration file. If the dashboard is being run in a Docker container, then this is the path to the configuration file in a mounted volume. This value is optional. |
112112
| `ASPIRE_DASHBOARD_FILE_CONFIG_DIRECTORY`<br/>Default: `null` | The directory where the dashboard looks for key-per-file configuration. This value is optional. |

src/frontend/src/content/docs/dashboard/copilot.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import structuredLogsExplainError from '@assets/dashboard/copilot/structuredlogs
1212
import traceDetailsExplainTrace from '@assets/dashboard/copilot/tracedetails-explaintrace.png';
1313

1414
<Aside type="tip" title="New in Aspire 13.1">
15-
Starting with Aspire 13.1, you can configure the MCP server automatically using the `aspire agent init` command. See [AI coding agents](/get-started/ai-coding-agents/) for the recommended approach.
15+
Starting with Aspire 13.1, you can configure the <abbr title="Model Context Protocol" data-tooltip-placement="top">MCP</abbr> server automatically using the `aspire agent init` command. See [AI coding agents](/get-started/ai-coding-agents/) for the recommended approach.
1616
</Aside>
1717

1818
Introducing GitHub Copilot in the Aspire dashboard! GitHub Copilot is your new AI debugging assistant.

src/frontend/src/content/docs/dashboard/enable-browser-telemetry.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ This article discusses how to enable browser telemetry in the Aspire dashboard.
1515

1616
Browser telemetry requires the dashboard to enable these features:
1717

18-
- OTLP HTTP endpoint. This endpoint is used by the dashboard to receive telemetry from browser apps.
18+
- <abbr title="OpenTelemetry Protocol" data-tooltip-placement="top">OTLP</abbr> HTTP endpoint. This endpoint is used by the dashboard to receive telemetry from browser apps.
1919
- Cross-origin resource sharing (CORS). CORS allows browser apps to make requests to the dashboard.
2020

2121
### OTLP configuration
2222

23-
The Aspire dashboard receives telemetry through OTLP endpoints. [HTTP OTLP endpoints](https://opentelemetry.io/docs/specs/otlp/#otlphttp) and gRPC OTLP endpoints are supported by the dashboard. Browser apps must use HTTP OLTP to send telemetry to the dashboard because browser apps don't support gRPC.
23+
The Aspire dashboard receives telemetry through OTLP endpoints. [HTTP OTLP endpoints](https://opentelemetry.io/docs/specs/otlp/#otlphttp) and gRPC OTLP endpoints are supported by the dashboard. Browser apps must use HTTP OTLP to send telemetry to the dashboard because browser apps don't support gRPC.
2424

2525
To configure the gPRC or HTTP endpoints, specify the following environment variables:
2626

@@ -304,7 +304,7 @@ The preceding JavaScript code defines an `initializeTelemetry` function that exp
304304
The bundling and minification of the JavaScript code is beyond the scope of this article.
305305
</Aside>
306306

307-
For the complete working example of how to configure the JavaScript OTEL SDK to send telemetry to the dashboard, see the [browser telemetry sample](https://github.com/microsoft/aspire/tree/main/playground/BrowserTelemetry).
307+
For the complete working example of how to configure the JavaScript <abbr title="OpenTelemetry" data-tooltip-placement="top">OTEL</abbr> SDK to send telemetry to the dashboard, see the [browser telemetry sample](https://github.com/microsoft/aspire/tree/main/playground/BrowserTelemetry).
308308

309309
## See also
310310

src/frontend/src/content/docs/dashboard/explore.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -547,7 +547,7 @@ Select the resources and data types you want to export, then select **Export sel
547547

548548
- **Resources**: JSON files with resource details.
549549
- **Console logs**: Text files with console output.
550-
- **Structured logs**: OTLP JSON files with structured log entries.
550+
- **Structured logs**: <abbr title="OpenTelemetry Protocol" data-tooltip-placement="top">OTLP</abbr> JSON files with structured log entries.
551551
- **Traces**: OTLP JSON files with distributed trace spans.
552552
- **Metrics**: OTLP JSON files with metric data points.
553553

src/frontend/src/content/docs/dashboard/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ import mcpDialogImage from '@assets/dashboard/mcp-server/mcp-dialog.png';
4444

4545
## Built on OpenTelemetry
4646

47-
The Aspire Dashboard is your command center during development. Powered by [OpenTelemetry](https://opentelemetry.io/) — the industry-standard observability framework — it automatically collects traces, metrics, and structured logs from every resource in your AppHost using OTLP (OpenTelemetry Protocol) and surfaces them through a rich, interactive UI. No vendor lock-in, no proprietary agents — just open standards.
47+
The Aspire Dashboard is your command center during development. Powered by [OpenTelemetry](https://opentelemetry.io/) — the industry-standard observability framework — it automatically collects traces, metrics, and structured logs from every resource in your AppHost using <abbr title="OpenTelemetry Protocol" data-tooltip-placement="top">OTLP</abbr> (OpenTelemetry Protocol) and surfaces them through a rich, interactive UI. No vendor lock-in, no proprietary agents — just open standards.
4848

4949
<ImageShowcase
5050
title="Resources at your fingertips"

src/frontend/src/content/docs/dashboard/mcp-server.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Aside, Steps } from '@astrojs/starlight/components';
88
import mcpDialogImage from '@assets/dashboard/mcp-server/mcp-dialog.png';
99

1010
<Aside type="tip" title="New in Aspire 13.1">
11-
Starting with Aspire 13.1, you can configure the MCP server automatically using the `aspire agent init` command. See [AI coding agents](/get-started/ai-coding-agents/) for the recommended approach.
11+
Starting with Aspire 13.1, you can configure the <abbr title="Model Context Protocol" data-tooltip-placement="top">MCP</abbr> server automatically using the `aspire agent init` command. See [AI coding agents](/get-started/ai-coding-agents/) for the recommended approach.
1212
</Aside>
1313

1414
This page describes manual MCP configuration for Aspire versions 9.0 through 13.0, or for situations where you need more control over the configuration.

0 commit comments

Comments
 (0)