Document permissions, channels, etc. in Charmhub login
Metadata
Current evaluation
Maintainer-created docs request to improve `charmcraft login` command documentation with permissions, channels, and related details; internal Jira ticket CRAFT-2827 exists.
Suggested action: keep open
Reason: The issue is a valid, maintainer-authored documentation improvement with a clear scope and an internal Jira ticket (CRAFT-2827) already created. Existing docs in `docs/howto/manage-the-current-charmhub-user.rst` already list permissions, but the referenced command page and remote-env-auth example need updating, so the work remains open.
Evaluated by: mr-cal-bot
Impact:
45
Quick Win:
22
Complexity:
30
Confidence:
75
Actionability:
70
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 |
|---|---|---|---|---|
| ~deepseek/deepseek-pro-latest |
Impact:
45
Quick Win:
22
Complexity:
30
Confidence:
75
Actionability:
70
|
keep open | Maintainer-created docs request to improve `charmcraft login` command documentation with permissions, channels, and related details; internal Jira ticket CRAFT-2827 exists. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
17
Complexity:
20
Confidence:
70
Actionability:
70
|
keep open | Documentation improvement request for charmcraft login command to clarify permissions, channels, and usage examples | |
| qwen/qwen3.8-27b |
Impact:
30
Quick Win:
24
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. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #935 Documentation by channel | charmcraft | closed | Feature request for channel-specific `docs` links in metadata.yaml was declined in charmcraft and redirected to the Juju project (launchpad filebug), where metadata.yaml is designed and maintained; no charmcraft change. | |
| #1851 How-to doc for charmcraft test | charmcraft | open | Documentation request from a maintainer to write a how-to guide for the undocumented `charmcraft test` command. Open with no labels, assignee, or maintainer triage; only an automated Jira-sync bot comment (CRAFT-3957). | |
| #604 Enhance invalid permission login error with url to docs (CRAFT-659). | charmcraft | merged | Merged canonical/charmcraft#604 as 68ec24ec, improving invalid-permission login errors with clearer guidance and a documentation URL. |