Docs: Tutorial setup maintenance
Metadata
Current evaluation
Merged documentation update splitting the tutorial setup file by Rockcraft channel requirements. Fixes a Docker setup bug by separating commands into two blocks, preventing the newgrp command from interrupting copy-paste execution. Approved and passed CI.
Suggested action: —
No scores available.
Issue body
- [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
---
Two maintenance-related changes to the tutorial setup file.
1. Split up the reusable tutorial setup file into two based on whether the tutorial requires the `latest/edge` channel of Rockcraft.
2. Fix a bug in the setup instructions pertaining to Docker. Currently, the Docker setup code block looks like this:
```
sudo addgroup --system docker
sudo adduser $USER docker
newgrp docker
sudo snap disable docker
sudo snap enable docker
```
However, the `newgrp` command will open a new shell session. The `disable` and `enable` commands won't run if the user copies and pastes the entire command block. The fix splits up the command block into two different blocks so copying/pasting the whole block will work.
Additional reviewers: @jdkandersson
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update splitting the tutorial setup file by Rockcraft channel requirements. Fixes a Docker setup bug by separating commands into two blocks, preventing the newgrp command from interrupting copy-paste execution. Approved and passed CI. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates that split the tutorial setup file by Rockcraft channel. Fixed a Docker command block by separating commands to prevent newgrp from interrupting copy-paste execution. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update splitting the tutorial setup file by Rockcraft channel requirement and fixing a Docker command block bug that interrupted shell execution when copied and pasted. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #323 docs: Add explanation on the Hello-world tutorial | rockcraft | merged | Merged documentation update explaining the rockcraft.yaml file in the Hello World tutorial. Approved by three reviewers, the change adds 26 lines and removes 9 across two files. | |
| #105 docs: add commands | rockcraft | merged | Merged documentation adding rockcraft commands, resolving issue #101. After initial review requested changes, the maintainer coordinated with reviewers and merged the first draft. | |
| #236 docs: add tutorial | rockcraft | merged | Merged a tutorial documenting the migration of a .NET Runtime 6.0 Docker image into a Chiselled ROCK. Approved by three reviewers, the change adds 414 lines across five files. | |
| #2251 Docs: Updated 12-factor tutorials | charmcraft | merged | Merged documentation updates for the 12-factor tutorials. Changes include switching to the latest Rockcraft edge channel, removing outdated warnings, simplifying file creation, and refining wording across six files. Approved and merged. | |
| #360 docs: add a hello-craft-parts tutorial | craft-parts | merged | Merged. Added a hello-craft-parts tutorial to the documentation, templated from rockcraft docs and prepared for spread testing. Review approved, with minor linting issues resolved in a separate PR before final merge. | |
| #1066 docs: updating homepage to new requirements | rockcraft | merged | Merged after reviewer approval and passing all CI checks. Updated the Rockcraft documentation homepage to match 26.04 template requirements, adding structured sections and improved navigation. Minor link checker warnings were noted and accepted. | |
| #283 docs: split rock explanation into its own document | rockcraft | merged | Merged documentation update splitting the rock explanation into a dedicated document, addressing issue #275. Approved by two reviewers, modified nine files, and enabled ReadTheDocs preview generation for all pull requests. | |
| #1064 fix: hello world tutorial output | rockcraft | merged | Merged fix removing outdated rockcraft pack output from the hello world tutorial, resolving issue 899. Approved by two reviewers and passed CI. Deletes 22 lines from one documentation file. |