Docs: 12-factor tutorial updates
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates for the 12-factor tutorials. Changes clarify platform architecture instructions, adjust admonition formatting, fix Django project references, and standardize variable formatting. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #2263 docs: 12-Factor tutorial updates | charmcraft | merged | Merged documentation updates for 12-Factor tutorials and setup scripts. Fixes Multipass link, removes outdated notes, clarifies --profile flag, simplifies text, and corrects Django PostgreSQL relation description. Approved by two reviewers. | |
| #2220 docs: 12-factor tutorial maintenance | charmcraft | merged | Merged documentation maintenance for 12-factor tutorials. Changes include numbered task lists, tildes for root directories, explicit paths in captions, and renaming visitors_app.py to app.py. Approved by two reviewers with passing 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. | |
| #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. | |
| #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. | |
| #2445 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Edits clarify resources, ingress context, phrasing, environment variables, and database timing. Approved by two reviewers and passed CI checks. | |
| #2387 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged documentation updates to the 12-factor tutorials based on UX feedback. Changes add a deploy intro, verify and destroy subsections, an achievements section, and fix PostgreSQL spelling. Approved by two reviewers with all CI checks passing. | |
| #2455 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes refine directory phrasing, remove explicit cd commands, and relocate code comments to main text. Approved by two reviewers and merged. |