github/kubevela
1
0
Fork 0
mirror of https://github.com/kubevela/kubevela.git synced 2026-08-19 04:26:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix: change vela def gen-doc to vela def doc-gen (#3078)

Browse Source 
* Fix: change `vela def gen-doc` to `vela def doc-gen`

Address the comments to change the command line name

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>
Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

* fix CI

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>
This commit is contained in:
Zheng Xi Zhou
2022-01-12 11:35:41 +08:00
committed by GitHub
co-authored by Jianbo Sun
parent 19a542ff11
commit f41e0a3bb5
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
references/cli/def.go
+5 -6
View File
@@ -411,15 +411,14 @@ func NewDefinitionGetCommand(c common.Args) *cobra.Command {
return cmd
}
// NewDefinitionGenDocCommand create the `vela def gen-doc` command to generate documentation of definitions
// NewDefinitionGenDocCommand create the `vela def doc-gen` command to generate documentation of definitions
func NewDefinitionGenDocCommand(c common.Args) *cobra.Command {
cmd := &cobra.Command{
Use: "gen-doc NAME",
Short: "Generate documentation of definitions (Only Terraform typed definitions are supported)",
Long: "Generate documentation of definitions",
Hidden: true,
Use: "doc-gen NAME",
Short: "Generate documentation of definitions (Only Terraform typed definitions are supported)",
Long: "Generate documentation of definitions",
Example: "1. Generate documentation for ComponentDefinition alibaba-vpc:\n" +
"> vela def gen-doc alibaba-vpc -n vela-system\n",
"> vela def doc-gen alibaba-vpc -n vela-system\n",
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) == 0 {
return fmt.Errorf("please specify definition name")