← 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

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.

Suggested action: needs triage

Reason: The issue was filed by maintainer lengau 591 days ago but has no labels, no assignee, and the only comment is an auto-generated Jira sync bot message (2025-01-17). No glossary file exists in the docs tree (confirmed by grep and git log), and no related commits or PRs address it. It needs a maintainer to assess whether the terminology inconsistency it references (PR #2080 discussion) is still relevant and to prioritize or close it.

Impact: 25 Quick Win: 17.5 Staleness: 65 Complexity: 30 Confidence: 75 Support Request: 5

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
qwen/qwen3.8-27b
Impact: 25
Quick Win: 17.5
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 80
Complexity: 10
Confidence: 70
Support Request: 0
close stale Proposes a Charmcraft terminology glossary to standardize definitions for Base, Platform, and Charm versus .charm files. Open, inactive for over 300 days, auto-synced to Jira, awaiting triage and assignment.

Update history

No update history recorded yet.

Related work

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

    The issue explicitly references the discussion in PR #2080 (docs: add platforms reference and how-to) as the motivation for needing a glossary. That PR was merged.

Related issues

Issue Project State Summary Similarity
#2483 docs: add Charmcraft 4.1 release notes charmcraft merged Merged documentation adding Charmcraft 4.1 release notes. The page was intentionally left unindexed pending a separate bases policy page. Approved by two reviewers and passed CI, with a persistent non-blocking type-check warning noted.
71%
#1851 How-to doc for charmcraft test charmcraft open Request to write a how-to guide for the charmcraft test command, which is currently undocumented. No maintainer response or labels; only an auto-generated Jira sync comment. The command still exists in the codebase (spread tests, release notes), so the gap persists.
70%