← Back to issue list

Add code/YAML example snippet to the Dump plugin documentation

View original Github issue

Metadata

Project
charmcraft
Number
#2296
Type
issue
State
open
Author
MaryannGitonga
Labels
Created
2025-05-22 07:25:13+00:00
Updated
2025-08-15 15:17:36+00:00
Closed

Current evaluation

No evaluation has been recorded for this issue yet.

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

No evaluation history available.