docs: Updates to the 12-factor tutorials
Metadata
Current evaluation
Merged PR #2282 as commit 2199bc08, updating four 12-factor tutorials with Rockcraft context, expanded Skopeo guidance, and clearer MicroK8s registry wording.
Resolution: closed resolved
Reason: PR #2282 was approved and merged into the main branch as commit 2199bc08. Its changes were incorporated into all four tutorials and implemented two requested updates from issue #2235.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Three updates proposed by @evildmp (two updates in https://github.com/canonical/charmcraft/issues/2235 plus one other) that affect all four tutorials and their `task.yaml` files.
### Summary of changes
* Added an admonition for `rockcraft pack` to provide more context to the user.
* Provided more information for the `rockcraft.skopeo copy` command to give a better sense of what each of the options and tags are doing. Updated the `task.yaml` files so that the command appears over more lines, and changed the `seealso` admonition to a `note` block to provide a brief description of each part while also including the external link.
* Updated the description of the MicroK8s registry to describe the registry as a temporary Dockerhub.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2282 as commit 2199bc08, updating four 12-factor tutorials with Rockcraft context, expanded Skopeo guidance, and clearer MicroK8s registry wording. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in charmcraft#2282 as 2199bc08, updating all four 12-factor tutorials and task files with Rockcraft pack guidance, clearer Skopeo options, and a temporary MicroK8s registry description. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in charmcraft#2282 (2199bc08), updating all four 12-factor tutorials and task files with Rockcraft pack guidance, clearer Skopeo copy options, and a temporary MicroK8s registry description. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates to the 12-factor tutorials and task.yaml files. Changes add rockcraft command admonitions, clarify skopeo copy options, and update the MicroK8s registry description to clarify its temporary Docker Hub role. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/charmcraft#2235
(confidence 98%)
Source issue for two tutorial-feedback items implemented by PR #2282.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #1006 docs: Incorporate UX feedback into 12-factor tutorials | rockcraft | merged | Merged PR #1006 in commit 9aec04c7, clarifying VM command context, terminal shutdown, and rockcraft pack overwriting when rock versions are unchanged. | |
| #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. | |
| #2354 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged UX-driven updates to the 12-factor tutorials: dropdown code snippets, explicit paths, and clearer MicroK8s and Juju setup commands. | |
| #893 docs: Incorporate UX feedback into 12-factor tutorials | rockcraft | merged | Merged as 9a40a4a3, updating 12-factor tutorials with clearer skopeo guidance, file headers, and corrected Express and Spring Boot setup instructions. | |
| #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. | |
| #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. |