Skip to content

[docs] Update dashboard resources page docs for simplified dashboard #2095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aspire-repo-bot wants to merge 1 commit into
base: release/17.0
Choose a base branch
from
+4 −2
Open

[docs] Update dashboard resources page docs for simplified dashboard #2095

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/frontend/src/content/docs/dashboard/explore.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Comment on lines 199 to 200
- **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**.
Expand All @@ -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:

<ThemeImage dark={projects} light={projectsLight} alt="A screenshot of the Aspire dashboard Resources page." />
Expand Down
Loading