Repository navigation
[docs] Note ASPIREFILESYSTEM001 graduation to stable in Aspire 17.0 - #1846
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
docs-pr-reviewer report — [partial — phase A: 2 of 2 claims evaluated; phase B: not run (docs site was not served in this automated run)]Recommendation: approve (human sign-off on rendering advised) Source used: Phase A — claims
Phase B — doc-testerNot run. The 🤖 Posted by aspire.dev - squad (AI Agent) |
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain for the documentation update clarifying filesystem API stability in Aspire 17.0.
No open issues 🎉
What changed in this PR
Updates the filesystem diagnostic reference to explain that Aspire 17.0 graduates the filesystem service APIs to stable, so readers no longer need to suppress ASPIREFILESYSTEM001.
Changes:
- Adds a note identifying the stabilized APIs and clarifying that the diagnostic applies only to earlier Aspire versions.
- Imports Starlight’s
Asidecomponent to display the note.
| File | Description |
|---|---|
src/frontend/src/content/docs/diagnostics/aspirefilesystem001.mdx |
Adds the Aspire 17.0 graduation note while preserving guidance for earlier versions. |
Review effort: Balanced
|
Superseded by #2176, which consolidates the 17.0 retired experimental diagnostics docs with a consistent format ( |
## Summary <!-- Describe what this pull request changes and why. --> 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 #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 <!-- List any third-party links added or changed by this pull request and disclose any material affiliation with the linked organizations, such as employment, sponsorship, or ownership. Write "None" if this pull request doesn't add or change third-party links. --> None ## Validation <!-- List the checks you ran or explain why validation isn't needed. --> - `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. --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Documents changes from microsoft/aspire#20808
@mitchdennyTarget branch
Targeting
release/17.0based on the source PR milestone17.0.Why this PR is needed
microsoft/aspire#20808 removes the experimental status from the filesystem service APIs —
IFileSystemService,ITempFileSystemService,TempDirectory,TempFile, andIDistributedApplicationBuilder.FileSystemService— which previously required suppressingASPIREFILESYSTEM001. The PR body explicitly states:and
The
src/frontend/src/content/docs/diagnostics/aspirefilesystem001.mdxpage previously had no indication that these APIs had graduated, so a reader hitting old references or search results would believe suppression is still required.Summary of documentation changes
<Aside type="note">callout todiagnostics/aspirefilesystem001.mdx, following the existing graduation pattern used byaspireazure002.mdxandaspirecosmosdb001.mdx, stating that as of Aspire 17.0 the listed APIs are no longer experimental and no longer triggerASPIREFILESYSTEM001, and that the diagnostic only applies to earlier Aspire versions.AsideStarlight component alongside the existingBadgeimport.Files modified
src/frontend/src/content/docs/diagnostics/aspirefilesystem001.mdx(updated)No new pages were created; this is a targeted update to the existing diagnostic reference page. The
diagnostics/overview.mdxsummary table row was intentionally left unchanged, consistent with how prior graduated diagnostics (e.g., ASPIREAZURE002, ASPIRECOSMOSDB001) are represented there — the graduation detail lives on the individual diagnostic page.