docs: Updates to the 12-factor tutorials
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates to the 12-factor tutorials and task.yaml files. Changes add context admonitions for rockcraft pack and skopeo copy commands, improve command formatting, and clarify the MicroK8s registry description. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #893 docs: Incorporate UX feedback into 12-factor tutorials | rockcraft | merged | Merged documentation updates incorporating UX feedback into 12-factor tutorials. Changes clarify skopeo usage, add file headers, correct Express and Spring Boot steps, and fix port values. All CI checks passed and reviewers approved the changes. | |
| #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. | |
| #2425 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged documentation updates to the 12-factor tutorials based on UX feedback. Changes include reordered setup steps, improved upload phrasing, added command blocks, and updated next steps links. Approved and passed CI. | |
| #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. | |
| #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. |