Documentation by channel
Metadata
Current evaluation
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.
Resolution: closed superseded
Reason: Maintainer facundobatista closed the issue on 2022-12-05 stating that metadata.yaml is designed and maintained by the Juju project and that the request should be filed there (https://bugs.launchpad.net/juju/+filebug). No commit or PR in charmcraft implemented channel-dependent docs links; metadata models still map `links.documentation` to `docs` verbatim.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Currently, the `docs` key in `metadata.yaml` points to a discourse post for the docs of a charm. It is possible to maintain different documentation by channel by supplying different values to the `docs` key. However, it is easy to forget to correct the value of `docs` before publishing to a particular channel. Would it be possible to have different links in `metadata.yaml` depending on the targeted channel? I guess this would also require changes to charmhub to interpret the links by channel
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed superseded | 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. | |
| stealth/space-bunny-alpha | — | closed superseded | Request for channel-specific documentation links was redirected to Juju because metadata.yaml is maintained there; no implementation or resolving change is recorded. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Redirected to the Juju project on Launchpad for implementation, as metadata.yaml is maintained there. The feature request remains unimplemented. | |
| qwen/qwen3.6-35b-a3b | — | — | Feature request for channel-specific docs links in metadata.yaml was closed and redirected to Juju's Launchpad tracker. The change requires upstream Juju modifications and remains unimplemented. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Request for channel-specific documentation links in metadata.yaml was closed. Maintainers redirected the feature request to the Juju project on Launchpad, as metadata.yaml is maintained externally. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1657 Document permissions, channels, etc. in Charmhub login | charmcraft | open | Maintainer-created docs request to improve `charmcraft login` command documentation with permissions, channels, and related details; internal Jira ticket CRAFT-2827 exists. |