← 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

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.

Suggested action: needs review

Reason: The PR is inactive (last activity 203 days ago, 0 comments, no reviewers) but the change is still applicable: docs/explanation/pebble.rst at HEAD still contains the old link '.. _Pebble: https://github.com/canonical/pebble' and issue #737 remains open. As a trivial 2-line docs fix it needs only a quick maintainer review; the failing snap-tests check is implausible for a .rst-only diff and likely flaky.

Impact: 10 Quick Win: 9.5 Staleness: 65 Complexity: 5 Confidence: 85

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
qwen/qwen3.8-27b
Impact: 10
Quick Win: 9.5
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 5
Confidence: 80
needs review Updates links to the new Pebble documentation page and fixes minor spelling errors. The pull request has been inactive for 126 days, lacks comments, and requires the author to run lint and test checks before triage.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/rockcraft#737 (confidence 90%)

    PR body states 'This partially addresses #737' (doc: use the Pebble docs), which is still open; the old GitHub-repo link persists in docs/explanation/pebble.rst at HEAD.

Related issues

Issue Project State Summary Similarity
#847 docs: update pebble page and add references to pebble docs rockcraft open Docs-only PR updating the Pebble explanation page to reference official Pebble docs and cross-linking Pebble mentions on other pages (7 files, +21/-20). Review requested changes 263 days ago; author never responded; same goal pursued in newer PR #1058.
83%
#737 doc: use the Pebble docs rockcraft open Doc improvement to reshape the Pebble explanation page to rely on official Pebble docs. Intersphinx mapping updated to new Pebble docs URL, but the page's main Pebble link still points to GitHub and the page hasn't been reshaped.
79%
#327 docs: rewrite the explanation section rockcraft merged Merged documentation rewrite detailing Pebble, chisel, rocks, and overlay-step explanations. Resolved issues #337 and #348 and corrected broken documentation header styling.
78%
#304 Pebble doc and test updates rockcraft merged Merged updates to Pebble documentation and spread tests. Fixed formatting issues and aligned content with recent Pebble features like --args. Approved by three reviewers and passed CI checks across ten files.
76%
#779 Update link to Pebble layer specification rockcraft merged Merged updates to the Pebble layer specification documentation, redirecting links to the new official docs site. Approved by two reviewers across six modified files.
73%
#310 docs: fix url of rockcraft format rockcraft merged Merged a documentation fix correcting a broken URL in convert-to-pebble-layer.rst, resolving a linkcheck failure. Approved by two reviewers, passed CI, and modified one file.
72%