← Back to issue list

docs: Incorporate UX feedback into 12-factor tutorials

View original Github issue

Metadata

Project
rockcraft
Number
#1006
Type
pull request
State
merged
Author
erinecon
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #1006 in commit 9aec04c7, clarifying VM command context, terminal shutdown, and rockcraft pack overwriting when rock versions are unchanged.

Resolution: closed resolved

Reason: PR #1006 was approved and merged as commit 9aec04c7. The eight-file update incorporated UX feedback into the 12-factor tutorials.

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 a sentence to make it clear that, once we shell into the VM, all further instructions happen within the VM unless stated otherwise. * Update the instructions for closing the app to also include a note about closing the second terminal. * Update the admonition block about updating the rock version to make it clearer that `rockcraft pack` will overwrite the image if we don't update the version in the project file. - [X] Have you followed the guidelines for contributing? - [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `make lint && make test`? I ran `make lint && make test`, and they were not successful, but for reasons unrelated to this PR. ---

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #1006 in commit 9aec04c7, clarifying VM command context, terminal shutdown, and rockcraft pack overwriting when rock versions are unchanged.
stealth/space-bunny-alpha — closed resolved Merged PR #1006 as 9aec04c7, clarifying VM context, second-terminal cleanup, and image-overwrite behavior across eight 12-factor tutorial files.
stealth/space-bunny-alpha — closed resolved Merged UX documentation improvements for the 12-factor tutorials: clarified VM command context, closing the second terminal, and image overwriting with rockcraft pack.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes clarify VM shell usage, terminal closing steps, and rockcraft version warnings. Approved and merged.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
86%
#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.
82%
#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).
79%
#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.
79%
#1253 docs: Incorporate user feedback in the 12-factor reference pages rockcraft merged Docs PR #1253 merged as commit 176cba44 into rockcraft main, applying UXR feedback to 12-factor reference pages (headings, parts snippets, include/exclude guidance, captions, acronym clarifications).
78%
#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.
78%
#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.
78%
#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.
77%
#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.
77%
#2282 docs: Updates to the 12-factor tutorials charmcraft merged Merged PR #2282 as commit 2199bc08, updating four 12-factor tutorials with Rockcraft context, expanded Skopeo guidance, and clearer MicroK8s registry wording.
76%