vcluster icon indicating copy to clipboard operation
vcluster copied to clipboard

generate documentations for all the commands in vCluster and verify them in GitHub Actions

Open developer-guy opened this issue 4 years ago • 4 comments

In Cobra, we have many options to generate documentation for the commands we have, please see.

This can help us with the following:

  • Generate documentation for your commands
  • Keep up to the date this documentation by verifying PRs via GitHub Actions

To see previous work for the Cosign project,, please see.

cc: @erkanzileli @dextrax @eminaktas

developer-guy avatar Oct 18 '21 19:10 developer-guy

@developer-guy thanks for creating this issue! Yeah thats a good idea, we could do that!

FabianKramm avatar Oct 19 '21 07:10 FabianKramm

Thank you @FabianKramm, I can do it if you want because I did the same for different projects before, would you like to assign this issue to me if you don't mind? 🤩🤝

developer-guy avatar Oct 19 '21 07:10 developer-guy

@developer-guy Thanks for your motivation! Please also fake a look what we did in loft-sh/devspace which already has this functionality but in a very rudimentary/ugly way.

LukasGentele avatar Oct 19 '21 12:10 LukasGentele

@FabianKramm Is this issue still open to be worked upon! Fancy trying it out.

itsaviral2609 avatar Oct 06 '23 17:10 itsaviral2609