← Back to issue list

docs: update pebble page and add references to pebble docs

View original Github issue

Metadata

Project
rockcraft
Number
#847
Type
pull request
State
open
Author
alesancor1
Labels
Type: Documentation
Created
Updated
Closed
—

Current evaluation

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.

Suggested action: close superseded

Reason: Merged PR #983 (commit 61912eba "docs: update links") already reworked the Pebble links in docs/explanation/pebble.rst, and newer open PR #1058 covers the remaining delta (retargeting the `Pebble` link from the canonical/pebble repo to the official docs) in a much smaller diff — the current file still shows `.. _Pebble: https://github.com/canonical/pebble`, confirming only that narrow part is outstanding. With review status changes_requested, 2 unresolved comments, and no activity for ~295 days from an external contributor, this PR has been overtaken.

Evaluated by: mr-cal-bot

Impact: 15 Quick Win: 2 Complexity: 20 Confidence: 62 Actionability: 15

Issue body

- [x] Have you followed the guidelines for contributing? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `make lint && make test`? --- This PR adds references to [pebble docs](https://documentation.ubuntu.com/pebble/) in the Pebble page inside rockcraft documentation. This page only keeps the information from pebble related to container images and rocks. Additionally, other pages have been modified so when Pebble is mentioned it links to the pebble page. --- See built page here: (waiting CI)

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 15
Quick Win: 2
Complexity: 20
Confidence: 62
Actionability: 15
close superseded 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.
qwen/qwen3.6-35b-a3b
Impact: 15
Quick Win: 3
Complexity: 10
Confidence: 75
Actionability: 20
close stale Documentation PR updating Pebble page references and adding links to official Pebble docs. Has 2 unresolved review comments and has been inactive for 282 days.
qwen/qwen3.8-27b
Impact: 20
Quick Win: 18
Staleness: 75
Complexity: 10
Confidence: 80
close stale 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.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 10
Confidence: 90
close stale Updates documentation to add references to external Pebble docs and links other pages to the Pebble page. Currently marked changes_requested with 2 unresolved review comments and no recent activity.
qwen3.6-35b-a3b-mtp-q6
Staleness: 70
Complexity: 10
Confidence: 85
close stale Updates rockcraft documentation to add cross-references and links to external pebble docs. Currently inactive for over six months with no maintainer feedback or CI status.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 10
Confidence: 85
close stale Updates Pebble documentation with external references and internal cross-links. Currently inactive for over a year with no maintainer feedback or CI results.

Update history

No update history recorded yet.

Related work

  • Superseded By: canonical/rockcraft#983 (confidence 80%)

    Merged as 61912eba; git history for docs/explanation/pebble.rst shows it updated Pebble links and internal Sphinx references already.

  • Related To: canonical/rockcraft#1058 (confidence 75%)

    Newer, narrower open PR (+2/-2) changing the Pebble hyperlink target in docs/explanation/pebble.rst plus two typo fixes; partially addresses #737.

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

    Tracking issue 'doc: use the Pebble docs' is still open and the same goal is being pursued by #1058.

  • Related To: canonical/rockcraft#779 (confidence 60%)

    Merged as f5532efe, previously updated the link to the Pebble layer specification in the same file — same class of link churn.

Related issues

Issue Project State Summary Similarity
#1058 docs: referencing Pebble documentation rockcraft open 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.
84%
#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%
#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.
76%
#779 Update link to Pebble layer specification rockcraft merged Docs-only PR merged in commit f5532efe, updating six rockcraft files (README, rockcraft/pebble.py, schema/rockcraft.json, docs) to point at Pebble's new Read the Docs layer specification URL instead of the old wiki link.
74%
#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.
74%
#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.
72%