← Back to issue list

docs: tutorial is publishing old code

View original Github issue

Metadata

Project
snapcraft
Number
#5996
Type
issue
State
open
Author
medubelko
Labels
Type: Bug Type: Documentation
Created
Updated
Closed
—

Current evaluation

Docs-publishing bug: tutorial patch (PR #5929) merged to hotfix branches but not reflected on the 8.13.2/8.14.0 documentation site. Root cause is in the external publishing pipeline; tutorial content since rewritten.

Suggested action: close stale

Reason: The reported symptom depends on the external documentation-publishing pipeline (documentation.ubuntu.com), not on this repository, and the exact content cited (repeated terminal directives in craft-a-snap.rst) no longer exists: the tutorial was rewritten via #6231 and #6316, and 'Pack the snap' at current HEAD uses a spread-tested '.. literalinclude:: code/craft-a-snap/task.yaml' with ':start-at: snapcraft pack'. Nothing further can be fixed in-repo, and there have been no comments or updates for 245 days.

Evaluated by: mr-cal-bot

Impact: 12 Quick Win: 0 Complexity: 85 Confidence: 78 Actionability: 20

Issue body

### Check existing issues - [x] I've verified that this request isn't described by any existing issues. ### Request In December I [patched](https://github.com/canonical/snapcraft/pull/5929) the tutorial in `hotfix/8.13` to remove multiple instances of the terminal directive. Neither 8.13.2 nor 8.14.0 published this change. Other doc changes, like the 8.14 release notes, were. `hotfix/8.14` code: https://github.com/canonical/snapcraft/blob/89f77e6f8b2b382ed17c9bec5245b4a60569a10d/docs/tutorials/craft-a-snap.rst?plain=1#L242 Result: https://documentation.ubuntu.com/snapcraft/8.14.0/tutorials/craft-a-snap/#pack-the-snap ### Document location https://documentation.ubuntu.com/snapcraft/8.14.0/tutorials/craft-a-snap/#pack-the-snap

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 12
Quick Win: 0
Complexity: 85
Confidence: 78
Actionability: 20
close stale Docs-publishing bug: tutorial patch (PR #5929) merged to hotfix branches but not reflected on the 8.13.2/8.14.0 documentation site. Root cause is in the external publishing pipeline; tutorial content since rewritten.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 14
Complexity: 20
Confidence: 70
Actionability: 60
needs triage Tutorial documentation not published after PR #5929 merged; changes missing from 8.13.2 and 8.14.0 docs site. No maintainer response after 233 days.
qwen/qwen3.8-27b
Impact: 30
Quick Win: 18
Staleness: 75
Complexity: 40
Confidence: 55
Support Request: 10
needs triage Docs publishing pipeline failed to include PR #5929 terminal-directive changes in 8.13.2 and 8.14.0 releases; tutorial on main has since been substantially reworked, no maintainer response in 214 days
qwen/qwen3.6-35b-a3b
Staleness: 80
Complexity: 15
Confidence: 70
Support Request: 5
close stale Documentation publishing pipeline failed to apply a December patch to the tutorial, leaving 8.13.2 and 8.14.0 docs outdated. Unresolved after 173 days of inactivity.
qwen3.6-35b-a3b-mtp-q6
Staleness: 80
Complexity: 30
Confidence: 85
Support Request: 10
needs triage Documentation publishing pipeline failed to apply a December patch to the 8.13.2 and 8.14.0 tutorial, leaving outdated code on the live docs site. Issue remains unaddressed after 159 days with no maintainer comments or assignee.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/snapcraft#5929 (confidence 90%)

    PR 5929 (commit 01356fc85 'docs: adjust wording and terminal text in tutorial') is the patch whose changes the issue reports were not published.

  • Likely Fixed By: canonical/snapcraft#6316 (confidence 62%)

    Commit e8a53bfb5 'docs: improve tutorial based on user testing' rewrote the Pack the snap section to a literalinclude, removing the terminal-directive content cited in this report; #6231 (d8844f400) did further tutorial rework.

Related issues

No related issues found above the similarity threshold.