Docs: Tutorial setup maintenance
Metadata
Current evaluation
Merged in canonical/rockcraft#827 (commit be7862f8): tutorial setup docs split into two files by Rockcraft channel (latest/edge) and Docker steps split so `newgrp` no longer breaks copy/paste of the block.
Resolution: closed resolved
Reason: The PR itself was merged into main as commit be7862f8 with 3 approving reviewers, delivering both documentation changes it described (channel-split tutorial setup file, and separated Docker command blocks).
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/rockcraft#827 (commit be7862f8): tutorial setup docs split into two files by Rockcraft channel (latest/edge) and Docker steps split so `newgrp` no longer breaks copy/paste of the block. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/rockcraft#827 via be7862f8, splitting tutorial setup by Rockcraft channel and separating Docker commands so newgrp no longer interrupts copy/paste. | |
| 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. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/rockcraft#1331
(confidence 35%)
Later commit 62412612 further maintained the same tutorial setup file (recommend nano over vi).
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #236 docs: add tutorial | rockcraft | merged | Merged in canonical/rockcraft#236, adding a five-file tutorial on migrating the .NET Runtime 6.0 Docker image to a Chiselled ROCK. | |
| #123 add how-to guide for "building docs" | rockcraft | closed | Added a guide for building Rockcraft documentation locally in PR canonical/rockcraft#126, merged as commit 68a7abda. | |
| #2251 Docs: Updated 12-factor tutorials | charmcraft | merged | Merged as canonical/charmcraft#2251 (commit 592d93aa), updating 12-factor setup instructions to use Rockcraft latest/edge, simplify file creation, and remove outdated warnings and wording. | |
| #326 docs: tutorial for convert rocks to docker image | rockcraft | closed | Closed unmerged after a maintainer said the proposed .rock-to-Docker tutorial was redundant with instructions already present in existing guides. |