docs: dump plugin docs don't provide enough information to even get started
Metadata
Current evaluation
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).
Suggested action: keep open
Reason: This is a valid documentation improvement request with active maintainer engagement (medubelko responded) and concrete work in progress: PR craft-parts#1597 is adding usage examples and was updated 4 days ago with unresolved review comments. The issue remains relevant as confirmed by WyvernIXTL's recent comment.
Impact:
50
Quick Win:
40.0
Staleness:
15
Complexity:
20
Confidence:
85
Support Request:
10
Issue body
*Please describe the question or issue you're facing with "Dump plugin - Snapcraft 8.12.0 documentation".*
How do you use the dump plugin? This does not give adequate information to even know how to start.
I do not need this document immediately, but was hoping to link it to someone else to give them some help. Instead I have to scour the internet for examples and provide links to those in order to find out what options there are.
Just adding three examples would be extremely helpful:
1) how to use this with a git repository
2) how to use this to add local files to a target path in the installed snap
3) how to include a subset of files
Explanations of the following would also be great
1) How to override-build to customise the subset of files which end up in the final snap.
2) What all of the options are (e.g. options for source-type and with or without `organize:` etc.).
3) Explain how `organize:` can be used/how it works (or link to where it is explained).
edit: I am willing to provide a rough draft based on what I have found, if it would help enough
*Reported from: https://documentation.ubuntu.com/snapcraft/stable/common/craft-parts/reference/plugins/dump_plugin/*
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen3.6-35b-a3b-mtp-q6 |
Impact:
50
Quick Win:
40.0
Staleness:
15
Complexity:
20
Confidence:
85
Support Request:
10
|
keep 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). | |
| qwen/qwen3.8-27b |
Impact:
45
Quick Win:
31.5
Staleness:
55
Complexity:
30
Confidence:
75
Support Request:
20
|
keep open | Dump plugin docs lack examples and explanations for common use cases (git, local files, organize). Maintainer acknowledged and redirected to craft-parts; a PR adding an example was merged, but the broader request remains partially unaddressed. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
75
Complexity:
15
Confidence:
85
Support Request:
10
|
keep open | Documentation request for the Snapcraft dump plugin lacks basic examples and option explanations. Maintainer acknowledged it as a known design flaw but requested more context on the reporter's background before proceeding. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
80
Complexity:
20
Confidence:
75
Support Request:
10
|
keep open | Documentation request to add usage examples and option explanations for the Snapcraft dump plugin. Acknowledged by a maintainer but inactive for 9 months with no concrete action plan. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
75
Complexity:
20
Confidence:
85
Support Request:
10
|
close stale | Snapcraft dump plugin documentation lacks basic usage examples and option explanations. A Snapcraft TA acknowledged the gap, noting plugin references require structural refinement, and requested reporter background details to plan near-term improvements. |
Update history
| Date | Change |
|---|---|
| updated |
Related work
-
Duplicate Of:
craft-parts#1531
(confidence 90%)
Same documentation request in craft-parts repo; summary confirms it covers the same dump plugin docs improvement.
-
Related To:
craft-parts#1547
(confidence 85%)
Merged PR that added one dump plugin example; PR #1597 builds on this with more comprehensive examples.
-
Likely Fixed By:
craft-parts#1597
(confidence 80%)
Open PR adding dump plugin usage examples; actively in review with changes requested, last updated 4 days ago.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1531 docs: Add more explanation and/or examples to dump_plugin | craft-parts | 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. | |
| #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. | |
| #676 docs(plugins): add dump plugin docs | craft-parts | merged | Merged documentation update adding dump plugin documentation across nine files. Approved by two reviewers with 265 additions and 3 deletions. Associated unit test fixes were resolved in a separate pull request. |