Docs: 12-factor tutorial updates
Metadata
Current evaluation
Merged PR #2257 as commit e549afa7, applying six clarity, terminology, and formatting updates across all four 12-factor tutorials.
Resolution: closed resolved
Reason: The PR merged into main as e549afa7 after approval, implementing six documentation updates proposed in canonical/charmcraft#2235.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Six updates proposed by @evildmp in https://github.com/canonical/charmcraft/issues/2235 that affect all four of the 12-factor tutorials.
### Summary of changes
* Converted first note admonition into a normal paragraph.
* Updated the ambiguity of "Ensure that platforms includes the architecture of your host." by using the suggestion "Platforms must match the architecture of your host."
* Updated the instruction to edit `rockcraft.yaml` using the suggestion.
* Removed an explicit reference to AMD64 architecture at the Juju model constraint step to let the user build up muscle memory. Architecture is still mentioned because that's what the command is explicitly doing.
* (Django tutorial only) Updated "The generated Django app doesn’t come with an app" to reference the Django *project* instead.
* (Django tutorial only) Updated `MULTIPASS_PRIVATE_IP` to use regular text formatting, as the original spelling implied a variable.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2257 as commit e549afa7, applying six clarity, terminology, and formatting updates across all four 12-factor tutorials. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2257 in commit e549afa7, updating all four 12-factor tutorials with clearer instructions, corrected Django terminology, and formatting fixes. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation updates for the 12-factor tutorials. Changes clarify architecture instructions, fix Django tutorial terminology, convert admonitions to paragraphs, and correct variable formatting. Approved by reviewers and merged. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates for four 12-factor tutorials. Clarified platform architecture instructions, converted admonitions to paragraphs, updated Django terminology, fixed variable formatting, and removed explicit AMD64 references. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/charmcraft#2235
(confidence 100%)
This PR implemented six tutorial-feedback updates requested in the linked issue.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2193 Docs: Maintenance work on 12-factor tutorials | charmcraft | merged | Merged in canonical/charmcraft#2193 via commit ecd6b411, shortening 12-factor tutorial URLs, fixing code-block highlighting, and standardizing terminology across four tutorials. | |
| #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. | |
| #2241 Docs: Update 12-factor tutorials | charmcraft | merged | Merged as commit acf5d293 ("Docs: Update 12-factor tutorials", #2241), updating all four tutorials with a charmcraft expand-extensions tip, juju status tip, generic arch output, and faster repacking notes. | |
| #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. | |
| #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. | |
| #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. | |
| #2445 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged PR #2445 as commit 787f82c4, updating six 12-factor tutorial files with UX feedback on resources, ingress, configuration, wording, and PostgreSQL setup. | |
| #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. | |
| #918 docs: Incorporate UX feedback into 12-factor tutorials | rockcraft | merged | Merged PR #918 as ddb5bbba, updating the 12-factor tutorials with UX feedback on architecture, setup, Multipass, multi-architecture commands, pack warnings, and terminology. | |
| #2742 docs: 12 factor v2 | charmcraft | merged | Merged the 12-factor v2 documentation overhaul across 26 files in commit 91f9fc06 after reST fixes and three approvals. |