docs: Add more explanation and/or examples to dump_plugin
Metadata
Current evaluation
Docs request for dump plugin page asking for usage examples (copying folders/files to a charm). Moved to craft-parts by maintainer; one example merged via PR #1547, broader PR #1597 open awaiting review.
Suggested action: keep open
Reason: The issue is triaged (labels: Status: Triaged, Type: Documentation) and @lengau explicitly moved it to craft-parts, where it is being actively addressed: PR #1547 already merged an example into dump_plugin.rst and PR #1597 (open, awaiting review) adds further usage examples to resolve craft-parts#1531. Closing here would drop the tracking thread while the fix is still in flight.
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.8-27b |
Impact:
25
Quick Win:
22.5
Staleness:
45
Complexity:
10
Confidence:
80
Support Request:
20
|
keep open | Docs request for dump plugin page asking for usage examples (copying folders/files to a charm). Moved to craft-parts by maintainer; one example merged via PR #1547, broader PR #1597 open awaiting review. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
45
Complexity:
15
Confidence:
85
Support Request:
10
|
keep open | Documentation request to add usage examples and explanations for the dump_plugin. Triaged and acknowledged by a maintainer who redirected it to the craft-parts repository for resolution. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
55
Complexity:
15
Confidence:
85
Support Request:
10
|
keep open | Documentation request to add usage examples for the dump_plugin. Triaged and acknowledged by a maintainer who moved it to the craft-parts repository for resolution. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
70
Complexity:
15
Confidence:
85
Support Request:
10
|
keep open | dump_plugin documentation requires clearer explanations and usage examples for copying files and folders. Triaged and transferred to the craft-parts repository. Internal ticket created. Awaiting docs team review for charmcraft-specific additions. |
Update history
No update history recorded yet.
Related work
-
Duplicate Of:
craft-parts#1531
(confidence 90%)
Maintainer moved this issue to the craft-parts repository; #1531 is the same request tracking the fix.
-
Likely Fixed By:
craft-parts#1547
(confidence 85%)
Merged PR (commit fb57e5a3) added an Example section with a local-directory/organize snippet to dump_plugin.rst, partially addressing the request.
-
Related To:
craft-parts#1597
(confidence 80%)
Open PR adding usage examples for the Dump plugin, explicitly resolving craft-parts#1531; awaiting maintainer review.
-
Related To:
snapcraft#5770
(confidence 70%)
Parallel snapcraft issue reporting the same dump-plugin docs gap; also redirected to craft-parts and still open.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5770 docs: dump plugin docs don't provide enough information to even get started | snapcraft | open | Documentation for dump plugin lacks examples and key descriptions. Maintainer acknowledged; PR craft-parts#1597 adding examples is actively in review (updated 4 days ago). | |
| #1597 docs(dump): add usage examples | craft-parts | open | Adds practical Dump plugin usage examples to documentation. Under review with changes requested and 5 unresolved comments; CI mostly passing. | |
| #1547 docs: add example to dump plugin | craft-parts | merged | Merged documentation update adding a practical Dump plugin example based on the nginx rock configuration. Approved by two reviewers. CI passed except for a known flaky OSV security scan, dismissed by maintainers. |