docs: Updates to the 12-factor tutorials
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
Six updates proposed by @evildmp in https://github.com/canonical/charmcraft/issues/2235 that affect all four of the 12-factor tutorials.
### Summary of changes
* Added a brief explanation of a rock at the beginning of the rock sections.
* (Django tutorial) Before packing the rock, added a note that explains that the user can no longer run or test the app locally due to the changes we made in preparing the app for a PostgreSQL database.
* (FastAPI and Go tutorials) Changed some instances of the mechanical instruction "open" to a functional action "edit" for updating the `charmcraft.yaml` file. This also establishes consistency with the corresponding rock sections.
* Added a `seealso` box to `charmcraft pack` to provide more context to the user.
* Added a brief explanation of a Juju model at the beginning of the deploy section.
* (Django tutorial) When setting the `django-debug` configuration, added more information in the note admonition that this configuration sets an environment variable in the Django app. This gives the user a way to connect the Juju-specific command with a familiar concept.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates to four 12-factor tutorials. Changes add rock and Juju model explanations, update instructions for consistency, include a charmcraft pack seealso box, and clarify Django config notes. Approved and merged. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates for four 12-factor tutorials. Changes clarify rock and Juju model concepts, standardize instructions, note Django local testing limits, add a charmcraft pack seealso box, and clarify Django configuration. |
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. | |
| #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. | |
| #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. | |
| #2354 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged documentation updates to 12-factor tutorials based on UX feedback. Changes include switching code blocks to dropdowns, adding explicit paths, and clarifying MicroK8s and Juju setup. Approved by two reviewers and merged after CI validation. | |
| #2251 Docs: Updated 12-factor tutorials | charmcraft | merged | 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. | |
| #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. | |
| #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. | |
| #2445 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Edits clarify resources, ingress context, phrasing, environment variables, and database timing. Approved by two reviewers and passed CI checks. | |
| #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. |