devstream icon indicating copy to clipboard operation
devstream copied to clipboard

:four_leaf_clover: `Proposal`: generate the default configuration file for the plugin based on the plugin's options

Open imxw opened this issue 2 years ago • 2 comments

What Would You Like to Add? Why Is This Needed?

Some plugins have an options.go that can be self-documented using comments, and then we can use it to generate the xxx.yaml needed for dtm show using go generate. The markdown files in docs/plugins can embed the default yaml file, so that developers only need to focus on the code to avoid the situation of changing the code and forgetting to change the documentation

imxw avatar Jun 01 '22 09:06 imxw

Great idea!

daniel-hutao avatar Jun 03 '22 12:06 daniel-hutao

@aFlyBird0 I think this issue might be not too hard for first-time contributors. Maybe let's label it as a good first issue and encourage the community to work on it?

@daniel-hutao

IronCore864 avatar Jun 13 '22 01:06 IronCore864