Update doc with cmd alias (#489)

sunny0826 · Aug 22, 2022 · 69eeeb5 · 69eeeb5
1 parent ac102b2
commit 69eeeb5
Show file tree

Hide file tree

Showing 14 changed files with 23 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ Available Commands:
   add         Add KubeConfig to $HOME/.kube/config
   alias       Generate alias for all contexts
   clear       Clear lapsed context, cluster and user
-  cloud       manage kubeconfig from cloud
+  cloud       Manage kubeconfig from cloud
   completion  Generate completion script
   create      Create new KubeConfig(experiment)
   delete      Delete the specified context from the kubeconfig

diff --git a/cmd/add.go b/cmd/add.go
@@ -26,9 +26,10 @@ type KubeConfigOption struct {
 // Init AddCommand
 func (ac *AddCommand) Init() {
 	ac.command = &cobra.Command{
-		Use:   "add",
-		Short: "Add KubeConfig to $HOME/.kube/config",
-		Long:  "Add KubeConfig to $HOME/.kube/config",
+		Use:     "add",
+		Short:   "Add KubeConfig to $HOME/.kube/config",
+		Long:    "Add KubeConfig to $HOME/.kube/config",
+		Aliases: []string{"a"},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return ac.runAdd(cmd, args)
 		},

diff --git a/cmd/cloud.go b/cmd/cloud.go
@@ -50,8 +50,8 @@ var Clouds = []CloudInfo{
 func (cc *CloudCommand) Init() {
 	cc.command = &cobra.Command{
 		Use:   "cloud [COMMANDS]",
-		Short: "manage kubeconfig from cloud",
-		Long:  "manage kubeconfig from cloud",
+		Short: "Manage kubeconfig from cloud",
+		Long:  "Manage kubeconfig from cloud",
 	}
 	cc.command.PersistentFlags().String("provider", "", "public cloud")
 	cc.command.PersistentFlags().String("cluster_id", "", "kubernetes cluster id")

diff --git a/cmd/cloud_list.go b/cmd/cloud_list.go
@@ -18,8 +18,8 @@ type CloudListCommand struct {
 func (cl *CloudListCommand) Init() {
 	cl.command = &cobra.Command{
 		Use:   "list",
-		Short: "list Cluster from cloud",
-		Long:  "list Cluster from cloud",
+		Short: "List Cluster from cloud",
+		Long:  "List Cluster from cloud",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return cl.runCloudList(cmd, args)
 		},

diff --git a/docs/README.md b/docs/README.md
@@ -27,7 +27,7 @@ Available Commands:
   add         Add KubeConfig to $HOME/.kube/config
   alias       Generate alias for all contexts
   clear       Clear lapsed context, cluster and user
-  cloud       manage kubeconfig from cloud
+  cloud       Manage kubeconfig from cloud
   completion  Generate completion script
   create      Create new KubeConfig(experiment)
   delete      Delete the specified context from the kubeconfig

diff --git a/docs/en-us/README.md b/docs/en-us/README.md
@@ -26,7 +26,7 @@ Available Commands:
   add         Add KubeConfig to $HOME/.kube/config
   alias       Generate alias for all contexts
   clear       Clear lapsed context, cluster and user
-  cloud       manage kubeconfig from cloud
+  cloud       Manage kubeconfig from cloud
   completion  Generate completion script
   create      Create new KubeConfig(experiment)
   delete      Delete the specified context from the kubeconfig

diff --git a/docs/en-us/cli/kubecm.md b/docs/en-us/cli/kubecm.md
@@ -31,7 +31,7 @@ KubeConfig Manager.
 * [kubecm add](kubecm_add.md)	 - Add KubeConfig to $HOME/.kube/config
 * [kubecm alias](kubecm_alias.md)	 - Generate alias for all contexts
 * [kubecm clear](kubecm_clear.md)	 - Clear lapsed context, cluster and user
-* [kubecm cloud](kubecm_cloud.md)	 - manage kubeconfig from cloud
+* [kubecm cloud](kubecm_cloud.md)	 - Manage kubeconfig from cloud
 * [kubecm completion](kubecm_completion.md)	 - Generate completion script
 * [kubecm create](kubecm_create.md)	 - Create new KubeConfig(experiment)
 * [kubecm delete](kubecm_delete.md)	 - Delete the specified context from the kubeconfig

diff --git a/docs/en-us/cli/kubecm_cloud.md b/docs/en-us/cli/kubecm_cloud.md
@@ -1,10 +1,10 @@
 ## kubecm cloud
 
-manage kubeconfig from cloud
+Manage kubeconfig from cloud
 
 ### Synopsis
 
-manage kubeconfig from cloud
+Manage kubeconfig from cloud
 
 ### Options
 
@@ -26,5 +26,5 @@ manage kubeconfig from cloud
 
 * [kubecm](kubecm.md)	 - KubeConfig Manager.
 * [kubecm cloud add](kubecm_cloud_add.md)	 - Add kubeconfig from cloud
-* [kubecm cloud list](kubecm_cloud_list.md)	 - list Cluster from cloud
+* [kubecm cloud list](kubecm_cloud_list.md)	 - List Cluster from cloud
 
diff --git a/docs/en-us/cli/kubecm_cloud_add.md b/docs/en-us/cli/kubecm_cloud_add.md
@@ -53,5 +53,5 @@ kubecm cloud add --provider alibabacloud --cluster_id=xxxxxx
 
 ### SEE ALSO
 
-* [kubecm cloud](kubecm_cloud.md)	 - manage kubeconfig from cloud
+* [kubecm cloud](kubecm_cloud.md)	 - Manage kubeconfig from cloud
 
diff --git a/docs/en-us/cli/kubecm_cloud_list.md b/docs/en-us/cli/kubecm_cloud_list.md
@@ -1,10 +1,10 @@
 ## kubecm cloud list
 
-list Cluster from cloud
+List Cluster from cloud
 
 ### Synopsis
 
-list Cluster from cloud
+List Cluster from cloud
 
 ```
 kubecm cloud list [flags]
@@ -53,5 +53,5 @@ kubecm cloud list --provider alibabacloud --cluster_id=xxxxxx
 
 ### SEE ALSO
 
-* [kubecm cloud](kubecm_cloud.md)	 - manage kubeconfig from cloud
+* [kubecm cloud](kubecm_cloud.md)	 - Manage kubeconfig from cloud
 
diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md
@@ -26,7 +26,7 @@ Available Commands:
   add         Add KubeConfig to $HOME/.kube/config
   alias       Generate alias for all contexts
   clear       Clear lapsed context, cluster and user
-  cloud       manage kubeconfig from cloud
+  cloud       Manage kubeconfig from cloud
   completion  Generate completion script
   create      Create new KubeConfig(experiment)
   delete      Delete the specified context from the kubeconfig

diff --git a/docs/zh-cn/cli/kubecm_cloud.md b/docs/zh-cn/cli/kubecm_cloud.md
@@ -26,5 +26,5 @@
 
 * [kubecm](kubecm.md)	 - KubeConfig Manager.
 * [kubecm cloud add](kubecm_cloud_add.md)	 - Add kubeconfig from cloud
-* [kubecm cloud list](kubecm_cloud_list.md)	 - list Cluster from cloud
+* [kubecm cloud list](kubecm_cloud_list.md)	 - List Cluster from cloud
 
diff --git a/docs/zh-cn/cli/kubecm_cloud_add.md b/docs/zh-cn/cli/kubecm_cloud_add.md
@@ -53,5 +53,5 @@ kubecm cloud add --provider alibabacloud --cluster_id=xxxxxx
 
 ### SEE ALSO
 
-* [kubecm cloud](kubecm_cloud.md)	 - manage kubeconfig from cloud
+* [kubecm cloud](kubecm_cloud.md)	 - Manage kubeconfig from cloud
 
diff --git a/docs/zh-cn/cli/kubecm_cloud_list.md b/docs/zh-cn/cli/kubecm_cloud_list.md
@@ -53,5 +53,5 @@ kubecm cloud list --provider alibabacloud --cluster_id=xxxxxx
 
 ### SEE ALSO
 
-* [kubecm cloud](kubecm_cloud.md)	 - manage kubeconfig from cloud
+* [kubecm cloud](kubecm_cloud.md)	 - Manage kubeconfig from cloud