Docs: Update 12-factor tutorials
Metadata
Current evaluation
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.
Resolution: closed resolved
Reason: The PR was merged into main as commit acf5d293 after approval by two reviewers with no unresolved comments. Its changes (expand-extensions tip, juju status tip, generic rockcraft pack architecture output, faster subsequent packing note) are present in docs/tutorial/kubernetes-charm-*.rst.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Updates to the 12-factor tutorials that affect all four tutorials.
### Summary of changes
* Add a tip admonition to let the user know about `charmcraft expand-extensions`. This has been a repeated ask from UX research participants.
* Convert the `juju status` admonition to a tip to recommend that users start a `juju status` session in a new tab to monitor their deployment. This prepares the user for a successful deployment setup.
* Update the terminal output for `rockcraft pack` to use a generic architecture stand-in. This indicates that the architecture plays an active role in defining the rock.
* Mention that subsequent `charmcraft pack` and `rockcraft pack` commands are faster after the initial packing. This has been a repeated ask from UX research participants.
* Condense text about adding an architecture constraint to the Juju model, for conciseness.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | 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. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged charmcraft#2241 (acf5d293), updating all four 12-factor tutorials with expand-extensions and Juju status tips, generic architecture output, and faster-build guidance. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation updates to the 12-factor tutorials. Changes add UX tips for charmcraft and juju status, update rockcraft output, note faster builds, and condense architecture text. Approved by two reviewers and passed CI. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates to the 12-factor tutorials. Changes add tips for charmcraft and juju status, update rockcraft pack output, note faster subsequent builds, and condense architecture constraint instructions. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/charmcraft#2251
(confidence 70%)
Follow-up 'Docs: Updated 12-factor tutorials' (592d93aa) by the same author continuing the same UX-driven tutorial series.
-
Related To:
canonical/charmcraft#2354
(confidence 60%)
Later 'Incorporate UX feedback into 12-factor tutorials' commits (06ec43fb, d6fe569c) continue this docs effort.
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. | |
| #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. | |
| #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. | |
| #2257 Docs: 12-factor tutorial updates | charmcraft | merged | Merged PR #2257 as commit e549afa7, applying six clarity, terminology, and formatting updates across all four 12-factor tutorials. | |
| #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. | |
| #2732 docs: Update 12-factor Spread tests | charmcraft | merged | Merged as 14284182 (canonical/charmcraft#2732), updating 12-factor Spread test documentation with typo fixes and removal of outdated material. | |
| #2326 docs: Update 12-factor how-to landing page | charmcraft | merged | Merged in charmcraft#2326 via commit 706e0dba, adding context to the 12-factor how-to landing page for ISD-3595. | |
| #2219 Docs: Add 12-factor how-to sections for integrations | charmcraft | merged | Merged as 69dd1326, adding database, ingress, and observability integration sections to the 12-factor web-app charm how-to. | |
| #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. |