Repository navigation
Document WithDisplayOrder and consolidate dashboard explore fixes - #2105
Merged
Sébastien Ros (sebastienros) merged 6 commits intoNov 13, 2026
Merged
Sébastien Ros (sebastienros) merged 6 commits into
Sébastien Ros (sebastienros) merged 6 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
6 of 14 tasks
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
David Pine (IEvangelist)
requested review from
Sébastien Ros (sebastienros)
and removed request for
James Newton-King (JamesNK)
November 12, 2026 23:54
David Pine (IEvangelist)
marked this pull request as ready for review
November 13, 2026 14:53
David Pine (IEvangelist)
requested review from
David Pine (IEvangelist) and
James Newton-King (JamesNK)
as code owners
November 13, 2026 14:53
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The WithDisplayOrder example will not compile without the required experimental-API suppression, and the documentation omits that persisted manual ordering overrides its default order.
2 open issues
What changed in this PR
Adds WithDisplayOrder guidance to the dashboard exploration guide for Aspire 17.0, documenting the replacement for WithDashboardPosition.
Changes:
- Explains that higher display-order values appear first and unset values count as zero.
- Adds a C# AppHost example ordering API and worker resources.
| File | Description |
|---|---|
src/frontend/src/content/docs/dashboard/explore.mdx |
Adds a resource display-order section with ordering semantics and an example. |
Review effort: Balanced
|
|
||
| ### Resource display order | ||
|
|
||
| By default, the dashboard sorts resources by name. To control where a resource appears, call `WithDisplayOrder` in the AppHost. It's a relative sort key: resources with a higher value appear first, and resources without a value count as `0`. |
Comment on lines
+336
to
+337
| ```csharp title="C# — AppHost.cs" | ||
| var builder = DistributedApplication.CreateBuilder(args); |
- Default order is by type then name; saved order wins; negative values - Add TypeScript sample and note the ASPIRERESOURCETRAITS001 experimental flag - Move the section next to Filter and group resources - Fold in contextual resource actions from #2045 - Fold in Aspire Outage Hard core mode and O shortcut from #2066
This was referenced Nov 13, 2026
Sébastien Ros (sebastienros)
enabled auto-merge (squash)
November 13, 2026 22:49
The unknown-arguments example ran 'aspire destroy --force' in a bash block, which the pipeline command options unit test flags as an undocumented option. Describe the invalid option in prose and keep the error output.
Sébastien Ros (sebastienros)
requested a review
from Mitch Denny (mitchdenny)
as a code owner
November 13, 2026 23:28
Sébastien Ros (sebastienros)
deleted the
docs/pr-21766-42886203726-1-51874edbd7f217d8
branch
November 13, 2026 23:59
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Documents changes from microsoft/aspire#21766
Author:
@sebastienrosTarget branch: Targeting
release/17.0— the latest release branch onmicrosoft/aspire.dev— because the source PR has no milestone orrelease/*base ref to derive a more specific target.Why: The source PR replaces
WithDashboardPositionwith the newWithDisplayOrderAPI (backed byDisplayOrderAnnotation), which controls resource ordering in the dashboard. Triggered signals:new_public_type(DisplayOrderAnnotation.cs) anddashboard_user_facing_page_changed(ResourceOverview.razor,TraceDetail.razor).Changes: Updated existing page
src/frontend/src/content/docs/dashboard/explore.mdxwith a "Resource display order" section describingWithDisplayOrdersemantics (higher values first, unset counts as 0) and an example.Review update: This PR now also consolidates the still-accurate parts of #2045 and #2066, which edited the same page:
WithDisplayOrdersemantics. The default order is resource type then name (ResourcesLayout.razor.cs). A saved drag order takes precedence, and negative values sort after unset resources.withDisplayOrderis[AspireExport]) and noted theASPIRERESOURCETRAITS001experimental diagnostic.Resources.resx), and the section now covers what hard core mode does and theOshortcut (from [docs] Document Aspire Outage game in the dashboard resource graph #2066).