Docs: Update 12-factor tutorials
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates to the 12-factor tutorials. Adds UX tips for charmcraft and juju status, updates rockcraft pack examples, notes faster builds, and condenses architecture constraint instructions. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2276 docs: Updates to the 12-factor tutorials | charmcraft | merged | Merged documentation updates across four 12-factor tutorials. Changes add rock and Juju model explanations, standardize instructional wording, and include context notes. Approved by reviewers and integrated. | |
| #735 Update 12-factor docs | rockcraft | merged | 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. | |
| #2251 Docs: Updated 12-factor tutorials | charmcraft | merged | Merged documentation updates for the 12-factor tutorials. Changes include switching to the latest Rockcraft edge channel, removing outdated warnings, simplifying file creation, and refining wording across six files. Approved and merged. | |
| #1006 docs: Incorporate UX feedback into 12-factor tutorials | rockcraft | merged | Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes clarify VM shell instructions, terminal closing steps, and rockcraft version warnings. Approved by two reviewers and passed CI checks. | |
| #2282 docs: Updates to the 12-factor tutorials | charmcraft | merged | Merged documentation updates to the 12-factor tutorials and task files. Changes include added rockcraft admonitions, clarified skopeo copy options, and updated the MicroK8s registry description. Approved and passed CI checks. | |
| #2354 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged documentation updates to 12-factor tutorials based on UX feedback. Changes include switching code blocks to dropdowns, adding explicit paths, and clarifying MicroK8s and Juju setup. Approved by two reviewers and merged after CI validation. | |
| #2193 Docs: Maintenance work on 12-factor tutorials | charmcraft | merged | Merged documentation maintenance for 12-factor tutorials. Updates rename files for shorter URLs, fix code highlighting, revise instructions, and standardize terminology for consistency and accessibility. Approved by two reviewers. | |
| #2425 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged documentation updates to the 12-factor tutorials based on UX feedback. Changes include reordered setup steps, improved upload phrasing, added command blocks, and updated next steps links. Approved and passed CI. | |
| #918 docs: Incorporate UX feedback into 12-factor tutorials | rockcraft | merged | Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes clarify architecture, update multi-arch commands, refine terminology, and adjust setup. Approved by three reviewers and merged. | |
| #2085 docs: update 12-factor tutorials | charmcraft | merged | Merged after converting the 12-factor tutorials to reStructuredText and incorporating UX feedback. Conflicts with PR #2083 were resolved via maintainer coordination before finalizing the merge. |