docs: 12-Factor tutorial updates
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
Five updates proposed by @evildmp in https://github.com/canonical/charmcraft/issues/2235 that affect all four of the 12-factor tutorials and the reusable setup scripts.
### Summary of changes
* Updated the Multipass install link to point to the correct how-to guide.
* Removed explicit mentions of "If you aren't on a host with AMD64 architecture" and the note admonitions around the rock and charm names. This is to help the user build up the muscle memory of the naming and take responsibility for the file names.
* Added a brief description of the ``--profile`` flag in the rock and charm creation sections.
* (Django tutorial only) Reduced the text in the "We'll need to update the settings.py file..." paragraph, again to help the user build muscle memory of where the file is located.
* (Django tutorial only) Rephrased the text about connecting the Django app to PostgreSQL, as that's not what's actually going on at that time. Instead we're adding the PostgreSQL relation endpoint to the charm project file, so the text now reflects that change.
In addition to these changes, a warning admonition block about older versions of Charmcraft was removed in the Django tutorial.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates for 12-factor tutorials and setup scripts. Changes fix a broken Multipass link, remove redundant warnings, clarify the --profile flag, simplify Django instructions, and correct PostgreSQL relation descriptions. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates for the 12-factor tutorials. Changes fix the Multipass link, remove architecture and naming warnings, add the --profile flag description, refine Django instructions, and remove an outdated Charmcraft warning. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2257 Docs: 12-factor tutorial updates | charmcraft | merged | 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. | |
| #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. | |
| #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. | |
| #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. | |
| #2352 docs: update 12-factor how-to guide on async apps | charmcraft | merged | Merged documentation update to the 12-factor async apps guide. Changes add a Django compatibility note, requirements.txt caption, assumed app name, and adjusted juju monitoring advice. Approved by two reviewers and passed CI checks. | |
| #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. | |
| #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. | |
| #2742 docs: 12 factor v2 | charmcraft | merged | Merged documentation update for 12 factor v2. Author corrected malformed reST causing build failures, received three approvals, and passed all CI checks. Changes modified 26 files with 690 additions and 364 deletions. | |
| #2368 docs: Update 12-factor initialization how-to guide | charmcraft | merged | Merged documentation update consolidating the 12-factor initialization guide into the main how-to page, removing dedicated sections, and updating redirects. Approved by reviewers with CI lint errors dismissed as unrelated to the docs. | |
| #2326 docs: Update 12-factor how-to landing page | charmcraft | merged | Merged documentation update to the 12-factor how-to landing page, adding context to the guides. Approved by two reviewers and rebased to the hotfix/3.5 branch before successful merge. |