Skip to content

Consolidate 17.0 retired experimental diagnostics docs - #2176

Merged
Maddy Montaquila (maddymontaquila) merged 3 commits into
release/17.0from
docs/retire-experimental-diagnostics-17.0
Nov 16, 2026
Merged

Maddy Montaquila (maddymontaquila) merged 3 commits into
release/17.0from
docs/retire-experimental-diagnostics-17.0

Conversation

@maddymontaquila

@maddymontaquila Maddy Montaquila (maddymontaquila) commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Consolidates the retired experimental diagnostic documentation for Aspire 17.0, superseding the individual PRs against release/17.0.

  • Marks 14 diagnostic pages as retired in 17.0, retaining their historical content and guidance for removing suppressions.
  • Updates the diagnostics overview and the 17.0 release notes, including ASPIREDENO001 and ASPIRECONNECTIONSTRINGS001, which don't have dedicated pages.
  • Explains that ASPIRECOMPUTE002 was only partially graduated: endpoint-mapping contracts are stable, while persistent-volume APIs remain experimental.
  • Removes retired suppressions and experimental cautions from affected guides, while retaining the experimental image-building guidance for ASPIREPIPELINES003.
  • Notes that ASPIRECSHARPAPPS001 was retired when AddCSharpApp became obsolete. The broader migration and ProjectResource v2 guidance is separate in docs: Migrate to AddDotnetProject/DotnetProjectResource and remove Aspire.AppHost.Sdk #2180.

The retired diagnostic list was checked against [Experimental("…")] usages in microsoft/aspire between v13.6.5 and release/17.0.

Supersedes #1846, #1847, #1851, #1852, #1853, #1854, #1856, #1857, #2127, #2167, #2168, #2169, #2170, #2171.

Third-party links and affiliations

None

Validation

  • git diff --check origin/release/17.0 -- src/frontend/src/content/docs — passed.
  • Frontend validation CI — passed; frontend build CI is pending.
  • Local Astro build and tests were not run; Bun and frontend dependencies were unavailable.

Mark the experimental diagnostics that graduated in Aspire 17.0 as retired
with a consistent "Retired in: 17.0" badge and note, update the diagnostics
overview, add a consolidated What's new section, and remove stale
suppressions across the docs.

Supersedes #1846, #1847, #1851, #1852, #1853, #1854, #1856, #1857, #2127,
#2167, #2168, #2169, #2170, and #2171.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

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 migration caveat incorrectly advises users who publish or deploy to retain the obsolete API, even though DotnetProjectResource already supports automatic publishing.

1 open issue
What changed in this PR

Consolidates Aspire 17.0 diagnostic retirement documentation across the reference pages, integration guides, and release notes, replacing the separate per-diagnostic updates.

Changes:

  • Marks retired diagnostics consistently while preserving historical guidance and distinguishing the remaining experimental scope of ASPIRECOMPUTE002.
  • Documents AddCSharpApp obsoletion and migration to AddDotnetProject.
  • Removes outdated experimental cautions and suppressions, and clarifies MCP endpoint behavior.

Paths below are relative to src/frontend/src/content/docs/.

File Description
whats-new/​aspire-17.mdx Summarizes API graduations and AddCSharpApp obsoletion.
integrations/​frameworks/​javascript.mdx Removes retired JavaScript and Dockerfile-builder warnings.
integrations/​frameworks/​dotnet/​dotnet-host.mdx Links to AddCSharpApp migration guidance.
integrations/​dotnet/​project-resources.mdx Adds the obsoletion notice to the API comparison.
integrations/​dotnet/​csharp-file-based-apps.mdx Adds migration guidance and updates diagnostic suppressions.
integrations/​compute/​kind/​kind-host.mdx Removes the retired pipeline suppression.
integrations/​compute/​docker.mdx Removes Dockerfile-builder experimental guidance.
integrations/​cloud/​azure/​role-assignments.mdx Removes the retired Azure diagnostic suppression.
integrations/​cloud/​azure/​configure-container-apps.mdx Updates naming API status while retaining deployment cautions.
get-started/​resource-mcp-servers.mdx Corrects PostgreSQL suppression and clarifies MCP endpoint selection.
get-started/​add-aspire-existing-app.mdx Updates AddCSharpApp warning and migration advice.
fundamentals/​environment-variables.mdx Documents stable connection-string naming metadata.
diagnostics/​overview.mdx Updates diagnostic statuses and adds ACANAMING002.
diagnostics/​aspireusersecrets001.mdx Marks user-secrets diagnostic retired in 17.0.
diagnostics/​aspireprobes001.mdx Marks HTTP-probe diagnostic retired in 17.0.
diagnostics/​aspirepipelines004.mdx Marks pipeline-output diagnostic retired in 17.0.
diagnostics/​aspirepipelines002.mdx Marks deployment-state diagnostic retired in 17.0.
diagnostics/​aspirepipelines001.mdx Marks core-pipeline diagnostic retired in 17.0.
diagnostics/​aspiremcp001.mdx Marks WithMcpServer diagnostic retired in 17.0.
diagnostics/​aspirejavascript001.mdx Marks JavaScript diagnostic retired in 17.0.
diagnostics/​aspirefilesystem001.mdx Marks filesystem diagnostic retired in 17.0.
diagnostics/​aspiredockerfilebuilder001.mdx Marks Dockerfile-builder diagnostic retired in 17.0.
diagnostics/​aspirecsharpapps001.mdx Explains retirement and replacement by CS0618.
diagnostics/​aspirecompute002.mdx Narrows experimental scope to persistent volumes.
diagnostics/​aspirecommand001.mdx Marks command-validation diagnostic retired in 17.0.
diagnostics/​aspireazure001.mdx Marks Azure publishing diagnostic retired in 17.0.
diagnostics/​aspireacanaming002.mdx Marks unique-naming diagnostic retired in 17.0.
diagnostics/​aspireacanaming001.mdx Marks compact-naming diagnostic retired in 17.0.
deployment/​pipelines.mdx Removes retired pipeline suppressions.
deployment/​javascript-apps.mdx Removes retired JavaScript and pipeline cautions and suppressions.
deployment/​docker-compose.mdx Removes Dockerfile-builder cautions and suppressions.
deployment/​custom-deployments.mdx Distinguishes stable pipelines from experimental image-building APIs.
app-host/​withdockerfile.mdx Removes Dockerfile-builder cautions and suppressions.

Review effort: Balanced

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

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

VS Code: Open PR #2176 artifacts

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

Move AddCSharpApp -> AddDotnetProject migration guidance out of this PR into a
separate ProjectResource v2 guidance overhaul.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@maddymontaquila

Copy link
Copy Markdown
Contributor Author

This is informational artifact-notification content and does not request a code change. No repository change is needed; the build artifact is available through the provided link.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@maddymontaquila
Maddy Montaquila (maddymontaquila) merged commit 71fe831 into release/17.0 Nov 16, 2026
17 checks passed
@maddymontaquila
Maddy Montaquila (maddymontaquila) deleted the docs/retire-experimental-diagnostics-17.0 branch November 16, 2026 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants