Add code/YAML example snippet to the Dump plugin documentation
Metadata
Current evaluation
Resolved upstream by canonical/craft-parts#1547, which added the missing YAML example to the shared Dump plugin documentation.
Resolution: closed resolved
Reason: Merged canonical/craft-parts#1547 added the Dump plugin YAML example in commit fb57e5a3, providing the requested configuration snippet.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### Request type
Enhancement
### What needs to get done
Please add a code/YAML example snippet to the [Dump plugin section](https://canonical-charmcraft.readthedocs-hosted.com/en/latest/common/craft-parts/reference/plugins/dump_plugin/) of the documentation, similar to what is provided for other plugins.
### Rationale
Including a concrete example helps reinforce the conceptual understanding of how to use the dump plugin effectively and maintains consistency with the documentation style of other plugins, which already include example snippets.
This would be especially valuable for onboarding users who rely on examples to understand real-world usage and configurations.
### Documentation location
https://canonical-charmcraft.readthedocs-hosted.com/en/latest/common/craft-parts/reference/plugins/dump_plugin/
### Additional information
_No response_
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Resolved upstream by canonical/craft-parts#1547, which added the missing YAML example to the shared Dump plugin documentation. | |
| stealth/space-bunny-alpha | — | closed resolved | Resolved upstream: canonical/craft-parts#1547 merged in commit fb57e5a3, adding a YAML example based on nginx configuration to the Dump plugin documentation. | |
| stealth/space-bunny-alpha | — | closed resolved | Added the requested Dump plugin YAML example upstream via canonical/craft-parts#1547 (commit fb57e5a3), using a practical nginx configuration. | |
| stealth/space-bunny-alpha | — | closed resolved | Dump plugin docs now include a practical YAML example; the fix was merged upstream in canonical/craft-parts#1547 (commit fb57e5a3). | |
| stealth/space-bunny-alpha | — | closed resolved | The missing Dump plugin YAML example was added upstream by merged canonical/craft-parts#1547 (commit fb57e5a3), using a practical nginx configuration. | |
| qwen/qwen3.6-35b-a3b | — | — | Request to add a YAML example snippet to the Dump plugin documentation was closed and abandoned. No implementation or pull request was submitted to address the enhancement. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
95
Complexity:
15
Confidence:
90
Support Request:
5
|
needs triage | Enhancement request to add a YAML example to the Dump plugin documentation for consistency. Unlabelled, zero maintainer comments, inactive for over a year, awaiting assessment. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
10
Confidence:
80
Support Request:
5
|
needs triage | Request to add a code/YAML example snippet to the Dump plugin documentation for consistency and better user onboarding. Unlabelled and inactive for over a year with no maintainer response. |
Update history
| Date | Change |
|---|---|
| closed |
Related work
-
Likely Fixed By:
canonical/craft-parts#1547
(confidence 100%)
The upstream craft-parts documentation fix was merged and is the source of the shared Dump plugin page.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1531 docs: Add more explanation and/or examples to dump_plugin | craft-parts | open | Doc request for examples on the dump plugin reference page; resolved by merged PR #1547 (fb57e5a3), which added a YAML example with local source and organize remapping. Issue still open in tracker. |