← Back to issue list

docs: copy note from Juju docs, tidy up container structure doc

View original Github issue

Metadata

Project
charmcraft
Number
#2384
Type
pull request
State
merged
Author
tonyandrewmeyer
Labels
—
Created
Updated
Closed

Current evaluation

Merged in commit eb007460, adding Kubernetes storage-location guidance to charmcraft.yaml docs and restructuring the containers section; replaces #2380.

Resolution: closed resolved

Reason: PR #2384 was merged as commit eb007460, preserving the removed Juju storage note and reorganizing container reference documentation. It replaced the earlier attempt in #2380.

Evaluated by: mr-cal-bot

No scores available.

Issue body

The ["Defining storage"](https://documentation.ubuntu.com/juju/3.6/reference/storage/#defining-storage) Juju doc is being removed. Most of this information is already in the `charmcraft.yaml` reference doc, but there is a note about the ability to specify the location of the mounted storage for K8s charms in either `storage` or `containers` that isn't there, so this copies that across. While doing this, I've also updated the `containers` section of the doc to be less of a wall of text and more similar to the other sections of the doc, like `config`, where there's a shorter "Structure" section and then comments in example YAML that detail each of the fields. This PR replaces #2380, targeting hotfix/3.5 rather than main as suggested there. The only difference between main and 3.5 in the existing text is dropping "windows" as an example base. I've dropped it here, since it's only in a list of examples not a list of all possible values, I assume we're not wanting to encourage its use, and it means that this will cleanly merge against main.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged in commit eb007460, adding Kubernetes storage-location guidance to charmcraft.yaml docs and restructuring the containers section; replaces #2380.
stealth/space-bunny-alpha — closed resolved Merged #2384 in eb007460, adding Kubernetes storage-location guidance to the charmcraft.yaml reference and restructuring the containers documentation. Replaced #2380.
qwen/qwen3.6-35b-a3b — — Merged documentation update targeting hotfix/3.5. Added a note about K8s charm storage mounting locations to the charmcraft.yaml reference and reformatted the containers section for improved readability. Replaces PR #2380. Approved and passed CI.
qwen3.6-35b-a3b-mtp-q6 — — Merged into hotfix/3.5. Updated charmcraft.yaml reference docs to add a note on K8s charm storage mounting locations and reformatted the containers section for better readability. Replaces PR #2380.

Update history

No update history recorded yet.

Related work

Related issues

Issue Project State Summary Similarity
#2380 docs: copy note from Juju docs, tidy up container structure doc charmcraft closed Documentation update landed via #2384 (commit eb007460), adding Kubernetes storage-location guidance and restructuring the containers section.
92%
#2203 docs: copy best practices from Juju docs charmcraft merged Merged PR #2203 as commit 5bf5edc6, adding reviewed Juju-derived best practices as hint admonitions, mainly to the charmcraft.yaml reference.
75%
#2095 docs: update Juju links charmcraft merged Merged in canonical/charmcraft#2095 (commit 389f8ca5), updating Juju links and related formatting across 16 files as the rST portion of #2090.
70%
#2136 docs: fix broken references to juju docs charmcraft merged Merged in canonical/charmcraft#2136 (commit fe64df47), fixing six broken Juju documentation references across four docs files alongside juju/juju#18788 and #18790.
70%