Update 12-factor docs
Metadata
Current evaluation
Merged in canonical/rockcraft#735, adding a 12-factor app rock guide, updating Flask/Django/FastAPI references, revising tutorials, and refreshing documentation dependencies.
Resolution: closed resolved
Reason: PR #735 was merged after approval by three reviewers, delivering the planned documentation migration, extension reference updates, tutorial wording changes, and dependency updates.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
Major changes:
- **Migrated some Charm SDK docs to Rockcraft**: Created a how-to guide "How to build a 12-Factor app rock" that contains the rock-related sections currently in the [corresponding Charm SDK how-to guide](https://juju.is/docs/sdk/build-a-12-factor-app-charm). Migrated information on the Charm SDK reference pages for the Rockcraft extensions ([Flask](https://juju.is/docs/sdk/rockcraft-extension-flask-framework), [Django](https://juju.is/docs/sdk/rockcraft-extension-django-framework), [FastAPI](https://juju.is/docs/sdk/rockcraft-extension-fastapi-framework)).
- **Language changes to the tutorials**: Based on the [discussion](https://github.com/canonical/rockcraft/pull/723#discussion_r1793550048) in the PR to add the Go docs, I updated the language in the three tutorials to remove "you" entirely and replace with either "we" or imperative language.
- **Other**: A security test was failing in my forked repo, so I updated `requirements-dev.txt` and `requirements-doc.txt`. I mention it here because I don't know whether that was the correct solution or best practice (forgive me, I'm more of a technical author than software engineer).
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/rockcraft#735, adding a 12-factor app rock guide, updating Flask/Django/FastAPI references, revising tutorials, and refreshing documentation dependencies. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged the 12-factor documentation update, adding a Rockcraft build guide, updating Flask, Django and FastAPI extension references, and revising tutorial language. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #735 as commit e7a8d4d6, migrating 12-Factor app guidance into Rockcraft, updating Flask, Django and FastAPI references, revising tutorial language, and refreshing development dependencies. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update migrating 12-factor Charm SDK guides to Rockcraft. Revised tutorial language and updated dev requirements to fix a failing security test. Approved by three reviewers and successfully integrated. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Documentation updated to migrate Charm SDK content to Rockcraft, standardize tutorial language, and resolve a failing security test by updating development dependencies. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2276 docs: Updates to the 12-factor tutorials | charmcraft | merged | Docs-only PR merged as commit 5cacee4a, applying six updates from issue #2235 across all four 12-factor tutorials: rock/Juju model intros, 'edit' vs 'open' wording, a charmcraft pack seealso box, and Django notes. | |
| #2352 docs: update 12-factor how-to guide on async apps | charmcraft | merged | Merged as commit 43dc21be, updating the async Flask 12-factor guide to cover Django, clarify app naming, label requirements.txt, and recommend status monitoring. | |
| #2263 docs: 12-Factor tutorial updates | charmcraft | merged | Merged PR #2263 as commit 410dcd0b, updating all four 12-factor tutorials and shared setup scripts with clearer naming, corrected links, --profile guidance, and revised Django instructions. | |
| #2251 Docs: Updated 12-factor tutorials | charmcraft | merged | Merged as canonical/charmcraft#2251 (commit 592d93aa), updating 12-factor setup instructions to use Rockcraft latest/edge, simplify file creation, and remove outdated warnings and wording. | |
| #2282 docs: Updates to the 12-factor tutorials | charmcraft | merged | Merged PR #2282 as commit 2199bc08, updating four 12-factor tutorials with Rockcraft context, expanded Skopeo guidance, and clearer MicroK8s registry wording. | |
| #2220 docs: 12-factor tutorial maintenance | charmcraft | merged | Merged canonical/charmcraft#2220, updating four 12-factor tutorials with numbered task lists, tilde-prefixed paths, full-path captions, and consistent app.py naming. | |
| #2085 docs: update 12-factor tutorials | charmcraft | merged | Merged in #2085 (79fa5ad9), updating 12-factor tutorials to rST, incorporating UX feedback, and standardizing content after #2083. | |
| #2425 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged docs PR applying UX-session feedback to the 12-factor tutorials (commit 17ce91b5, 8 files, +349/-207): reordered rockcraft.yaml arch steps, reworded rock upload, code-blocked curl/config commands, and refreshed next-step links. | |
| #2368 docs: Update 12-factor initialization how-to guide | charmcraft | merged | Docs PR #2368 merged as commit fee8f06e: removed the standalone 12-factor init how-to page, folded its content into docs/howto/manage-web-app-charms/index.rst, dropped section structure, and added a redirect in docs/redirects.txt. |