Skip to content

[docs] Document dashboard sidebar resource availability - #2069

Closed
aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-21819-42157416319-1-1f1c8adc8c910a6a
Closed

aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-21819-42157416319-1-1f1c8adc8c910a6a

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#21819

Author: @IEvangelist

Target branch: Targeting release/17.0 based on the source PR milestone 17.0 (exact match).

Why: The PR adds contextual availability badges (No logs, No traces, No metrics, Not applicable), parameter explanations, and Select all highlighting to the dashboard resource sidebar. Triggered signals: dashboard_user_facing_page_changed, new_public_type, pr_body_has_user_facing_section. The existing docs don't describe this.

Changes:

  • Updated src/frontend/src/content/docs/dashboard/explore.mdx: new "Resource availability in the sidebar" section under Monitoring pages.

Generated by PR Documentation Check for #21819 · copilot · auto · 28.3 AIC · ⌖ 1.16 AIC · ⊞ 7.4K · ◷

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Nov 6, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #2069. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #2069 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

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.

🟡 Changes recommended

The documentation describes badges that the implementation explicitly omits and uses an outdated aggregate-row label, so it needs to reflect muted-row behavior and the current “All resources”/“All sources” labels.

2 open issues
What changed in this PR

This PR expands the dashboard guide to explain sidebar resource availability for Aspire 17.0, following microsoft/aspire#21819.

Changes:

  • Adds a “Resource availability in the sidebar” section under Monitoring pages.
  • Describes unavailable telemetry, parameter explanations, and aggregate selection highlighting.
  • Clarifies that resources without OpenTelemetry data can appear in traces reported by other resources.
File Description
src/​frontend/​src/​content/​docs/​dashboard/​explore.mdx Adds sidebar availability and selection guidance across dashboard monitoring pages.

Review effort: Balanced

Comment on lines +340 to +341
- **No logs**, **No traces**, and **No metrics** badges appear next to resources that haven't sent that signal. The rows are muted but still selectable, and selecting one opens the normal empty view. When the resource sends telemetry, the badge disappears and the data appears without reselecting the resource. If the signal is cleared, the badge and empty state return.
- **Not applicable** appears for parameters. Hover or keyboard-focus a parameter to see why the current feature doesn't apply to it, such as no console logs, structured logs, traces, metrics, or terminal. Press <Kbd windows="Enter" mac="Return" linux="Enter" /> or select the parameter to open its overview.

- **No logs**, **No traces**, and **No metrics** badges appear next to resources that haven't sent that signal. The rows are muted but still selectable, and selecting one opens the normal empty view. When the resource sends telemetry, the badge disappears and the data appears without reselecting the resource. If the signal is cleared, the badge and empty state return.
- **Not applicable** appears for parameters. Hover or keyboard-focus a parameter to see why the current feature doesn't apply to it, such as no console logs, structured logs, traces, metrics, or terminal. Press <Kbd windows="Enter" mac="Return" linux="Enter" /> or select the parameter to open its overview.
- In the aggregate view, only **Select all** is highlighted. Individual, <Kbd windows="Ctrl" mac="Cmd" linux="Ctrl" />-click, <Kbd windows="Shift" mac="Shift" linux="Shift" />-click range, and group selections keep their existing selection indicators.
David Pine (IEvangelist) added a commit that referenced this pull request Nov 17, 2026
## Summary

Consolidates the open `docs-from-code` PRs that cover features from
@IEvangelist's product work or that request their review, all targeting
`release/17.0`, into this single PR. Each PR was checked against its
merged microsoft/aspire source PR and against product `release/17.0`, to
confirm the change shipped in 17.0 and is user-facing rather than an
implementation detail. Accepted text was corrected where the bot's
wording was inaccurate.

| PR(s) | Verdict | Notes |
| --- | --- | --- |
| #2103, #2098, #1967, #2073, #2070 | Accepted with fixes | Go AppHost
conventions, `aspire init`, and VS Code extension. Unrelated e2e test
edits from #2073 were dropped. |
| #1972 | Partially accepted | Only the verified behavior was kept. |
| #2069, #2064, #1829 | Accepted with fixes | Dashboard explore page and
`aspire describe --format Mermaid` |
| #2044 | Partially accepted | The Cards/Home/Graph layout selector text
is outdated, so it was dropped. |
| #1959, #1904, #1835, #1801 | Accepted with fixes | `WithTerminal`
options, the dashboard terminal UX, and TypeScript `configure` |
| #1902 | Accepted with fixes | `dotnet run --operation publish`
guidance |
| #2081 | Accepted with fixes | WSLc limited publish support. The
minimum version is corrected to 3.0.4.0. |
| #2014, #1862, #1809, #1936, #2140, #1997, #2051, #2068, #2022, #1963 |
Accepted with fixes | DCP timeouts, the container tunnel base image,
browser origins, the PVC `WithConfiguration` API, the interaction
service caution, secrets, `aspire update`, and agent init telemetry |
| #2092 | Rejected | Documents implementation details. |
| #2078 | Rejected | Already documented correctly; the proposed text was
wrong. |
| #2110, #2104, #2085, #2094 | Rejected | The product change isn't in
`release/17.0`; it's 17.1-only. Redo these against the next release
branch. |
| #2133 | Rejected for now | Its backport, microsoft/aspire#22219, is
still open, so redo this once it merges. |

Additional consistency fixes:

- **WSLc:** the minimum version is now 3.0.4.0, the source's
`MinimumWslcVersion`, across prerequisites, `aspire doctor`,
configuration, and what's new. The pages now describe limited publish
support and state that Docker Compose isn't supported.
- **`WithTerminal`:** `WithTerminal` and `TerminalOptions` are no longer
`[Experimental]` in 17.0. I removed the stale `ASPIRETERMINAL001`
pragmas and cautions and rewrote the diagnostic page to cover the
terminal APIs that are still experimental.

Closes #2140
Closes #2133
Closes #2110
Closes #2104
Closes #2103
Closes #2098
Closes #2094
Closes #2092
Closes #2085
Closes #2081
Closes #2078
Closes #2073
Closes #2070
Closes #2069
Closes #2068
Closes #2064
Closes #2051
Closes #2044
Closes #2022
Closes #2014
Closes #1997
Closes #1972
Closes #1967
Closes #1963
Closes #1959
Closes #1936
Closes #1904
Closes #1902
Closes #1862
Closes #1835
Closes #1829
Closes #1809
Closes #1801

## Third-party links and affiliations

None. The only added external link is to mermaid.js.org, which the page
already links elsewhere.

## Validation

- I compared each claim with the merged microsoft/aspire source and
checked that it's included in product `release/17.0`, using `gh api
compare` and searches for backport PRs.
- I checked the TypeScript sample against the generated `aspire.d.ts`.
`EndpointReferenceExpression` is an `IValueProvider`.
- I reviewed the full diff by hand for MDX and table formatting,
imports, and anchors. The new `seoTitle` is 58 characters.
- I didn't run any local unit, e2e, or build commands because frontend
dependencies aren't installed locally. CI covers the build, unit, and
e2e checks, including the updated `custom-components.spec.ts` assertion.

---------

Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@alistairmatthews

Copy link
Copy Markdown
Collaborator

Superseded by #2189 (merged to release/17.0)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants