docs: Incorporate UX feedback into 12-factor tutorials
Metadata
Current evaluation
Merged PR #2463 updated 12-factor tutorials with experimental-channel guidance, reordered LXD setup, and clarified that subsequent commands run inside the VM.
Resolution: closed resolved
Reason: PR #2463 was approved and merged as commit 2820be49, incorporating UX feedback into two documentation files.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Relevant ticket: ISD-3531
Three changes to the setup instructions for the 12-factor tutorials based on feedback from UX sessions.
### Summary of changes
* Add an admonition box about experimental extensions, warning users that they need to install `latest/edge` of Charmcraft and Rockcraft.
* Rearrange the LXD setup instructions to check whether LXD is installed, install LXD if not installed, and then initialize LXD.
* Add a sentence to make it clear that, once we shell into the VM, all further instructions happen within the VM unless stated otherwise.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2463 updated 12-factor tutorials with experimental-channel guidance, reordered LXD setup, and clarified that subsequent commands run inside the VM. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged documentation PR canonical/charmcraft#2463, adding an experimental-extensions warning, reordering LXD setup, and clarifying that commands run inside the VM. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update incorporating UX feedback into 12-factor tutorials. Changes add an experimental extensions warning, restructure LXD setup steps, and clarify VM shell context. Approved by two reviewers and passed CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates to the 12-factor tutorials based on UX feedback. Updates add an experimental extension warning, restructure LXD setup steps, and clarify VM shell context for subsequent instructions. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #918 docs: Incorporate UX feedback into 12-factor tutorials | rockcraft | merged | Merged PR #918 as ddb5bbba, updating the 12-factor tutorials with UX feedback on architecture, setup, Multipass, multi-architecture commands, pack warnings, and terminology. | |
| #2445 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged PR #2445 as commit 787f82c4, updating six 12-factor tutorial files with UX feedback on resources, ingress, configuration, wording, and PostgreSQL setup. | |
| #2455 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Docs-only PR merged to main as commit d31736f1, applying UX-session feedback (ISD-4286) to the 12-factor tutorials: reworded the project-directory cleanup step, removed explicit cd commands, and moved code-block comments into prose. | |
| #2387 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Docs-only PR merged (commit 6368b845): applied UX session feedback to the 12-factor tutorials — added Deploy intro, Verify/Destroy app steps, an achievements section, and a PostgreSQL spelling fix (+125/-81, 5 files). | |
| #956 docs: Incorporate UX feedback into 12-factor tutorials | rockcraft | merged | Docs-only PR merged as commit c28f1197:12-factor tutorials updated with UX feedback — corrected browser visit instructions, Express 'cd ..' moved into the init rock block, FastAPI experimental extension env var, expanded Next steps, and intersphinx links in conf.py. | |
| #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. | |
| #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. | |
| #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. | |
| #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. |