← Back to issue list

docs: referencing Pebble documentation

View original Github issue

Metadata

Project
rockcraft
Number
#1058
Type
pull request
State
open
Author
asanvaq
Labels
—
Created
Updated
Closed
—

Current evaluation

Docs-only: updates the Pebble hyperlink target in docs/explanation/pebble.rst from the GitHub repo to the official Pebble docs, plus two typo fixes (+2/-2). Partially addresses #737; open 286 days, no reviewers or comments.

Suggested action: needs review

Reason: Tiny, self-contained docs diff (+2/-2, 1 file) with all doc/lint checks passing ('lint / files' green) and no unresolved review comments, so it is ready for a maintainer to look at. It only partially closes the referenced issue: docs/tutorial/node-app.rst still defines '.. _`Pebble`: https://github.com/canonical/pebble', so #737 correctly remains open. Docking actionability slightly: no reviewer has looked at it in 234 days, 'snap-tests' appears in both the passing and failing CI lists, and I could only see the current HEAD (link still pointing at github.com/canonical/pebble), not the PR's exact replacement URL.

Evaluated by: mr-cal-bot

Impact: 15 Quick Win: 9 Complexity: 5 Confidence: 74 Actionability: 62

Issue body

This partially addresses #737. The Pebble page used to lead users to the GitHub repo. There is now a documentation page for Pebble, so I have updated this accordingly. I have also fixed some minor spelling issues. --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/rockcraft/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [ ] I've successfully run `make lint && make test`. - [ ] I've added or updated any relevant documentation.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 15
Quick Win: 9
Complexity: 5
Confidence: 74
Actionability: 62
needs review Docs-only: updates the Pebble hyperlink target in docs/explanation/pebble.rst from the GitHub repo to the official Pebble docs, plus two typo fixes (+2/-2). Partially addresses #737; open 286 days, no reviewers or comments.
qwen/qwen3.6-35b-a3b
Impact: 15
Quick Win: 6
Complexity: 5
Confidence: 70
Actionability: 40
needs review Updates Pebble documentation link from GitHub to official docs page, fixes minor spelling issues. Small doc change (+2/-2 lines) with failing snap-tests CI, no reviewer activity.
qwen/qwen3.8-27b
Impact: 10
Quick Win: 10
Staleness: 65
Complexity: 5
Confidence: 85
needs review Updates the Pebble link in docs/explanation/pebble.rst from the GitHub repo to the official Pebble documentation page, plus minor spelling fixes. 2-line change, unreviewed, CI mostly green with one unrelated snap-tests failure.
qwen/qwen3.6-35b-a3b
Staleness: 70
Complexity: 5
Confidence: 60
needs review Updates Pebble documentation link from GitHub to official docs and fixes minor spelling issues. Currently pending maintainer review with zero comments, though snap-tests CI is failing.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 5
Confidence: 75
close stale Updates Pebble link to point to official documentation instead of GitHub repo, fixes minor spelling issues. Currently inactive for ~5 months with no maintainer feedback or CI checks.
qwen3.6-35b-a3b-mtp-q6
Staleness: 70
Complexity: 10
Confidence: 75
close stale Updates Pebble documentation link from GitHub to official docs page and fixes minor spelling issues. PR has been inactive for ~5 months with no maintainer feedback or CI checks.

Update history

No update history recorded yet.

Related work

  • Related To: rockcraft#737 (confidence 95%)

    PR explicitly 'partially addresses #737' (doc: use the Pebble docs); issue is still open because other pages such as docs/tutorial/node-app.rst still link to the Pebble GitHub repo.

Related issues

Issue Project State Summary Similarity
#847 docs: update pebble page and add references to pebble docs rockcraft open Docs-only (+21/-20, 7 files): rewrites docs/explanation/pebble.rst to focus on container/rock info and links to official Pebble docs. Changes requested, 2 unresolved comments, idle ~295 days.
84%
#737 doc: use the Pebble docs rockcraft open Docs task: rework explanation/pebble.rst to lean on the official Pebble docs (readthedocs/ubuntu.com) instead of duplicating content and linking to the Pebble GitHub repo; partially addressed by #779 but the GitHub link remains.
80%
#983 docs: update links rockcraft merged Merged documentation cleanup that migrated Pebble links to intersphinx, converted internal links to Sphinx references, and refreshed redirected external URLs.
77%
#327 docs: rewrite the explanation section rockcraft merged Merged as 0e36ee79, rewriting docs for Pebble, Chisel, rocks, and overlay steps while restoring header styling and resolving #337 and #348.
76%
#304 Pebble doc and test updates rockcraft merged Merged PR #304 as commit 31700eaa, correcting Pebble documentation formatting and updating docs and spread tests for recent additions such as --args.
74%