[feature request] use "spf13/cobra" to auto generate command line markdown document

[allencloud]

Why you need it?

How to generate user-friendly document is very important work we have to do in Dragonfly project. While I think the best way to make it is to follow the rule CODE IS DOCUMENT(代码即文档). Under such kind of policy, when every update occurs to the CLI-related code, the project has abilities to auto generate the corresponding document. Then the developers can spend less time to construct the document, instead they could have more time to polish the CLI related code when programming which is also reasonable.

We have already supported using spf13/cobra to implement COMMAND LINE framework in dragonflyoss/dragonfly#257. With this work, we can use https://github.com/spf13/cobra/blob/master/doc/md_docs.md to add another command to generate all the CLI document.

After adding the command which is used to generate CLI document, we can make @pouchrobot to automatically generate doc every day when it has update to the cli part. This is quite similar to PouchContainer.

How it could be?

use "spf13/cobra" to auto generate command line markdown document

Other related information

none