← Back to issue list

docs: Update FastAPI tutorial to remove chiselling section

View original Github issue

Metadata

Project
rockcraft
Number
#1330
Type
pull request
State
merged
Author
erinecon
Labels
Type: Documentation Type: Bug
Created
Updated
Closed

Current evaluation

Docs PR #1330 merged as commit eef25f2e, deleting the obsolete FastAPI chiselling tutorial section since the FastAPI extension now defaults to the bare base (2 files, +2/-130).

Resolution: closed resolved

Reason: Merged into main as commit eef25f2e, removing ~130 lines of outdated chiselling instructions from the FastAPI tutorial after the extension switched to the bare base. Merge was briefly blocked by a broken security-scan workflow, fixed by merged PR #1324 (36c7b7b4).

Evaluated by: mr-cal-bot

No scores available.

Issue body

Remove the outdated section on chiselling the FastAPI rock in the tutorial. The FastAPI extension uses the `bare` base by default now. Caught during a UXR session that I conducted today. Spread tests are failing overall, but the FastAPI test passed. --- - [X] I've followed the [contribution guidelines](https://github.com/canonical/rockcraft/blob/main/CONTRIBUTING.md). - [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [ran `make docs-lint` successfully] I've successfully run `make lint && make test`. - [X] I've added or updated any relevant documentation. - [N/A] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [ ] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Docs PR #1330 merged as commit eef25f2e, deleting the obsolete FastAPI chiselling tutorial section since the FastAPI extension now defaults to the bare base (2 files, +2/-130).
stealth/space-bunny-alpha — closed resolved Merged #1330 (commit eef25f2e), removing the obsolete FastAPI chiselling tutorial section because the extension now defaults to the bare base. PR #1324 restored the failing security-scan workflow.
qwen/qwen3.6-35b-a3b — — Merged documentation update removing an outdated FastAPI tutorial chiselling section, as the extension now defaults to the bare base. The contributor was blocked by a broken security scan workflow until PR #1324 resolved the issue, allowing final merge.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 95
keep open Removes outdated FastAPI chiselling tutorial section as the extension now uses the bare base by default. Approved by two reviewers, currently blocked by a known CI workflow issue that a maintainer is tracking.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
keep open Removes an outdated FastAPI tutorial section now that the extension uses the bare base by default. Approved by two reviewers but currently blocked by a CI security scan workflow issue.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Removes outdated FastAPI chiselling tutorial section as the extension now defaults to the bare base. Approved by two reviewers, awaiting maintainer assistance to resolve a security scan workflow block before merging.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Removes outdated FastAPI tutorial section on chiselling rocks, as the extension now defaults to the bare base. Approved by two reviewers, currently blocked by a security scan workflow issue.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 95
needs review Removes outdated chiselling section from FastAPI tutorial as the extension now defaults to the bare base. Approved by two reviewers with zero unresolved comments and clear CI status.
qwen/qwen3.6-35b-a3b
Staleness: 0
Complexity: 5
Confidence: 95
needs review Removes an outdated chiselling section from the FastAPI tutorial as the extension now defaults to the bare base. Approved by one reviewer, local tests passed, awaiting maintainer review and CI.
qwen/qwen3.6-35b-a3b
Staleness: 0
Complexity: 5
Confidence: 90
needs review Removes outdated chiselling instructions from the FastAPI tutorial as the extension now defaults to the bare base. Approved by one reviewer, passes local checks, and awaits final maintainer review or merge.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Removes an outdated chiselling section from the FastAPI tutorial since the extension now defaults to the bare base. Currently awaiting maintainer review with no CI checks run.

Update history

Date Change
updated
updated
updated
updated
updated
updated
created

Related work

  • Blocked By: canonical/rockcraft#1324 (confidence 95%)

    Broken security-scan workflow blocked the merge; maintainer jahn-junior said he merged #1330 only after #1324 fixed the workflow (merged as 36c7b7b4).

  • Related To: canonical/rockcraft#1151 (confidence 70%)

    Commit 00dbdb1d removed the same redundant chiselling steps from the Flask and Django tutorials, the same cleanup applied here to FastAPI.

  • Likely Fixed By: canonical/rockcraft#1320 (confidence 65%)

    Commit c3308a7c 'feat(extensions): support bare bases in V2 frameworks' made bare the default for 12-factor extensions like FastAPI, making the chiselling docs obsolete.

  • Related To: canonical/rockcraft#1286 (confidence 50%)

    Commit 19db8fff updated docs redirects from chiselling to chiseling, part of the ongoing docs cleanup of chisel terminology.

Related issues

Issue Project State Summary Similarity
#721 Fastapi tutorial rockcraft merged Merged PR #721 as commit a714bb21, adding a FastAPI tutorial and FastAPI extension reference documentation.
76%
#2343 docs: fix technical issues in go and fastapi tutorials charmcraft merged Merged PR #2343 (commit c56d45e2), correcting FastAPI configuration and framework references plus Go list rendering in the extension documentation.
74%
#2287 docs: align FastAPI tutorial structure with Django tutorial charmcraft merged Merged PR #2287 into hotfix/3.5, aligning the FastAPI tutorial with Django, adding development-cycle sections, correcting “Deplyoing,” and standardizing “Hello, world!”
72%
#1173 docs: remove stale chiselled rock tutorial references rockcraft merged Merged PR #1173 (commit 26ce6436), removing obsolete chiseled-rock steps from Flask, Django and FastAPI tutorials and updating verified rock sizes; it closed #1167.
72%
#1167 docs: remaining text referring to chiseled rocks in Flask and Django and chiseled rock section in FastAPI rockcraft closed Docs request for stale chiseled-rock text resolved by merged PR #1173 (commit 26ce6436): Flask, Django and FastAPI tutorials updated to bare-base flow, chiseled-rock sizes and reset commands removed.
71%