← Back to issue list

docs: mention plugin differences in guide about managing icons

View original Github issue

Metadata

Project
charmcraft
Number
#2711
Type
pull request
State
merged
Author
dwilding
Labels
—
Created
Updated
Closed

Current evaluation

Merged guidance on plugin-specific icon handling in PR #2711 (commit 037c5b41), completing the documentation work for #2593.

Resolution: closed resolved

Reason: PR #2711 merged as commit 037c5b41 and updated the icon guide to explain plugin differences, including automatic inclusion by the charm plugin. This resolved the documentation gap tracked in #2593.

Evaluated by: mr-cal-bot

No scores available.

Issue body

This PR updates "Manage icons" to mention that there's a difference in how plugins treat the icon file. This continues (finishes?) work on https://github.com/canonical/charmcraft/issues/2593. Related work: https://github.com/canonical/operator/pull/2451. **[Preview docs](https://canonical-ubuntu-documentation-library--2711.com.readthedocs.build/charmcraft/2711/howto/manage-icons/#add-an-icon-to-its-charm-s-charmhub-page)** --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [x] I've successfully run `make lint && make test`. - [x] I've added or updated any relevant documentation. - [x] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [ ] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged guidance on plugin-specific icon handling in PR #2711 (commit 037c5b41), completing the documentation work for #2593.
stealth/space-bunny-alpha — closed resolved Merged in charmcraft#2711: updated Manage icons docs to explain plugin-specific icon handling and how other plugins require a dump part.
qwen/qwen3.6-35b-a3b — — Merged documentation update clarifying plugin-specific icon file handling in the Manage icons guide. Approved by reviewers, passed CI, and continues work on issue #2593.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update clarifying how different plugins handle icon files in the Manage icons guide. Incorporates reviewer feedback and completes related work from issue #2593.

Update history

Date Change
updated

Related work

  • Likely Fixed By: canonical/charmcraft#2593 (confidence 100%)

    The closed icon-packaging issue was resolved through this documentation update.

  • Related To: operator#2451 (confidence 90%)

    The PR description identifies this Operator change as related work on plugin-specific icon behavior.

Related issues

Issue Project State Summary Similarity
#2809 docs: refresh icon guidance charmcraft merged Docs PR merged as commit 211b4130: rewrote the 'Manage icons' how-to, added icon.svg file paths to plugin migration guides, and trimmed the icon.svg reference to link to the how-to. Resolves #2593 and #2744.
83%