← Back to issue list

Charmcraft terminology glossary

View original Github issue

Metadata

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

Current evaluation

Maintainer request to add a Charmcraft glossary defining terms like Base, Platform, and Charm (vs. the packed .charm file). Still no glossary page in docs/; docs/reuse/links.txt carries a TODO about it.

Suggested action: needs triage

Reason: The issue is unlabelled, unassigned, and has no human maintainer response — the sole comment is the sync bot reporting CRAFT-3951 — so it has not been assessed or prioritised. It is still valid: grep for "glossary" across the repo returns only a TODO in docs/reuse/links.txt ("Potentially use a glossary to create indirect references to explanations"), and no glossary page exists. Note that the docs have since been reorganised under Diátaxis, with bases explained in docs/explanation/bases.rst and platforms in docs/reference/platforms.rst, so a maintainer should decide whether a separate glossary is still warranted or whether the charm-vs-.charm-file distinction should simply be folded into existing pages.

Evaluated by: mr-cal-bot

Impact: 35 Quick Win: 10 Complexity: 35 Confidence: 78 Actionability: 45

Issue body

### What needs to get done We need a glossary for Charmcraft terminology. Some examples of terminology to define: - Base - Platform - "Charm" (<-- Distinguish it from the resulting packed `.charm` file) ### Why it needs to get done The terminology is sufficiently fluid that we often don't even have agreement amongst people working on Charmcraft. See the discussion at https://github.com/canonical/charmcraft/pull/2080/files#r1919323116

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 35
Quick Win: 10
Complexity: 35
Confidence: 78
Actionability: 45
needs triage Maintainer request to add a Charmcraft glossary defining terms like Base, Platform, and Charm (vs. the packed .charm file). Still no glossary page in docs/; docs/reuse/links.txt carries a TODO about it.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 19
Complexity: 20
Confidence: 70
Actionability: 80
keep open Request to create a Charmcraft terminology glossary defining terms like Base, Platform, and Charm. Open for 608 days with no labels, assignee, or maintainer action beyond a Jira bot comment.
qwen/qwen3.8-27b
Impact: 25
Quick Win: 18
Staleness: 65
Complexity: 30
Confidence: 75
Support Request: 5
needs triage Documentation task to create a Charmcraft terminology glossary (Base, Platform, Charm vs .charm file). Filed by a maintainer 591 days ago, no labels, no assignee, no maintainer response beyond a Jira sync bot. No glossary exists in the docs tree.
qwen/qwen3.6-35b-a3b
Staleness: 75
Complexity: 15
Confidence: 85
Support Request: 0
needs triage Request to create a Charmcraft terminology glossary to standardize terms like Base, Platform, and Charm. Currently unlabelled, inactive for 340 days, and awaiting triage.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 20
Confidence: 75
Support Request: 0
close stale Request to create a Charmcraft terminology glossary to clarify terms like Base, Platform, and Charm. Open for over 18 months with no maintainer response or labels, remaining untriaged and inactive.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 20
Confidence: 80
Support Request: 10
needs triage Request to create a Charmcraft terminology glossary to standardize definitions for terms like Base, Platform, and Charm. Currently unlabelled and inactive for over a year.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/charmcraft#2080 (confidence 88%)

    Merged PR (commit 142fa827) cited in the issue body as the source of the terminology disagreement; added the platforms/base/architecture reference and how-to docs that now cover much of this terminology.

Related issues

No related issues found above the similarity threshold.