Docs: Updated 12-factor tutorials
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| 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, and refining tutorial language. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2241 Docs: Update 12-factor tutorials | charmcraft | merged | Merged documentation updates to the 12-factor tutorials. Changes add UX tips for charmcraft and juju status, update rockcraft output, note faster builds, and condense architecture text. Approved by two reviewers and passed CI. | |
| #2282 docs: Updates to the 12-factor tutorials | charmcraft | merged | Merged documentation updates to the 12-factor tutorials and task files. Changes include added rockcraft admonitions, clarified skopeo copy options, and updated the MicroK8s registry description. Approved and passed CI checks. | |
| #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. | |
| #735 Update 12-factor docs | rockcraft | merged | Merged documentation update migrating 12-factor Charm SDK guides to Rockcraft. Revised tutorial language and updated dev requirements to fix a failing security test. Approved by three reviewers and successfully 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. | |
| #1006 docs: Incorporate UX feedback into 12-factor tutorials | rockcraft | merged | Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes clarify VM shell instructions, terminal closing steps, and rockcraft version warnings. Approved by two reviewers and passed CI checks. | |
| #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. | |
| #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. | |
| #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. | |
| #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. |