Merge pull request #843 from sunny0826/feat/docs-gen

chore: 🤖 update doc-gen script
sunny0826 · Jan 9, 2024 · 550aa88 · 550aa88
2 parents 08c9697 + 30680c5
commit 550aa88
Show file tree

Hide file tree

Showing 27 changed files with 526 additions and 36 deletions.
diff --git a/docs/en-us/cli/kubecm.md b/docs/en-us/cli/kubecm.md
@@ -15,17 +15,17 @@ KubeConfig Manager.
 [92m██  ██  ██    ██ ██   ██ ██      ██      ██  ██  ██ [0m
 [92m██   ██  ██████  ██████  ███████  ██████ ██      ██[0m
 [92m[0m
-[44;97m[44;97m Tips [0m[0m [96m[96mFind more information at: ]8;;https://kubecm.cloud[3;32mkubecm.cloud]8;;[0m[96m[0m[0m
+[44;97m[44;97m Tips [0m[0m [96m[96mFind more information at: [3;32mkubecm.cloud (https://kubecm.cloud)[0m[96m[0m[0m
 
 
 ### Options
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxudong/.kube/config")
+      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
   -h, --help            help for kubecm
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
-      --ui-size int     number of list items to show in menu at once (default 4)
+  -u, --ui-size int     number of list items to show in menu at once (default 4)
 ```
 
 ### SEE ALSO
@@ -34,13 +34,12 @@ KubeConfig Manager.
 * [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 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
+* [kubecm docs](kubecm_docs.md)	 - Open document website
 * [kubecm export](kubecm_export.md)	 - Export the specified context from the kubeconfig
 * [kubecm list](kubecm_list.md)	 - List KubeConfig
 * [kubecm merge](kubecm_merge.md)	 - Merge multiple kubeconfig files into one
-* [kubecm namespace](kubecm_namespace.md)	 - Switch or change namespace interactively
 * [kubecm rename](kubecm_rename.md)	 - Rename the contexts of kubeconfig
 * [kubecm switch](kubecm_switch.md)	 - Switch Kube Context interactively
 * [kubecm version](kubecm_version.md)	 - Print version info

diff --git a/docs/en-us/cli/kubecm_add.md b/docs/en-us/cli/kubecm_add.md
@@ -39,13 +39,14 @@ cat /etc/kubernetes/admin.conf |  kubecm add -f -
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxudong/.kube/config")
+      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
-      --ui-size int     number of list items to show in menu at once (default 4)
+  -u, --ui-size int     number of list items to show in menu at once (default 4)
 ```
 
 ### SEE ALSO
 
 * [kubecm](kubecm.md)	 - KubeConfig Manager.
+* [kubecm add docs](kubecm_add_docs.md)	 - Open document website
 
diff --git a/docs/en-us/cli/kubecm_add_docs.md b/docs/en-us/cli/kubecm_add_docs.md
@@ -0,0 +1,43 @@
+## kubecm add docs
+
+Open document website
+
+### Synopsis
+
+Open document website in your browser
+
+```
+kubecm add docs [flags]
+```
+
+### Examples
+
+```
+
+# Open kubecm website
+kubecm docs
+# Open add command document page
+kubecm add docs
+
+```
+
+### Options
+
+```
+  -h, --help   help for docs
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+  -c, --cover           Overwrite local kubeconfig files
+  -m, --mac-notify      enable to display Mac notification banner
+  -s, --silence-table   enable/disable output of context table on successful config update
+  -u, --ui-size int     number of list items to show in menu at once (default 4)
+```
+
+### SEE ALSO
+
+* [kubecm add](kubecm_add.md)	 - Add KubeConfig to $HOME/.kube/config
+
diff --git a/docs/en-us/cli/kubecm_alias.md b/docs/en-us/cli/kubecm_alias.md
@@ -31,13 +31,14 @@ $ kubecm alias -o bash
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxudong/.kube/config")
+      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
-      --ui-size int     number of list items to show in menu at once (default 4)
+  -u, --ui-size int     number of list items to show in menu at once (default 4)
 ```
 
 ### SEE ALSO
 
 * [kubecm](kubecm.md)	 - KubeConfig Manager.
+* [kubecm alias docs](kubecm_alias_docs.md)	 - Open document website
 
diff --git a/docs/en-us/cli/kubecm_alias_docs.md b/docs/en-us/cli/kubecm_alias_docs.md
@@ -0,0 +1,42 @@
+## kubecm alias docs
+
+Open document website
+
+### Synopsis
+
+Open document website in your browser
+
+```
+kubecm alias docs [flags]
+```
+
+### Examples
+
+```
+
+# Open kubecm website
+kubecm docs
+# Open add command document page
+kubecm add docs
+
+```
+
+### Options
+
+```
+  -h, --help   help for docs
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+  -m, --mac-notify      enable to display Mac notification banner
+  -s, --silence-table   enable/disable output of context table on successful config update
+  -u, --ui-size int     number of list items to show in menu at once (default 4)
+```
+
+### SEE ALSO
+
+* [kubecm alias](kubecm_alias.md)	 - Generate alias for all contexts
+
diff --git a/docs/en-us/cli/kubecm_clear.md b/docs/en-us/cli/kubecm_clear.md
@@ -14,7 +14,7 @@ kubecm clear
 
 ```
 
-# Clear lapsed context, cluster and user (default is /Users/guoxudong/.kube/config)
+# Clear lapsed context, cluster and user (default is /Users/guoxd/.kube/config)
 kubecm clear
 # Customised clear lapsed files
 kubecm clear config.yaml test.yaml
@@ -30,13 +30,14 @@ kubecm clear config.yaml test.yaml
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxudong/.kube/config")
+      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
-      --ui-size int     number of list items to show in menu at once (default 4)
+  -u, --ui-size int     number of list items to show in menu at once (default 4)
 ```
 
 ### SEE ALSO
 
 * [kubecm](kubecm.md)	 - KubeConfig Manager.
+* [kubecm clear docs](kubecm_clear_docs.md)	 - Open document website
 
diff --git a/docs/en-us/cli/kubecm_clear_docs.md b/docs/en-us/cli/kubecm_clear_docs.md
@@ -0,0 +1,42 @@
+## kubecm clear docs
+
+Open document website
+
+### Synopsis
+
+Open document website in your browser
+
+```
+kubecm clear docs [flags]
+```
+
+### Examples
+
+```
+
+# Open kubecm website
+kubecm docs
+# Open add command document page
+kubecm add docs
+
+```
+
+### Options
+
+```
+  -h, --help   help for docs
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+  -m, --mac-notify      enable to display Mac notification banner
+  -s, --silence-table   enable/disable output of context table on successful config update
+  -u, --ui-size int     number of list items to show in menu at once (default 4)
+```
+
+### SEE ALSO
+
+* [kubecm clear](kubecm_clear.md)	 - Clear lapsed context, cluster and user
+
diff --git a/docs/en-us/cli/kubecm_cloud.md b/docs/en-us/cli/kubecm_cloud.md
@@ -18,15 +18,16 @@ Manage kubeconfig from cloud
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxudong/.kube/config")
+      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
-      --ui-size int     number of list items to show in menu at once (default 4)
+  -u, --ui-size int     number of list items to show in menu at once (default 4)
 ```
 
 ### SEE ALSO
 
 * [kubecm](kubecm.md)	 - KubeConfig Manager.
 * [kubecm cloud add](kubecm_cloud_add.md)	 - Add kubeconfig from cloud
+* [kubecm cloud docs](kubecm_cloud_docs.md)	 - Open document website
 * [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
@@ -60,12 +60,12 @@ kubecm cloud add --provider alibabacloud --cluster_id=xxxxxx
 
 ```
       --cluster_id string   kubernetes cluster id
-      --config string       path of kubeconfig (default "/Users/guoxudong/.kube/config")
+      --config string       path of kubeconfig (default "/Users/guoxd/.kube/config")
   -m, --mac-notify          enable to display Mac notification banner
       --provider string     public cloud
       --region_id string    cloud region id
   -s, --silence-table       enable/disable output of context table on successful config update
-      --ui-size int         number of list items to show in menu at once (default 4)
+  -u, --ui-size int         number of list items to show in menu at once (default 4)
 ```
 
 ### SEE ALSO

diff --git a/docs/en-us/cli/kubecm_cloud_docs.md b/docs/en-us/cli/kubecm_cloud_docs.md
@@ -0,0 +1,45 @@
+## kubecm cloud docs
+
+Open document website
+
+### Synopsis
+
+Open document website in your browser
+
+```
+kubecm cloud docs [flags]
+```
+
+### Examples
+
+```
+
+# Open kubecm website
+kubecm docs
+# Open add command document page
+kubecm add docs
+
+```
+
+### Options
+
+```
+  -h, --help   help for docs
+```
+
+### Options inherited from parent commands
+
+```
+      --cluster_id string   kubernetes cluster id
+      --config string       path of kubeconfig (default "/Users/guoxd/.kube/config")
+  -m, --mac-notify          enable to display Mac notification banner
+      --provider string     public cloud
+      --region_id string    cloud region id
+  -s, --silence-table       enable/disable output of context table on successful config update
+  -u, --ui-size int         number of list items to show in menu at once (default 4)
+```
+
+### SEE ALSO
+
+* [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
@@ -45,12 +45,12 @@ kubecm cloud list --provider alibabacloud --cluster_id=xxxxxx
 
 ```
       --cluster_id string   kubernetes cluster id
-      --config string       path of kubeconfig (default "/Users/guoxudong/.kube/config")
+      --config string       path of kubeconfig (default "/Users/guoxd/.kube/config")
   -m, --mac-notify          enable to display Mac notification banner
       --provider string     public cloud
       --region_id string    cloud region id
   -s, --silence-table       enable/disable output of context table on successful config update
-      --ui-size int         number of list items to show in menu at once (default 4)
+  -u, --ui-size int         number of list items to show in menu at once (default 4)
 ```
 
 ### SEE ALSO

diff --git a/docs/en-us/cli/kubecm_create.md b/docs/en-us/cli/kubecm_create.md
@@ -28,10 +28,10 @@ kubecm create
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxudong/.kube/config")
+      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
-      --ui-size int     number of list items to show in menu at once (default 4)
+  -u, --ui-size int     number of list items to show in menu at once (default 4)
 ```
 
 ### SEE ALSO

diff --git a/docs/en-us/cli/kubecm_delete.md b/docs/en-us/cli/kubecm_delete.md
@@ -32,13 +32,14 @@ kubecm delete my-context1 my-context2
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxudong/.kube/config")
+      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
-      --ui-size int     number of list items to show in menu at once (default 4)
+  -u, --ui-size int     number of list items to show in menu at once (default 4)
 ```
 
 ### SEE ALSO
 
 * [kubecm](kubecm.md)	 - KubeConfig Manager.
+* [kubecm delete docs](kubecm_delete_docs.md)	 - Open document website
 
diff --git a/docs/en-us/cli/kubecm_delete_docs.md b/docs/en-us/cli/kubecm_delete_docs.md
@@ -0,0 +1,42 @@
+## kubecm delete docs
+
+Open document website
+
+### Synopsis
+
+Open document website in your browser
+
+```
+kubecm delete docs [flags]
+```
+
+### Examples
+
+```
+
+# Open kubecm website
+kubecm docs
+# Open add command document page
+kubecm add docs
+
+```
+
+### Options
+
+```
+  -h, --help   help for docs
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+  -m, --mac-notify      enable to display Mac notification banner
+  -s, --silence-table   enable/disable output of context table on successful config update
+  -u, --ui-size int     number of list items to show in menu at once (default 4)
+```
+
+### SEE ALSO
+
+* [kubecm delete](kubecm_delete.md)	 - Delete the specified context from the kubeconfig
+