Docs: Maintenance work on 12-factor tutorials
Metadata
Current evaluation
Merged in canonical/charmcraft#2193 via commit ecd6b411, shortening 12-factor tutorial URLs, fixing code-block highlighting, and standardizing terminology across four tutorials.
Resolution: closed resolved
Reason: PR #2193 was approved and merged as commit ecd6b411. It renamed tutorial files, updated setup scripts and the index, and refreshed all four tutorials.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Maintenance work on tutorials that spans across the setup scripts, the tutorial index page and all four tutorials.
### Summary of work
* Renamed the files so that the URLs will be shortened
* In the setup files, updated some `code-block` directives to use `text` to fix weird highlighting issues in the render
* Update the "What you'll do" section to fix the tone and "collapsed list" feel
* Changes to microcopy/terminology patterns to establish consistency with industry standards, accessibility, and Starcraft terminology
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/charmcraft#2193 via commit ecd6b411, shortening 12-factor tutorial URLs, fixing code-block highlighting, and standardizing terminology across four tutorials. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/charmcraft#2193 (commit ecd6b411), shortening tutorial URLs, fixing code highlighting, and standardizing instructions and terminology across all four 12-factor tutorials. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation maintenance for 12-factor tutorials. Updates include renaming files for shorter URLs, fixing code block highlighting, improving tutorial tone and structure, and standardizing terminology for consistency, accessibility, and Starcraft references. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. |