[docs] Update aspire ps docs: clarify AppHost-only scope, link to aspire describe#1109
Open
aspire-repo-bot[bot] wants to merge 1 commit into
Open
Conversation
…cribe Documents the removal of the --resources and --include-hidden options from aspire ps (microsoft/aspire#17479). The command is now strictly an AppHost-level summary; users who need per-resource details or streaming should use aspire describe. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
14 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the AppHost-only scope of aspire ps and cross-references aspire describe for per-resource inspection, reflecting upstream CLI changes in microsoft/aspire#17479.
Changes:
- Adds a clarifying sentence in the Description section noting
aspire psis AppHost-level only and pointing toaspire describe. - Adds
aspire describeto the See also section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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#17479 by
@mitchdenny.Targeting
release/13.4— the latest release branch onmicrosoft/aspire.dev— becauserelease/13.5(from the source PR milestone13.5) does not exist there.Why this PR is needed
microsoft/aspire#17479 removed the
--resourcesand--include-hiddenoptions fromaspire ps, narrowing the command to an AppHost-level listing (analogous todocker ps/kubectl get pods). Users who need per-resource details or continuous streaming should useaspire describeinstead.The
aspire psreference page on the docs site did not previously document these removed options (they were added after the last docs update), but the page lacked:aspire psonly provides an AppHost-level summary, not resource data.aspire describefor resource inspection and streaming.What changed
Updated
src/frontend/src/content/docs/reference/cli/commands/aspire-ps.mdx:aspire psis an AppHost-level summary only, and directing users toaspire describefor per-resource details and streaming.aspire describeto the See also section.Files modified
src/frontend/src/content/docs/reference/cli/commands/aspire-ps.mdx— updated (existing page)