← Back to issue list

docs: Incorporate UX feedback into 12-factor tutorials

View original Github issue

Metadata

Project
charmcraft
Number
#2387
Type
pull request
State
merged
Author
erinecon
Labels
—
Created
Updated
Closed

Current evaluation

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).

Resolution: closed resolved

Reason: The PR itself was merged into main in commit 6368b845 with approved review and all CI checks passing, delivering the four documented changes to the tutorials (ISD-3539/3541/3544/3580/3581).

Evaluated by: mr-cal-bot

No scores available.

Issue body

Relevant tickets: ISD-3539, ISD-3544, ISD-3541, ISD-3580, ISD-3581 Four changes to the 12-factor tutorials based on feedback from UX sessions. ### Summary of changes * Add more introduction to the "Deploy" section, drawing the user's attention to what they've already done (packed rock and charm) and what they're about to do (deploy the app with Juju) * Add "Verify app" and "Destroy app" subsections during the "Run the app locally" section. This change addresses UX participants missing instructions to close their second terminal when testing the app. * Add an "achievements" section at the end of the tutorial to draw the user's attention to everything they did in the tutorial. * Fix the spelling of PostgreSQL in an admonition in the FastAPI tutorial.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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).
stealth/space-bunny-alpha — closed resolved Merged charmcraft#2387 in commit 6368b845, applying UX feedback to the 12-factor tutorials: deploy guidance, local app verification and cleanup, achievements, and PostgreSQL spelling.
stealth/space-bunny-alpha — closed resolved Merged PR #2387, updating 12-factor tutorials with UX feedback: deploy guidance, app verification and cleanup steps, an achievements section, and PostgreSQL spelling.
qwen/qwen3.6-35b-a3b — — Merged documentation updates to the 12-factor tutorials based on UX feedback. Changes add a deploy intro, verify and destroy subsections, an achievements section, and fix PostgreSQL spelling. Approved by two reviewers with all CI checks passing.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes include a Deploy section intro, Verify and Destroy app subsections, an achievements section, and a PostgreSQL spelling fix.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/charmcraft#2354 (confidence 85%)

    Earlier PR with the same title; another UX-feedback iteration on the same tutorials (commits d6fe569c, 06ec43fb)

  • Related To: canonical/charmcraft#2425 (confidence 80%)

    Successive PR titled 'Incorporate UX feedback into 12-factor tutorials' (commit 17ce91b5)

  • Related To: canonical/charmcraft#2445 (confidence 80%)

    Follow-up UX-feedback PR on the same tutorials (commit 787f82c4)

  • Related To: canonical/charmcraft#2455 (confidence 80%)

    Follow-up UX-feedback PR on the same tutorials (commit d31736f1)

  • Related To: canonical/charmcraft#2463 (confidence 80%)

    Follow-up UX-feedback PR on the same tutorials (commit 2820be49)

Related issues

Issue Project State Summary Similarity
#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.
91%
#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.
91%
#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.
90%
#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.
90%
#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.
87%
#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.
87%
#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.
86%
#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.
81%
#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.
79%
#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.
78%