← Back to issue list

Document permissions, channels, etc. in Charmhub login

View original Github issue

Metadata

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

Current evaluation

Docs improvement: expand charmcraft login docs to explain required permissions and how to specify channels. The how-to now lists all permissions and explains --channel/--permission options; a minor nit (naked track in the example) from a maintainer comment may remain.

Suggested action: keep open

Reason: The core request is largely addressed: docs/howto/manage-the-current-charmhub-user.rst now contains a full permission list (package-manage-*, account-*, etc.) and explains --channel/--permission/--ttl, added via the docs refactor (#2010). However, tim-hm's comment flagged that the example uses a naked track (--channel=edge) rather than a full channel, which still appears at line 101, so a small doc fix remains and the issue is not explicitly closed.

Impact: 30 Quick Win: 24.0 Staleness: 65 Complexity: 20 Confidence: 60 Support Request: 10

Issue body

### What needs to get done Improve the `charmcraft login` command documentation (https://juju.is/docs/sdk/charmcraft-login) to provide information about what permissions are needed for what, how channels should be specified, etc. ### Why it needs to get done These are frequent questions we get in Matrix that often result in a lot of back & forth because we (the starcraft team) don't remember either.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 30
Quick Win: 24.0
Staleness: 65
Complexity: 20
Confidence: 60
Support Request: 10
keep open Docs improvement: expand charmcraft login docs to explain required permissions and how to specify channels. The how-to now lists all permissions and explains --channel/--permission options; a minor nit (naked track in the example) from a maintainer comment may remain.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 15
Confidence: 75
Support Request: 30
needs triage Request to improve charmcraft login documentation regarding permissions, channels, and export flags. Currently unlabelled and inactive for over a year, awaiting maintainer assessment to determine if documentation updates are still needed.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 15
Confidence: 80
Support Request: 10
needs triage Request to improve charmcraft login documentation regarding permissions, channels, and export flags. Currently unlabelled, unassigned, and inactive for over 10 months.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 15
Confidence: 80
Support Request: 10
needs triage Request to improve documentation for the charmcraft login command regarding permissions, channels, and export flags. Currently unlabelled and inactive for over 10 months.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 10
Confidence: 65
Support Request: 20
needs triage Improve charmcraft login documentation to clarify permissions, channel specifications, and usage examples. Addresses frequent user confusion. Currently open with three comments and an internal Jira ticket. Last activity 304 days ago.

Update history

No update history recorded yet.

Related work

  • Related To: charmcraft#2010 (confidence 55%)

    Docs refactor 'add, refactor, and reformat discourse docs' touched manage-the-current-charmhub-user.rst and introduced the permission list and channel explanation this issue asked for.

Related issues

Issue Project State Summary Similarity
#2435 docs: permission docs are missing charmcraft open Charmcraft login reference docs lack a list of valid --permission values. A maintainer replied (2025-09-10) that permissions are store-controlled and the list can change, and asked @medubelko/@jahn-junior to weigh in on how to document them; no resolution yet.
74%