← Back to issue list

docs: Add more explanation and/or examples to dump_plugin

View original Github issue

Metadata

Project
craft-parts
Number
#1531
Type
issue
State
open
Author
marcusboden
Labels
Status: Triaged Type: Documentation
Created
Updated
Closed
—

Current evaluation

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.

Suggested action: close resolved

Reason: The requested Example section now exists: commit fb57e5a3 ("docs: add example to dump plugin (#1547)") is the most recent commit touching docs/common/craft-parts/reference/plugins/dump_plugin.rst and adds a code-block:: yaml snippet with a local `source: .` plus `organize` remapping nginx.conf/default.conf — exactly the 'how do you copy folders' example requested. Slight caveat: the reporter also asked about copying files to a charm, and @lengau noted charmcraft-specific examples would be a separate sub-issue, so that slice remains unaddressed here.

Evaluated by: mr-cal-bot

Impact: 28 Quick Win: 22 Complexity: 8 Confidence: 88 Actionability: 85

Issue body

The dump plugin page is pretty rudimentary. There should be some examples how to use it. How do you copy folders, how do you copy files to a charm? Simple examples would be nice. I had to look at https://documentation.ubuntu.com/charmcraft/stable/howto/build-guides/pack-a-hooks-based-charm-with-charmcraft/ to find an example. --- *Reported from: https://documentation.ubuntu.com/charmcraft/stable/common/craft-parts/reference/plugins/dump_plugin/*

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 28
Quick Win: 22
Complexity: 8
Confidence: 88
Actionability: 85
close resolved 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.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 22
Complexity: 10
Confidence: 85
Actionability: 80
close resolved Request to add examples to dump_plugin documentation. Moved to craft-parts where craft-parts#1547 was merged adding examples.
qwen/qwen3.8-27b
Impact: 25
Quick Win: 22
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.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: craft-parts#1547 (confidence 96%)

    Merged PR 'docs: add example to dump plugin', commit fb57e5a3; directly implements the Example section this issue asked for.

  • Duplicate Of: snapcraft#5770 (confidence 55%)

    Same doc complaint about the dump plugin docs lacking getting-started information; plausible upstream sibling report, not confirmed as a direct cross-reference.

Related issues

Issue Project State Summary Similarity
#1547 docs: add example to dump plugin craft-parts merged Merged PR #1547 in commit fb57e5a3, adding a practical Dump plugin documentation example based on an nginx rock configuration.
78%
#676 docs(plugins): add dump plugin docs craft-parts merged Merged dump-plugin documentation covering usage, source behavior, overrides, and an example via commit 2c7b7170.
78%
#1597 docs(dump): add usage examples craft-parts open Docs-only PR adding declarative Dump plugin usage examples (local dir, per-file copies, organize remapping). Approved by 2 reviewers, 0 unresolved comments; CI green except an unrelated Minimum-dependencies failure.
78%
#5770 docs: dump plugin docs don't provide enough information to even get started snapcraft open Docs request: dump plugin reference lacks examples and key descriptions. Partly addressed by merged craft-parts PR #1547 and the include_files how-to, but the Keys section still has no per-key type/default/description; maintainer asked about reader context.
74%
#2296 Add code/YAML example snippet to the Dump plugin documentation charmcraft closed Resolved upstream by canonical/craft-parts#1547, which added the missing YAML example to the shared Dump plugin documentation.
72%
#712 New plugin: dump snapcraft merged Merged PR #712 as commit b86965088, adding a dump plugin that extracts content directly from the configured source and includes integration coverage.
72%