docs: 12-factor tutorial maintenance
Metadata
Current evaluation
Merged canonical/charmcraft#2220, updating four 12-factor tutorials with numbered task lists, tilde-prefixed paths, full-path captions, and consistent app.py naming.
Resolution: closed resolved
Reason: PR canonical/charmcraft#2220 was merged after approval by two reviewers, completing the documented 12-factor tutorial maintenance.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### Overview
Mostly directory-related maintenance work spanning across all four 12-factor tutorials.
### Summary of changes
* The "What you'll do" sections are now numbered lists.
* Any mention of the root directory (e.g., `/django-hello-world`) now contains a tilde in front (e.g., `~/django-hello-world`).
* Captions on full code examples now contain captions with explicit reference to the full path (e.g., `app.py` is now `~/flask-hello-world/app.py`). This change did not affect snippets of YAML files, which contain no caption whatsoever.
* Some mentions of `visitors_app.py` were renamed to `app.py` as the `visitors_app.py` naming was due to the multiple Python files needed for the spread tests.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged canonical/charmcraft#2220, updating four 12-factor tutorials with numbered task lists, tilde-prefixed paths, full-path captions, and consistent app.py naming. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged docs-only maintenance PR #2220 (commit 319673ca): numbered "What you'll do" lists, tilde-prefixed root paths, full-path code captions, and app.py naming across all four 12-factor tutorials. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged canonical/charmcraft#2220, updating all four 12-factor tutorials with numbered task lists, tilde-prefixed paths, full-path code captions, and consistent app.py naming. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #2220, updating all four 12-factor tutorials with numbered task lists, tilde-prefixed paths, fuller code captions, and consistent app.py naming. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation maintenance for the 12-factor tutorials. Updates include numbering what-you-will-do sections, prefixing root paths with tildes, updating code captions to show full paths, and renaming visitors_app.py to app.py. |
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 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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #2368 docs: Update 12-factor initialization how-to guide | charmcraft | merged | Docs PR #2368 merged as commit fee8f06e: removed the standalone 12-factor init how-to page, folded its content into docs/howto/manage-web-app-charms/index.rst, dropped section structure, and added a redirect in docs/redirects.txt. | |
| #2345 docs: add structure to 12-factor reference pages | charmcraft | merged | Merged in canonical/charmcraft#2345 as commit e0d3c296, restructuring 12-factor reference pages with clearer relation and environment-variable sections and tables. | |
| #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. |