better docs

graphikDB · Dec 28, 2020 · 61bac1f · 61bac1f
1 parent 2e395b3
commit 61bac1f
Show file tree

Hide file tree

Showing 21 changed files with 24 additions and 24 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.3
+current_version = 0.0.4
 commit = False
 tag = False
 

diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-version := "0.0.3"
+version := "0.0.4"
 
 .DEFAULT_GOAL := help
 

diff --git a/cmd/config/config.go b/cmd/config/config.go
@@ -14,7 +14,7 @@ func init() {
 
 var Config = &cobra.Command{
 	Use:     "config",
-	Short:   "configuration subcommands (get)",
+	Short:   "configuration subcommands (get, open)",
 	Version: version.Version,
 }
 

diff --git a/cmd/graph/create.go b/cmd/graph/create.go
@@ -30,7 +30,7 @@ func init() {
 
 var Create = &cobra.Command{
 	Use:   "create",
-	Short: "graphikDB create operations",
+	Short: "graphikDB create operations (doc, connection)",
 }
 
 var createDocCmd = &cobra.Command{

diff --git a/cmd/graph/get.go b/cmd/graph/get.go
@@ -19,7 +19,7 @@ func init() {
 
 var Get = &cobra.Command{
 	Use:   "get",
-	Short: "graphikDB get operations",
+	Short: "graphikDB get operations (doc, connection, schema)",
 }
 
 var docsCmd = &cobra.Command{

diff --git a/cmd/graph/search.go b/cmd/graph/search.go
@@ -23,7 +23,7 @@ func init() {
 
 var Search = &cobra.Command{
 	Use:   "search",
-	Short: "graphikDB search operations",
+	Short: "graphikDB search operations  (docs, connections)",
 }
 
 var searchDocs = &cobra.Command{

diff --git a/docs/graphikctl.md b/docs/graphikctl.md
@@ -21,9 +21,9 @@ env-prefix: GRAPHIKCTL
 ### SEE ALSO
 
 * [graphikctl auth](graphikctl_auth.md)	 - authentication/authorization subcommands (login)
-* [graphikctl config](graphikctl_config.md)	 - configuration subcommands (get)
-* [graphikctl create](graphikctl_create.md)	 - graphikDB create operations
-* [graphikctl get](graphikctl_get.md)	 - graphikDB get operations
-* [graphikctl search](graphikctl_search.md)	 - graphikDB search operations
+* [graphikctl config](graphikctl_config.md)	 - configuration subcommands (get, open)
+* [graphikctl create](graphikctl_create.md)	 - graphikDB create operations (doc, connection)
+* [graphikctl get](graphikctl_get.md)	 - graphikDB get operations (doc, connection, schema)
+* [graphikctl search](graphikctl_search.md)	 - graphikDB search operations  (docs, connections)
 
 ###### Auto generated by spf13/cobra on 27-Dec-2020
diff --git a/docs/graphikctl_config.md b/docs/graphikctl_config.md
@@ -1,6 +1,6 @@
 ## graphikctl config
 
-configuration subcommands (get)
+configuration subcommands (get, open)
 
 ### Options
 

diff --git a/docs/graphikctl_config_get.md b/docs/graphikctl_config_get.md
@@ -20,6 +20,6 @@ graphikctl config get [flags]
 
 ### SEE ALSO
 
-* [graphikctl config](graphikctl_config.md)	 - configuration subcommands (get)
+* [graphikctl config](graphikctl_config.md)	 - configuration subcommands (get, open)
 
 ###### Auto generated by spf13/cobra on 27-Dec-2020
diff --git a/docs/graphikctl_config_open.md b/docs/graphikctl_config_open.md
@@ -20,6 +20,6 @@ graphikctl config open [flags]
 
 ### SEE ALSO
 
-* [graphikctl config](graphikctl_config.md)	 - configuration subcommands (get)
+* [graphikctl config](graphikctl_config.md)	 - configuration subcommands (get, open)
 
 ###### Auto generated by spf13/cobra on 27-Dec-2020
diff --git a/docs/graphikctl_create.md b/docs/graphikctl_create.md
@@ -1,6 +1,6 @@
 ## graphikctl create
 
-graphikDB create operations
+graphikDB create operations (doc, connection)
 
 ### Options
 

diff --git a/docs/graphikctl_create_connection.md b/docs/graphikctl_create_connection.md
@@ -28,6 +28,6 @@ graphikctl create connection [flags]
 
 ### SEE ALSO
 
-* [graphikctl create](graphikctl_create.md)	 - graphikDB create operations
+* [graphikctl create](graphikctl_create.md)	 - graphikDB create operations (doc, connection)
 
 ###### Auto generated by spf13/cobra on 27-Dec-2020
diff --git a/docs/graphikctl_create_doc.md b/docs/graphikctl_create_doc.md
@@ -29,6 +29,6 @@ graphikctl create doc --gtype task --attributes '{ "title": "this is a title", "
 
 ### SEE ALSO
 
-* [graphikctl create](graphikctl_create.md)	 - graphikDB create operations
+* [graphikctl create](graphikctl_create.md)	 - graphikDB create operations (doc, connection)
 
 ###### Auto generated by spf13/cobra on 27-Dec-2020
diff --git a/docs/graphikctl_get.md b/docs/graphikctl_get.md
@@ -1,6 +1,6 @@
 ## graphikctl get
 
-graphikDB get operations
+graphikDB get operations (doc, connection, schema)
 
 ### Options
 

diff --git a/docs/graphikctl_get_connection.md b/docs/graphikctl_get_connection.md
@@ -28,6 +28,6 @@ graphikctl get connection --gtype edited --gid 1mGJsm5AFOsAKqUZXZu8OCXuIci
 
 ### SEE ALSO
 
-* [graphikctl get](graphikctl_get.md)	 - graphikDB get operations
+* [graphikctl get](graphikctl_get.md)	 - graphikDB get operations (doc, connection, schema)
 
 ###### Auto generated by spf13/cobra on 27-Dec-2020
diff --git a/docs/graphikctl_get_doc.md b/docs/graphikctl_get_doc.md
@@ -28,6 +28,6 @@ graphikctl get doc --gtype task --gid 1mGJsm5AFOsAKqUZXZu8OCXuIci
 
 ### SEE ALSO
 
-* [graphikctl get](graphikctl_get.md)	 - graphikDB get operations
+* [graphikctl get](graphikctl_get.md)	 - graphikDB get operations (doc, connection, schema)
 
 ###### Auto generated by spf13/cobra on 27-Dec-2020
diff --git a/docs/graphikctl_get_schema.md b/docs/graphikctl_get_schema.md
@@ -28,6 +28,6 @@ graphikctl get schema
 
 ### SEE ALSO
 
-* [graphikctl get](graphikctl_get.md)	 - graphikDB get operations
+* [graphikctl get](graphikctl_get.md)	 - graphikDB get operations (doc, connection, schema)
 
 ###### Auto generated by spf13/cobra on 27-Dec-2020
diff --git a/docs/graphikctl_search.md b/docs/graphikctl_search.md
@@ -1,6 +1,6 @@
 ## graphikctl search
 
-graphikDB search operations
+graphikDB search operations  (docs, connections)
 
 ### Options
 

diff --git a/docs/graphikctl_search_connections.md b/docs/graphikctl_search_connections.md
@@ -27,6 +27,6 @@ graphikctl search connections [flags]
 
 ### SEE ALSO
 
-* [graphikctl search](graphikctl_search.md)	 - graphikDB search operations
+* [graphikctl search](graphikctl_search.md)	 - graphikDB search operations  (docs, connections)
 
 ###### Auto generated by spf13/cobra on 27-Dec-2020
diff --git a/docs/graphikctl_search_docs.md b/docs/graphikctl_search_docs.md
@@ -27,6 +27,6 @@ graphikctl search docs [flags]
 
 ### SEE ALSO
 
-* [graphikctl search](graphikctl_search.md)	 - graphikDB search operations
+* [graphikctl search](graphikctl_search.md)	 - graphikDB search operations  (docs, connections)
 
 ###### Auto generated by spf13/cobra on 27-Dec-2020
diff --git a/version/version.go b/version/version.go
@@ -1,3 +1,3 @@
 package version
 
-const Version = "0.0.3"
+const Version = "0.0.4"