← Back to issue list

docs: Incorporate UX feedback into 12-factor tutorials

View original Github issue

Metadata

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

Current evaluation

Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes clarify architecture, update multi-arch commands, refine terminology, and adjust setup. Approved by three reviewers and merged.

Suggested action:

No scores available.

Issue body

Incorporate feedback from UX sessions into the 12-factor tutorials. ### Summary of changes * cat rockcraft.yaml and update the architecture * when updating the version, show a snippet of rockcraft.yaml to make it explicit * Intro to the initial Rockcraft section explaining a rock better * Make Multipass much more mandatory in the language * More explanation in the setup section – copied over the text about Rockcraft * Add the $(dpkg --print-architecture)where applicable to make the commands accessible to all architectures * Emphasize-lines in code blocks where appropriate (didn’t see anything) * Moved the LXD/Docker warning to the first pack attempt, and added another potential clue in the output * Improved product terminology (removed code formatting for `npm` and `go` instances, converted some of the profile mentions to plain text, updated the Spring Boot tutorial title in the navigational menu) - [X] Have you followed the guidelines for contributing? - [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `make lint && make test`? --- Successfully ran `make lint-docs`

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes clarify architecture, update multi-arch commands, refine terminology, and adjust setup. Approved by three reviewers and merged.
qwen3.6-35b-a3b-mtp-q6 Merged documentation updates to the 12-factor tutorials based on UX feedback. Changes include clarified architecture, cross-architecture commands, updated terminology, improved setup instructions, and relocated LXD/Docker warnings.
qwen3.6-35b-a3b-mtp-q6 Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Changes clarify commands, add cross-architecture support, improve setup instructions, adjust terminology, and reposition warnings. Lint checks passed.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#2455 docs: Incorporate UX feedback into 12-factor tutorials charmcraft merged 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.
95%
#2445 docs: Incorporate UX feedback into 12-factor tutorials charmcraft merged Merged documentation updates to the 12-factor tutorials incorporating UX feedback. Edits clarify resources, ingress context, phrasing, environment variables, and database timing. Approved by two reviewers and passed CI checks.
94%
#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.
93%
#2387 docs: Incorporate UX feedback into 12-factor tutorials charmcraft merged 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.
93%
#956 docs: Incorporate UX feedback into 12-factor tutorials rockcraft merged Merged documentation updates to 12-factor tutorials incorporating UX feedback. Corrects browser instructions, reorganizes commands, adds experimental extension variables, updates next steps, and adds intersphinx links. Approved by two reviewers and passed CI.
93%
#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.
92%
#2463 docs: Incorporate UX feedback into 12-factor tutorials charmcraft merged 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.
90%
#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.
90%
#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.
88%
#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.
85%