Docs: Updated 12-factor tutorials
Metadata
Current evaluation
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.
Resolution: closed resolved
Reason: PR #2251 was merged as commit 592d93aa. It implemented selected feedback from #2235 across the reusable setup and all four 12-factor tutorials.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Updates to the 12-factor tutorials that affect the reusable setup files and all four tutorials. Some of these changes were suggested by @evildmp in https://github.com/canonical/charmcraft/issues/2235
### Summary of changes
* Updated the `setup_edge.rst` file to install the `latest/edge` channel of Rockcraft.
* Removed an admonition block in the Django tutorial that warned users about using an older version of Rockcraft.
* Removed any mentions of "easily" in the tutorials.
* Removed `touch` from the instructions and ask users to instead open the new file directly with `nano`.
* Removed the admonition block warning users about the Charmcraft version.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | 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. | |
| stealth/space-bunny-alpha | — | closed resolved | Docs PR #2251 merged (commit 592d93aa): 12-factor tutorials now install Rockcraft latest/edge via setup_edge.rst, drop outdated Rockcraft/Charmcraft version admonitions and "easily" wording, and replace touch with direct nano editing. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as #2251 (commit 592d93aa), updating the 12-factor tutorials to use Rockcraft latest/edge, remove outdated version warnings, simplify file creation, and remove “easily” wording. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates for the 12-factor tutorials. Changes include switching to the latest/edge Rockcraft channel, removing outdated version warnings, replacing touch commands with nano instructions, and refining tutorial text. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/charmcraft#2235
(confidence 98%)
The PR explicitly incorporates suggestions from the Django tutorial feedback issue, which records #2251 as one of its implementing PRs.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #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. | |
| #2282 docs: Updates to the 12-factor tutorials | charmcraft | merged | Merged PR #2282 as commit 2199bc08, updating four 12-factor tutorials with Rockcraft context, expanded Skopeo guidance, and clearer MicroK8s registry wording. | |
| #735 Update 12-factor docs | rockcraft | merged | Merged in canonical/rockcraft#735, adding a 12-factor app rock guide, updating Flask/Django/FastAPI references, revising tutorials, and refreshing documentation dependencies. | |
| #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. | |
| #2425 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged docs PR applying UX-session feedback to the 12-factor tutorials (commit 17ce91b5, 8 files, +349/-207): reordered rockcraft.yaml arch steps, reworded rock upload, code-blocked curl/config commands, and refreshed next-step links. | |
| #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. |