← Back to issue list

Create a reference page for the charm plugin

View original Github issue

Metadata

Project
charmcraft
Number
#2092
Type
issue
State
open
Author
lengau
Labels
Created
Updated
Closed

Current evaluation

Documentation task to create a reference page for the charm plugin, mirroring the uv plugin page template. Unaddressed; no charm_plugin.rst exists in docs/reference/plugins/. Project is migrating users toward the uv plugin, which may reduce priority.

Suggested action: keep open

Reason: The issue is a valid documentation task created by a maintainer (lengau) with a Jira ticket (CRAFT-3958). No charm_plugin.rst exists in docs/reference/plugins/ and the plugins index doesn't list one, so it's unaddressed. However, the project is actively migrating users from the charm plugin to the uv plugin (see docs/howto/migrate-plugins/charm-to-uv.rst and init.py migration hint), which may reduce the urgency of this task. Last activity was 381 days ago (bot comment only), making it moderately stale.

Impact: 30 Quick Win: 24.0 Staleness: 70 Complexity: 20 Confidence: 75 Support Request: 0

Issue body

### What needs to get done Create a reference page using the same template as the other plugin pages (e.g. [uv plugin](https://canonical-charmcraft.readthedocs-hosted.com/en/stable/reference/plugins/uv_plugin/)) for the charm plugin. The hidden charm plugin piece under https://canonical-charmcraft.readthedocs-hosted.com/en/stable/reference/files/charmcraft-yaml-file/#parts can be used for this and replaced with a link to this reference page. ### Why it needs to get done This documentation is in a bad spot.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 30
Quick Win: 24.0
Staleness: 70
Complexity: 20
Confidence: 75
Support Request: 0
keep open Documentation task to create a reference page for the charm plugin, mirroring the uv plugin page template. Unaddressed; no charm_plugin.rst exists in docs/reference/plugins/. Project is migrating users toward the uv plugin, which may reduce priority.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 15
Confidence: 80
Support Request: 10
needs triage Request to create a dedicated reference documentation page for the charm plugin, replacing the current embedded section. No maintainer labels or active discussion present.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 15
Confidence: 80
Support Request: 0
needs triage Unlabelled documentation task to create a reference page for the charm plugin, inactive for over a year with no maintainer response or labels.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 15
Confidence: 90
Support Request: 5
close stale Request to create a dedicated reference documentation page for the charm plugin, replacing the current embedded section. The issue has been inactive for over 10 months with no maintainer response or progress.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 15
Confidence: 75
Support Request: 0
needs triage Create a dedicated reference documentation page for the charm plugin to replace the current hidden inline section. Open and inactive for over 300 days. Auto-ticketed to Jira. Awaiting triage and assignment.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#2094 Create a reference page for the reactive plugin charmcraft open Docs task to add a dedicated reference page for the reactive plugin, mirroring the uv plugin page, and replace the inline reactive section in the charmcraft.yaml reference. Open, unlabelled, last touched by a Jira-sync bot 381 days ago; no page exists yet.
78%