← Back to issue list

docs: permission docs are missing

View original Github issue

Metadata

Project
charmcraft
Number
#2435
Type
issue
State
open
Author
beliaev-maksim
Labels
Type: Documentation
Created
Updated
Closed

Current evaluation

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.

Suggested action: keep open

Reason: A maintainer explicitly triaged this on 2025-09-10, acknowledging the gap and stating 'I think we'll need @medubelko or @jahn-junior to weigh in on how we can do this' — it's an open decision, not an abandoned report. The how-to page (docs/howto/manage-the-current-charmhub-user.rst) already lists the permissions, but the referenced login command reference page still lacks them, so the issue remains valid and awaiting a maintainer decision.

Impact: 35 Quick Win: 21.0 Staleness: 55 Complexity: 40 Confidence: 70 Support Request: 10

Issue body

*Please describe the question or issue you're facing with "login - Charmcraft 3.5.3 documentation".* Please provide a list of possible permissions that could be used on login. Or a link to the reference --- *Reported from: https://documentation.ubuntu.com/charmcraft/stable/reference/commands/login/*

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 35
Quick Win: 21.0
Staleness: 55
Complexity: 40
Confidence: 70
Support Request: 10
keep 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.
qwen/qwen3.6-35b-a3b
Staleness: 60
Complexity: 10
Confidence: 80
Support Request: 5
keep open Request for documentation on available login permissions. Maintainer pointed to API docs but flagged maintenance challenges, tagging other maintainers for input on the best approach. Still awaiting resolution.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 30
Confidence: 65
Support Request: 10
needs triage Request for documentation on available login permissions in Charmcraft. Currently stalled pending internal discussion on how to handle dynamically changing permissions from the store API.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 20
Confidence: 80
Support Request: 10
needs triage Request for documentation on available login permissions in Charmcraft. A maintainer pointed to the API schema but noted maintenance challenges and requested input from other team members. Currently awaiting triage and decision.
qwen3.6-35b-a3b-mtp-q6
Staleness: 80
Complexity: 15
Confidence: 75
Support Request: 20
close stale Missing charmcraft login permission docs. Permissions are dynamically controlled by the store API. Maintainers are discussing how to reference them. Awaiting input on documenting or linking to the schema.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1657 Document permissions, channels, etc. in Charmhub login charmcraft 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.
74%