← Back to issue list

Change templates to link to current documentation

View original Github issue

Metadata

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

Current evaluation

Charmcraft templates should link charmcraft.yaml to modern docs instead of outdated juju.is pages. No comments or labels; recent template commits show active maintenance, so it needs triage.

Suggested action: needs triage

Reason: The issue is unlabelled with zero comments, but the templates directory has active recent commits (e.g. #2753 updating URLs in profiles, #2733), so it is not stale. It is a small, well-scoped doc-link cleanup rather than a support request.

Impact: 30 Quick Win: 25.5 Staleness: 20 Complexity: 15 Confidence: 75 Support Request: 5

Issue body

### What needs to get done The `charmcraft.yaml` files produced by our templates should link to modern documentation. ### Why it needs to get done It currently links to the old documentation on `juju.is`, contains repeated and potentially outdated information, etc.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 30
Quick Win: 25.5
Staleness: 20
Complexity: 15
Confidence: 75
Support Request: 5
needs triage Charmcraft templates should link charmcraft.yaml to modern docs instead of outdated juju.is pages. No comments or labels; recent template commits show active maintenance, so it needs triage.
qwen/qwen3.6-35b-a3b
Staleness: 45
Complexity: 15
Confidence: 90
Support Request: 0
needs triage Templates generating charmcraft.yaml files link to outdated juju.is documentation and need to be updated to point to current docs. Open, awaiting implementation.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 10
Confidence: 80
Support Request: 5
close stale Template-generated charmcraft.yaml files link to outdated juju.is documentation instead of current docs. Issue is unlabelled, has no comments, and has been inactive for over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 15
Confidence: 80
Support Request: 5
needs triage Update charmcraft.yaml templates to link to current documentation instead of outdated juju.is links. Currently unlabelled and inactive for over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 65
Complexity: 15
Confidence: 85
Support Request: 0
keep open Update template-generated charmcraft.yaml files to link to current documentation instead of outdated juju.is links. Open, unassigned, and inactive for over 300 days. Requires triage and assignment.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#2793 Update init templates to use a single current Charmcraft docs link charmcraft closed Rejected and closed without merging. A maintainer noted the template cleanup contradicted previous requests, as it removed legacy documentation comments instead of consolidating them as intended.
79%
#1964 Provide internal documentation for templates charmcraft open Internal task to add explanatory comments in charmcraft templates for ignored linter rules, originating from PR #1941 review. Open 684 days with no maintainer activity beyond a Jira ticket sync.
71%
#2351 fix(templates): update out-of-date parts in template README files charmcraft merged Merged update to kubernetes and machine template README files. Replaced metadata.yaml with charmcraft.yaml, updated package naming, and fixed documentation links. Approved by three reviewers and merged.
70%
#1498 docs: Fix 404 in charmcraft.yaml.j2 charmcraft closed Merged to fix a 404 error in charmcraft.yaml.j2. The single-line change resolved the broken documentation link. Closed without reviews or CI checks.
70%