← 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

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.

Suggested action:

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
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 issues

Issue Project State Summary Similarity
#1151 docs: remove redundant chiselling steps from Flask and Django tutorials rockcraft merged Merged docs update removing redundant chiselling steps from Flask and Django tutorials. Clarified base: bare already produces a chiselled rock. FastAPI unchanged. Approved and merged as a partial fix for #1143.
78%
#2287 docs: align FastAPI tutorial structure with Django tutorial charmcraft merged Merged after the contributor signed the CLA and rebased to hotfix/3.5. Aligns FastAPI tutorial structure with Django, fixes typos, and standardizes headings. Updates will appear in the next Charmcraft patch release.
75%
#1143 docs: remove chiseling section in Flask and Django rock tutorials rockcraft closed Resolved via PR #1151, removing redundant 'Chisel the rock' sections from Flask and Django tutorials and adding a bare base note. FastAPI was excluded due to its different base configuration.
74%
#2343 docs: fix technical issues in go and fastapi tutorials charmcraft merged Merged documentation fixes for Go and FastAPI tutorials. Resolved rendering issues, removed outdated Flask references, and corrected config blocks. Approved by three reviewers and merged after CI checks, with 18 additions and 14 deletions.
73%
#721 Fastapi tutorial rockcraft merged Added a FastAPI tutorial and reference documentation. Approved by two reviewers and successfully merged despite unresolved comments regarding linting link checks and a security scan timeout.
73%
#1167 docs: remaining text referring to chiseled rocks in Flask and Django and chiseled rock section in FastAPI rockcraft closed Documentation updated to remove outdated chiseled rock references and adjust sizes/commands in Flask, Django, and FastAPI tutorials. Issue closed after a contributor volunteered to implement the changes.
71%