From 5e4a3734ff9748e2e248039ec7c4ffb76d0d46a3 Mon Sep 17 00:00:00 2001 From: "aspire-repo-bot[bot]" <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Date: Tue, 10 Nov 2026 00:36:33 +0000 Subject: [PATCH 1/2] Update dashboard explore docs for simplified resources page --- src/frontend/src/content/docs/dashboard/explore.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/frontend/src/content/docs/dashboard/explore.mdx b/src/frontend/src/content/docs/dashboard/explore.mdx index a1c5cbf3c5..9dd7381316 100644 --- a/src/frontend/src/content/docs/dashboard/explore.mdx +++ b/src/frontend/src/content/docs/dashboard/explore.mdx @@ -192,13 +192,13 @@ The **Resources** page is the default home page of the Aspire dashboard. This pa The dashboard also provides essential details about each resource: -- **Type**: Displays whether the resource is a project, container, or executable. +- **Type** and **Source**: Displays whether the resource is a project, container, or executable, together with its source (for example, "Container alpine:latest" or "Project Api.csproj"). - **Name**: The name of the resource. - **State**: Displays whether or not the resource is currently running. - **Errors**: Within the **State** column, errors are displayed as a badge with the error count. It's useful to understand quickly what resources are reporting errors. Selecting the badge takes you to the [semantic logs](#structured-logs-page) for that resource with the filter at an error level. - **Start time**: When the resource started running. - **Source**: The location of the resource on the device. -- **Endpoints**: One or more URLs to reach the running resource directly. +- **URLs**: The first URL to reach the running resource directly, with a "+N" pill when the resource has more URLs. Each endpoint is listed once; its localhost address is shown in the tooltip. - **Logs**: A link to the resource logs page. - **Actions**: A [set of actions](#resource-actions) that can be performed on the resource: - **Stop / Start**: Stop (or Start) the resource—depending on the current **State**. @@ -211,6 +211,8 @@ The dashboard also provides essential details about each resource: - **Metrics**: Navigate to the resource's metrics. - **Restart**: Stop and then start the resource. +The full resource table is shown on the **Overview** tab, which is where the dashboard opens. The data tabs (**Console**, **Structured logs**, **Traces**, and **Metrics**) don't have a page-level close button that returns to the table. In the resource list, **All resources** is the first row and selects every resource. Rows for resources that have no logs or traces are muted, and the tooltip explains why. Ages are shown in a short form such as "7m ago" and are hidden when every resource shows the same one. + Consider the following screenshot of the resources page: From 2209e4736495958fcf4b9cc44f68ad1a820d3f01 Mon Sep 17 00:00:00 2001 From: Copilot <223556219+Copilot@users.noreply.github.com> Date: Mon, 16 Nov 2026 15:26:44 -0500 Subject: [PATCH 2/2] Correct dashboard resource navigation documentation Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .../src/content/docs/dashboard/explore.mdx | 66 ++++--------------- 1 file changed, 13 insertions(+), 53 deletions(-) diff --git a/src/frontend/src/content/docs/dashboard/explore.mdx b/src/frontend/src/content/docs/dashboard/explore.mdx index 9dd7381316..de9ad3d980 100644 --- a/src/frontend/src/content/docs/dashboard/explore.mdx +++ b/src/frontend/src/content/docs/dashboard/explore.mdx @@ -18,8 +18,6 @@ import aspireLoginHelp from '@assets/dashboard/explore/aspire-login-help.png'; import aspireLoginHelpLight from '@assets/dashboard/explore/aspire-login-help-light.png'; import aspireLoginFilled from '@assets/dashboard/explore/aspire-login-filled.png'; import aspireLoginFilledLight from '@assets/dashboard/explore/aspire-login-filled-light.png'; -import projects from '@assets/dashboard/explore/projects-dark.png'; -import projectsLight from '@assets/dashboard/explore/projects-light.png'; import projectGraphs from '@assets/dashboard/explore/project-graphs.png'; import projectGraphsLight from '@assets/dashboard/explore/project-graphs-light.png'; import resourceStopAction from '@assets/dashboard/explore/resource-stop-action.png'; @@ -28,16 +26,10 @@ import resourceStoppedAction from '@assets/dashboard/explore/resource-stopped-ac import resourceStoppedActionLight from '@assets/dashboard/explore/resource-stopped-action-light.png'; import resourceStartedAction from '@assets/dashboard/explore/resource-started-action.png'; import resourceStartedActionLight from '@assets/dashboard/explore/resource-started-action-light.png'; -import resourceActions from '@assets/dashboard/explore/resource-actions.png'; -import resourceActionsLight from '@assets/dashboard/explore/resource-actions-light.png'; -import resourceSubmenuActions from '@assets/dashboard/explore/resource-submenu-actions.png'; -import resourceSubmenuActionsLight from '@assets/dashboard/explore/resource-submenu-actions-light.png'; import textVisualizerSelectionMenu from '@assets/dashboard/explore/text-visualizer-selection-menu.png'; import textVisualizerSelectionMenuLight from '@assets/dashboard/explore/text-visualizer-selection-menu-light.png'; import textVisualizerResources from '@assets/dashboard/explore/text-visualizer-resources.png'; import textVisualizerResourcesLight from '@assets/dashboard/explore/text-visualizer-resources-light.png'; -import resourceDetails from '@assets/dashboard/explore/resource-details.png'; -import resourceDetailsLight from '@assets/dashboard/explore/resource-details-light.png'; import selectResourceType from '@assets/dashboard/explore/select-resource-type.png'; import selectResourceTypeLight from '@assets/dashboard/explore/select-resource-type-light.png'; import resourcesFilteredContainers from '@assets/dashboard/explore/resources-filtered-containers.png'; @@ -185,37 +177,24 @@ You can also obtain the login token from the container logs. For more informatio Management integrations such as pgAdmin, pgweb, phpMyAdmin, Kafka UI, Mongo Express, and Attu hide their management containers and expose **Manage** links on the resources they administer. These links appear ahead of other resource URLs. Built-in management endpoints, including RabbitMQ and Qdrant, also use the **Manage** label. -The **Resources** page is the default home page of the Aspire dashboard. This page lists all of the projects, containers, and executables included in your Aspire solution. For example, the starter application includes two projects: +On desktop, the Aspire dashboard opens to a full-page resource list. The list includes the projects, containers, and executables in your Aspire solution. For example, the starter application includes two projects: - **apiservice**: A backend API project built using Minimal APIs. - **webfrontend**: The frontend UI project built using Blazor. The dashboard also provides essential details about each resource: -- **Type** and **Source**: Displays whether the resource is a project, container, or executable, together with its source (for example, "Container alpine:latest" or "Project Api.csproj"). - **Name**: The name of the resource. -- **State**: Displays whether or not the resource is currently running. - - **Errors**: Within the **State** column, errors are displayed as a badge with the error count. It's useful to understand quickly what resources are reporting errors. Selecting the badge takes you to the [semantic logs](#structured-logs-page) for that resource with the filter at an error level. -- **Start time**: When the resource started running. -- **Source**: The location of the resource on the device. -- **URLs**: The first URL to reach the running resource directly, with a "+N" pill when the resource has more URLs. Each endpoint is listed once; its localhost address is shown in the tooltip. -- **Logs**: A link to the resource logs page. -- **Actions**: A [set of actions](#resource-actions) that can be performed on the resource: - - **Stop / Start**: Stop (or Start) the resource—depending on the current **State**. - - **Console logs**: Navigate to the resource's console logs. - - **Ellipsis**: A submenu with extra resource specific actions: - - **View details**: View the resource details. - - **Console log**: Navigate to the resource's console logs. - - **Structured logs**: Navigate to the resource's structured logs. - - **Traces**: Navigate to the resource's traces. - - **Metrics**: Navigate to the resource's metrics. - - **Restart**: Stop and then start the resource. - -The full resource table is shown on the **Overview** tab, which is where the dashboard opens. The data tabs (**Console**, **Structured logs**, **Traces**, and **Metrics**) don't have a page-level close button that returns to the table. In the resource list, **All resources** is the first row and selects every resource. Rows for resources that have no logs or traces are muted, and the tooltip explains why. Ages are shown in a short form such as "7m ago" and are hidden when every resource shows the same one. - -Consider the following screenshot of the resources page: - - +- **Type**: The kind of resource, such as a project, container, or executable. +- **State**: The current state of the resource. An unviewed error count badge links to [structured logs](#structured-logs-page) filtered to errors for that resource. +- **Start or stop time**: How long ago the resource started or stopped, shown in a short form such as "7m ago". +- **Source**: The source of the resource, such as a project file or container image. +- **URLs**: The first URL for the resource. When more URLs are available, select the "+N" button to see them. A URL's tooltip shows its address. +- **Actions**: The available [resource actions](#resource-actions), such as starting or stopping a resource. + +Select **All resources** at the top of the list to open the overview for all resources, or select a resource to open its overview. On narrow screens, the dashboard opens to the overview for all resources instead of the full-page list. Select the dashboard's name or logo to return to the full-page list on desktop. + +Use the **Console**, **Structured logs**, **Traces**, and **Metrics** tabs to view data for the selected resources. On the structured logs, traces, and metrics tabs, a resource without the corresponding data is muted in the list, and its tooltip explains why. Alternatively, you can view the resources as a graph. The graph view provides a visual representation of the resources and their dependencies. This view is useful for understanding how the different resources in your app are connected and how they interact with each other: @@ -257,24 +236,7 @@ Resources that depend on other resources that are stopped, or restarted, might e ##### Resource submenu actions -Selecting the horizontal ellipsis icon in the **Actions** column opens a submenu with additional resource-specific actions. In addition to the built-in resource submenu actions, you can also define custom resource actions by defining custom commands. For more information, see [Custom resource commands in Aspire](/fundamentals/custom-resource-commands/). For the built-in resource submenu actions, consider the following screenshot: - - - -The following submenu actions are available: - -- **View details**: View the resource details. -- **Console log**: Navigate to the resource's console logs. -- **Structured logs**: Navigate to the resource's structured logs. -- **Traces**: Navigate to the resource's traces. -- **Metrics**: Navigate to the resource's metrics. -- **Restart**: Stop and then start the resource. - - +Select the horizontal ellipsis in a resource row to open its actions menu. Available actions depend on the resource and can include viewing JSON, opening telemetry, and restarting the resource. You can also define custom actions. For more information, see [Custom resource commands in Aspire](/fundamentals/custom-resource-commands/). #### Copy or Open in text visualizer @@ -295,9 +257,7 @@ Some values are formatted as JSON or XML. In these cases, the text visualizer en ### Resource details -You can obtain full details about each resource by selecting the ellipsis button in the **Actions** column and then selecting **View details**. The **Details** page provides a comprehensive view of the resource: - - +Select a resource in the list to open its **Overview** tab. This view shows resource details, including properties, environment variables, and available endpoints. Matching endpoint addresses are grouped, and the tooltip shows an additional address when one is available. The search bar in the upper right of the dashboard also provides the option to filter the list, which is useful for Aspire projects with many resources. To select the types of resources that are displayed, drop down the arrow to the left of the filter textbox: