docs: Redo in-page links for: Mange charm revisions, Manage the current charmhub user, and Manage tracks
Metadata
Current evaluation
Docs-only PR merged as commit 5f3d7908: reworked in-page links (block references into main text) and added intro sentences in manage-revisions, manage-the-current-charmhub-user, and manage-tracks how-to guides; approved by 2 reviewers.
Resolution: closed resolved
Reason: The PR itself was merged into main as commit 5f3d7908, changing 3 docs files (+34/-59). Reviewer medubelko approved it and activus-d addressed the minor feedback before merge.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This PR fixes the in-page links for some pages in the How to guides section of the documentation by moving single-link block references into the main text. It also adds introductory sentences to some sections to make the docs more user friendly.
This is the `#4` in a series of PRs addressing [Open Documentation Academy issue #302](https://github.com/canonical/open-documentation-academy/issues/302).
## Docs pages covered
* [Manage charm revisions](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-revisions.rst)
* [Manage the current Charmhub user](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-the-current-charmhub-user.rst)
* [Manage tracks](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-tracks.rst)
## Note
Skipped the [Manage parts](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-parts.rst) docs as it currently contains `TBA (To Be Added)` placeholders.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Docs-only PR merged as commit 5f3d7908: reworked in-page links (block references into main text) and added intro sentences in manage-revisions, manage-the-current-charmhub-user, and manage-tracks how-to guides; approved by 2 reviewers. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in #2601 (commit 5f3d7908), fixing in-page links and adding introductions to three Charmcraft how-to guides on charm revisions, Charmhub users, and tracks. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update fixing in-page links and adding introductory sentences to three how-to guides. Reviewer feedback was implemented before merge, completing a series for the Open Documentation Academy. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates for managing charm revisions, Charmhub user, and tracks. In-page links were integrated into main text and introductory sentences added. Reviewer feedback was implemented prior to merge. Addresses Open Documentation Academy issue #302. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/charmcraft#2575
(confidence 90%)
Earlier PR in the same docs series doing the same in-page link rework for other 'manage' how-to guides (commit 96c6342e)
-
Related To:
canonical/charmcraft#2534
(confidence 85%)
First PR in the series reformatting in-page links in tutorials (commit 04cc6d5d)
-
Related To:
open-documentation-academy#302
(confidence 70%)
External tracking issue for the overall in-page link effort; this PR is item #4 in that series
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2553 Redo in-page links for: Manage channels, Manage Charmcraft, and Manage charms in How to guides | charmcraft | open | Rewrites in-page 'See more:' block refs into main text for manage-channels, manage-charmcraft, and manage-charms how-to guides. Approved, 14 unresolved comments, idle 237 days; the three files have since been heavily reworked, so a rebase is likely needed. | |
| #2575 docs: redo in-page links in 'manage' how-to guides | charmcraft | merged | Docs PR merged as commit 96c6342e: reworked in-page links (moving single-link block references into prose) and added intro sentences across 5 manage how-to guides; manage-parts skipped for TBA placeholders. | |
| #2262 docs: hotfix for links syntax for charm docs examples | charmcraft | merged | Merged PR #2262 as commit 675e5e7e, fixing links in the Manage charms docs and adding a Charmhub Discourse link. | |
| #2748 docs: improve charm naming docs, with links to detailed guidance | charmcraft | merged | Docs PR #2748 merged (commit 0389aeb4): rewrote charm naming guidance in the charmcraft.yaml reference and manage-charms how-to, replacing inline best-practice notes with links to the Ops docs. Fixes #2582; relied on canonical/operator#2610. | |
| #2128 docs: add anchors and fix a few small things | charmcraft | merged | Docs PR merged as commit e880b4bd: added intersphinx anchors (e.g. _manage-charms, _initialise-a-charm) for Ops/Juju linking, retitled 'Set up Charmcraft' to 'Manage Charmcraft', expanded content, and fixed a rendering error. | |
| #2300 docs: update "manage configurations" | charmcraft | merged | Docs PR #2300 merged as commit dc4bedb1: updated Charmcraft links to operator's renamed "Manage configuration" howto and renamed the section heading to "Manage the app configuration" per maintainer request. |