Regenrate cli docs (#68)

kubedb · Jun 22, 2017 · 82cfbab · 82cfbab
1 parent 0b9ee2d
commit 82cfbab
Show file tree

Hide file tree

Showing 13 changed files with 75 additions and 7 deletions.
diff --git a/docs/user-guide/reference/kubedb.md → docs/reference/kubedb.md b/docs/user-guide/reference/kubedb.md → docs/reference/kubedb.md
@@ -22,12 +22,14 @@ kubedb [flags]
 ```
 
 ### SEE ALSO
+* [kubedb compare](kubedb_compare.md)	 - Compare summary reports
 * [kubedb create](kubedb_create.md)	 - Create a resource by filename or stdin
 * [kubedb delete](kubedb_delete.md)	 - Delete resources by filenames, stdin, resources and names, or by resources and label selector
 * [kubedb describe](kubedb_describe.md)	 - Show details of a specific resource or group of resources
 * [kubedb edit](kubedb_edit.md)	 - Edit a resource on the server
 * [kubedb get](kubedb_get.md)	 - Display one or many resources
 * [kubedb init](kubedb_init.md)	 - Create or upgrade unified operator
+* [kubedb summarize](kubedb_summarize.md)	 - Export summary report
 * [kubedb version](kubedb_version.md)	 - Prints binary version number.
 
 
diff --git a/docs/reference/kubedb_compare.md b/docs/reference/kubedb_compare.md
@@ -0,0 +1,32 @@
+## kubedb compare
+
+Compare summary reports
+
+### Synopsis
+
+
+Compare summary reports
+
+```
+kubedb compare [flags]
+```
+
+### Options
+
+```
+  -h, --help            help for compare
+      --output string   Directory used to store summary report
+      --show            If true, comparison result will be printed. (default true)
+```
+
+### Options inherited from parent commands
+
+```
+      --analytics             Send events to Google Analytics (default true)
+      --kube-context string   name of the kubeconfig context to use
+```
+
+### SEE ALSO
+* [kubedb](kubedb.md)	 - Controls kubedb objects
+
+
diff --git a/docs/user-guide/reference/kubedb_create.md → docs/reference/kubedb_create.md b/docs/user-guide/reference/kubedb_create.md → docs/reference/kubedb_create.md
diff --git a/docs/user-guide/reference/kubedb_delete.md → docs/reference/kubedb_delete.md b/docs/user-guide/reference/kubedb_delete.md → docs/reference/kubedb_delete.md
diff --git a/docs/user-guide/reference/kubedb_describe.md → docs/reference/kubedb_describe.md b/docs/user-guide/reference/kubedb_describe.md → docs/reference/kubedb_describe.md
diff --git a/docs/user-guide/reference/kubedb_edit.md → docs/reference/kubedb_edit.md b/docs/user-guide/reference/kubedb_edit.md → docs/reference/kubedb_edit.md
diff --git a/docs/user-guide/reference/kubedb_get.md → docs/reference/kubedb_get.md b/docs/user-guide/reference/kubedb_get.md → docs/reference/kubedb_get.md
diff --git a/docs/user-guide/reference/kubedb_init.md → docs/reference/kubedb_init.md b/docs/user-guide/reference/kubedb_init.md → docs/reference/kubedb_init.md
@@ -24,10 +24,10 @@ kubedb init [flags]
 ### Options
 
 ```
-  -h, --help               help for init
-  -n, --namespace string   Namespace name. Operator will be deployed in this namespace. (default "default")
-      --upgrade            If present, Upgrade operator to use provided version
-      --version string     Operator version (default "0.1.0")
+  -h, --help                        help for init
+      --operator-namespace string   Name of namespace where operator will be deployed. (default "kube-system")
+      --upgrade                     If present, Upgrade operator to use provided version
+      --version string              Operator version (default "0.1.0")
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/reference/kubedb_summarize.md b/docs/reference/kubedb_summarize.md
@@ -0,0 +1,34 @@
+## kubedb summarize
+
+Export summary report
+
+### Synopsis
+
+
+Export summary report
+
+```
+kubedb summarize [flags]
+```
+
+### Options
+
+```
+  -h, --help                        help for summarize
+      --index string                Export summary report for this only.
+  -n, --namespace string            Export summary report of the requested object from this namespace. (default "default")
+      --operator-namespace string   Name of namespace where operator is running (default "kube-system")
+      --output string               Directory used to store summary report
+```
+
+### Options inherited from parent commands
+
+```
+      --analytics             Send events to Google Analytics (default true)
+      --kube-context string   name of the kubeconfig context to use
+```
+
+### SEE ALSO
+* [kubedb](kubedb.md)	 - Controls kubedb objects
+
+
diff --git a/docs/user-guide/reference/kubedb_version.md → docs/reference/kubedb_version.md b/docs/user-guide/reference/kubedb_version.md → docs/reference/kubedb_version.md
diff --git a/docs/user-guide/tutorial.md b/docs/user-guide/tutorial.md
@@ -7,7 +7,7 @@
 We can deploy this operator using `kubedb` CLI.
 
 ```bash
-$ kubedb init --namespace='default' --version='0.1.0'
+$ kubedb init
 
 Successfully created operator deployment.
 Successfully created operator service.

diff --git a/hack/gendocs/main.go b/hack/gendocs/main.go
@@ -13,7 +13,7 @@ import (
 // ref: https://github.com/spf13/cobra/blob/master/doc/md_docs.md
 func main() {
 	rootCmd := pkg.NewKubedbCommand(os.Stdin, os.Stdout, os.Stderr, "0.0.0")
-	dir := runtime.GOPath() + "/src/github.com/k8sdb/cli/docs/user-guide/reference"
+	dir := runtime.GOPath() + "/src/github.com/k8sdb/cli/docs/reference"
 	fmt.Printf("Generating cli markdown tree in: %v\n", dir)
 	err := os.MkdirAll(dir, 0755)
 	if err != nil {

diff --git a/hack/gendocs/make.sh b/hack/gendocs/make.sh
@@ -3,6 +3,6 @@
 pushd $GOPATH/src/github.com/k8sdb/cli/hack/gendocs
 go run main.go
 
-cd $GOPATH/src/github.com/k8sdb/cli/docs/user-guide/reference
+cd $GOPATH/src/github.com/k8sdb/cli/docs/reference
 sed -i 's/######\ Auto\ generated\ by.*//g' *
 popd