← Back to issue list

docs: dump plugin docs don't provide enough information to even get started

View original Github issue

Metadata

Project
snapcraft
Number
#5770
Type
issue
State
open
Author
artiepoole
Labels
Type: Documentation
Created
2025-09-11 16:42:52+00:00
Updated
2025-10-15 19:53:33+00:00
Closed

Current evaluation

No evaluation has been recorded for this issue yet.

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

No evaluation history available.