docs: Incorporate UX feedback into 12-factor tutorials
Metadata
Current evaluation
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.
Resolution: closed resolved
Reason: The PR was merged into main with commit d31736f1 ("docs: Incorporate UX feedback into 12-factor tutorials (#2455)") after 2 approving reviews; the 8 changed files are tutorial docs, and the two failing checks (macos-13 fast tests, typecheck-with-ty) are unrelated to documentation. Follow-up UX-feedback PRs in the same series (#2445, #2463) were also merged as commits 787f82c4 and 2820be49.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Relevant ticket: ISD-4286
Three changes to the 12-factor tutorials based on feedback from UX sessions.
### Summary of changes
* Update the phrasing of the project directory in the cleanup section.
* Remove the explicit commands to `cd` throughout the tutorials.
* Update the setup instructions to move code-block comments into the main text.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | 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. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in charmcraft#2455, updating the 12-factor tutorials with UX feedback: refined directory wording, removed explicit cd commands, and moved code-block comments into prose. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #2455, incorporating UX feedback into the 12-factor tutorials by refining directory phrasing, removing explicit cd commands, and moving code-block comments into the main text. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes refine directory phrasing, remove explicit cd commands, and relocate code comments to main text. Approved by two reviewers and merged. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes refine cleanup phrasing, remove explicit cd commands, and move code comments to main text. Resolves ISD-4286. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/charmcraft#2463
(confidence 80%)
Follow-up UX-feedback pass on the same tutorials (experimental channel, LXD setup, VM command context); merged as 2820be49.
-
Related To:
canonical/charmcraft#2445
(confidence 78%)
Same UX-feedback series applied to other parts of the 12-factor tutorials (resources, ingress, config, database setup); merged as 787f82c4.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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). | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #2463 docs: Incorporate UX feedback into 12-factor tutorials | charmcraft | merged | Merged PR #2463 updated 12-factor tutorials with experimental-channel guidance, reordered LXD setup, and clarified that subsequent commands run inside the VM. | |
| #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. |