From 8ea9ac8ff5592a46208064498fe2f0f42f385bec Mon Sep 17 00:00:00 2001 From: Shahidh K Muhammed Date: Mon, 29 Oct 2018 17:56:32 +0530 Subject: [PATCH 1/2] remove cli docs --- cli/Makefile | 6 ---- cli/docs/README.md | 3 -- cli/docs/hasura.md | 25 ---------------- cli/docs/hasura_console.md | 47 ------------------------------ cli/docs/hasura_init.md | 47 ------------------------------ cli/docs/hasura_metadata.md | 29 ------------------ cli/docs/hasura_metadata_apply.md | 39 ------------------------- cli/docs/hasura_metadata_export.md | 39 ------------------------- cli/docs/hasura_metadata_reset.md | 39 ------------------------- cli/docs/hasura_migrate.md | 29 ------------------ cli/docs/hasura_migrate_apply.md | 36 ----------------------- cli/docs/hasura_migrate_create.md | 30 ------------------- cli/docs/hasura_migrate_status.md | 32 -------------------- cli/docs/hasura_version.md | 30 ------------------- 14 files changed, 431 deletions(-) delete mode 100644 cli/docs/README.md delete mode 100644 cli/docs/hasura.md delete mode 100644 cli/docs/hasura_console.md delete mode 100644 cli/docs/hasura_init.md delete mode 100644 cli/docs/hasura_metadata.md delete mode 100644 cli/docs/hasura_metadata_apply.md delete mode 100644 cli/docs/hasura_metadata_export.md delete mode 100644 cli/docs/hasura_metadata_reset.md delete mode 100644 cli/docs/hasura_migrate.md delete mode 100644 cli/docs/hasura_migrate_apply.md delete mode 100644 cli/docs/hasura_migrate_create.md delete mode 100644 cli/docs/hasura_migrate_status.md delete mode 100644 cli/docs/hasura_version.md diff --git a/cli/Makefile b/cli/Makefile index ad33f707ebd57..335c8ff6a4ebc 100644 --- a/cli/Makefile +++ b/cli/Makefile @@ -53,12 +53,6 @@ ci-copy-binary: test: go test -ldflags "-X github.com/hasura/graphql-engine/cli/version.BuildVersion=$(VERSION)" ./... -# generate docs -.PHONY: docs -docs: - rm -fr docs - go run cmd/hasura/hasura.go docs --type md --directory docs - # clean the output directory .PHONY: clean clean: diff --git a/cli/docs/README.md b/cli/docs/README.md deleted file mode 100644 index 43f1dfe34eb11..0000000000000 --- a/cli/docs/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Hasura GraphQL Engine CLI Docs - -See [hasura](hasura.md). diff --git a/cli/docs/hasura.md b/cli/docs/hasura.md deleted file mode 100644 index 26b4d098e5a8e..0000000000000 --- a/cli/docs/hasura.md +++ /dev/null @@ -1,25 +0,0 @@ -## hasura - -Hasura GraphQL Engine command line tool - -### Synopsis - -Hasura GraphQL Engine command line tool - -### Options - -``` - -h, --help help for hasura - --log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO") - --project string directory where commands are executed. (default: current dir) -``` - -### SEE ALSO - -* [hasura console](hasura_console.md) - Open console to manage database and try out APIs -* [hasura init](hasura_init.md) - Initialize directory for Hasura GraphQL Engine migrations -* [hasura metadata](hasura_metadata.md) - Manage Hasura GraphQL Engine metdata saved in the database -* [hasura migrate](hasura_migrate.md) - Manage migrations on the database -* [hasura version](hasura_version.md) - Print the CLI version - -###### Auto generated by spf13/cobra on 28-Sep-2018 diff --git a/cli/docs/hasura_console.md b/cli/docs/hasura_console.md deleted file mode 100644 index 54d3b2acb36b3..0000000000000 --- a/cli/docs/hasura_console.md +++ /dev/null @@ -1,47 +0,0 @@ -## hasura console - -Open console to manage database and try out APIs - -### Synopsis - -Run a web server to serve Hasura Console for GraphQL Engine to manage database and build queries - -``` -hasura console [flags] -``` - -### Examples - -``` - # Start console: - hasura console - - # Start console on a different address and ports: - hasura console --address 0.0.0.0 --console-port 8080 --api-port 8081 -``` - -### Options - -``` - --access-key string access key for Hasura GraphQL Engine - --address string address to use (default "localhost") - --api-port string port for serving migrate api (default "9693") - --console-port string port for serving console (default "9695") - --endpoint string http(s) endpoint for Hasura GraphQL Engine - -h, --help help for console - --no-browser do not automatically open console in browser - --static-dir string directory where static assets mentioned in the console html template can be served from -``` - -### Options inherited from parent commands - -``` - --log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO") - --project string directory where commands are executed. (default: current dir) -``` - -### SEE ALSO - -* [hasura](hasura.md) - Hasura GraphQL Engine command line tool - -###### Auto generated by spf13/cobra on 28-Sep-2018 \ No newline at end of file diff --git a/cli/docs/hasura_init.md b/cli/docs/hasura_init.md deleted file mode 100644 index 9c2b51c367470..0000000000000 --- a/cli/docs/hasura_init.md +++ /dev/null @@ -1,47 +0,0 @@ -## hasura init - -Initialize directory for Hasura GraphQL Engine migrations - -### Synopsis - -Create directories and files required for enabling migrations on Hasura GraphQL Engine - -``` -hasura init [flags] -``` - -### Examples - -``` - # Create a directory to store migrations - hasura init - - # Now, edit /config.yaml to add endpoint and access key - - # Create a directory with endpoint and access key configured: - hasura init --directory --endpoint https://my-graphql-engine.com --access-key secretaccesskey - - # See https://docs.hasura.io/1.0/graphql/manual/migrations/index.html for more details -``` - -### Options - -``` - --access-key string access key for Hasura GraphQL Engine - --directory string name of directory where files will be created - --endpoint string http(s) endpoint for Hasura GraphQL Engine - -h, --help help for init -``` - -### Options inherited from parent commands - -``` - --log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO") - --project string directory where commands are executed. (default: current dir) -``` - -### SEE ALSO - -* [hasura](hasura.md) - Hasura GraphQL Engine command line tool - -###### Auto generated by spf13/cobra on 28-Sep-2018 diff --git a/cli/docs/hasura_metadata.md b/cli/docs/hasura_metadata.md deleted file mode 100644 index 97c2dadbdb73b..0000000000000 --- a/cli/docs/hasura_metadata.md +++ /dev/null @@ -1,29 +0,0 @@ -## hasura metadata - -Manage Hasura GraphQL Engine metdata saved in the database - -### Synopsis - -Manage Hasura GraphQL Engine metdata saved in the database - -### Options - -``` - -h, --help help for metadata -``` - -### Options inherited from parent commands - -``` - --log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO") - --project string directory where commands are executed. (default: current dir) -``` - -### SEE ALSO - -* [hasura](hasura.md) - Hasura GraphQL Engine command line tool -* [hasura metadata apply](hasura_metadata_apply.md) - Apply Hasura metadata on a database -* [hasura metadata export](hasura_metadata_export.md) - Export Hasura GraphQL Engine metadata from the database -* [hasura metadata reset](hasura_metadata_reset.md) - Reset or clean Hasura GraphQL Engine metadata on the database - -###### Auto generated by spf13/cobra on 28-Sep-2018 diff --git a/cli/docs/hasura_metadata_apply.md b/cli/docs/hasura_metadata_apply.md deleted file mode 100644 index 8ac5131bbeec7..0000000000000 --- a/cli/docs/hasura_metadata_apply.md +++ /dev/null @@ -1,39 +0,0 @@ -## hasura metadata apply - -Apply Hasura metadata on a database - -### Synopsis - -Apply Hasura metadata on a database - -``` -hasura metadata apply [flags] -``` - -### Examples - -``` - # Apply Hasura GraphQL Engine metadata present in metadata.yaml file: - hasura metadata apply -``` - -### Options - -``` - --access-key string access key for Hasura GraphQL Engine - --endpoint string http(s) endpoint for Hasura GraphQL Engine - -h, --help help for apply -``` - -### Options inherited from parent commands - -``` - --log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO") - --project string directory where commands are executed. (default: current dir) -``` - -### SEE ALSO - -* [hasura metadata](hasura_metadata.md) - Manage Hasura GraphQL Engine metdata saved in the database - -###### Auto generated by spf13/cobra on 28-Sep-2018 diff --git a/cli/docs/hasura_metadata_export.md b/cli/docs/hasura_metadata_export.md deleted file mode 100644 index 0e5e19a590fef..0000000000000 --- a/cli/docs/hasura_metadata_export.md +++ /dev/null @@ -1,39 +0,0 @@ -## hasura metadata export - -Export Hasura GraphQL Engine metadata from the database - -### Synopsis - -Export Hasura GraphQL Engine metadata from the database - -``` -hasura metadata export [flags] -``` - -### Examples - -``` - # Export metadata and save it in metadata.yaml file: - hasura metadata export -``` - -### Options - -``` - --access-key string access key for Hasura GraphQL Engine - --endpoint string http(s) endpoint for Hasura GraphQL Engine - -h, --help help for export -``` - -### Options inherited from parent commands - -``` - --log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO") - --project string directory where commands are executed. (default: current dir) -``` - -### SEE ALSO - -* [hasura metadata](hasura_metadata.md) - Manage Hasura GraphQL Engine metdata saved in the database - -###### Auto generated by spf13/cobra on 28-Sep-2018 diff --git a/cli/docs/hasura_metadata_reset.md b/cli/docs/hasura_metadata_reset.md deleted file mode 100644 index 2188b96a1ab2f..0000000000000 --- a/cli/docs/hasura_metadata_reset.md +++ /dev/null @@ -1,39 +0,0 @@ -## hasura metadata reset - -Reset or clean Hasura GraphQL Engine metadata on the database - -### Synopsis - -Reset or clean Hasura GraphQL Engine metadata on the database - -``` -hasura metadata reset [flags] -``` - -### Examples - -``` - # Clean all the metadata information from database: - hasura metadata reset -``` - -### Options - -``` - --access-key string access key for Hasura GraphQL Engine - --endpoint string http(s) endpoint for Hasura GraphQL Engine - -h, --help help for reset -``` - -### Options inherited from parent commands - -``` - --log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO") - --project string directory where commands are executed. (default: current dir) -``` - -### SEE ALSO - -* [hasura metadata](hasura_metadata.md) - Manage Hasura GraphQL Engine metdata saved in the database - -###### Auto generated by spf13/cobra on 28-Sep-2018 diff --git a/cli/docs/hasura_migrate.md b/cli/docs/hasura_migrate.md deleted file mode 100644 index c9d66a73b7292..0000000000000 --- a/cli/docs/hasura_migrate.md +++ /dev/null @@ -1,29 +0,0 @@ -## hasura migrate - -Manage migrations on the database - -### Synopsis - -Manage migrations on the database - -### Options - -``` - -h, --help help for migrate -``` - -### Options inherited from parent commands - -``` - --log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO") - --project string directory where commands are executed. (default: current dir) -``` - -### SEE ALSO - -* [hasura](hasura.md) - Hasura GraphQL Engine command line tool -* [hasura migrate apply](hasura_migrate_apply.md) - Apply migrations on the database -* [hasura migrate create](hasura_migrate_create.md) - Create files required for a migration -* [hasura migrate status](hasura_migrate_status.md) - Display current status of migrations on a database - -###### Auto generated by spf13/cobra on 28-Sep-2018 diff --git a/cli/docs/hasura_migrate_apply.md b/cli/docs/hasura_migrate_apply.md deleted file mode 100644 index 6cf843418035b..0000000000000 --- a/cli/docs/hasura_migrate_apply.md +++ /dev/null @@ -1,36 +0,0 @@ -## hasura migrate apply - -Apply migrations on the database - -### Synopsis - -Apply migrations on the database - -``` -hasura migrate apply [flags] -``` - -### Options - -``` - --access-key string access key for Hasura GraphQL Engine - --down string apply all or N down migration steps - --endpoint string http(s) endpoint for Hasura GraphQL Engine - -h, --help help for apply - --type string type of migration (up, down) to be used with version flag (default "up") - --up string apply all or N up migration steps - --version string migrate the database to a specific version -``` - -### Options inherited from parent commands - -``` - --log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO") - --project string directory where commands are executed. (default: current dir) -``` - -### SEE ALSO - -* [hasura migrate](hasura_migrate.md) - Manage migrations on the database - -###### Auto generated by spf13/cobra on 28-Sep-2018 diff --git a/cli/docs/hasura_migrate_create.md b/cli/docs/hasura_migrate_create.md deleted file mode 100644 index d0d3ae1e18dba..0000000000000 --- a/cli/docs/hasura_migrate_create.md +++ /dev/null @@ -1,30 +0,0 @@ -## hasura migrate create - -Create files required for a migration - -### Synopsis - -Create sql and yaml files required for a migration - -``` -hasura migrate create [migration-name] [flags] -``` - -### Options - -``` - -h, --help help for create -``` - -### Options inherited from parent commands - -``` - --log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO") - --project string directory where commands are executed. (default: current dir) -``` - -### SEE ALSO - -* [hasura migrate](hasura_migrate.md) - Manage migrations on the database - -###### Auto generated by spf13/cobra on 28-Sep-2018 diff --git a/cli/docs/hasura_migrate_status.md b/cli/docs/hasura_migrate_status.md deleted file mode 100644 index 742effdf8bab1..0000000000000 --- a/cli/docs/hasura_migrate_status.md +++ /dev/null @@ -1,32 +0,0 @@ -## hasura migrate status - -Display current status of migrations on a database - -### Synopsis - -Display current status of migrations on a database - -``` -hasura migrate status [flags] -``` - -### Options - -``` - --access-key string access key for Hasura GraphQL Engine - --endpoint string http(s) endpoint for Hasura GraphQL Engine - -h, --help help for status -``` - -### Options inherited from parent commands - -``` - --log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO") - --project string directory where commands are executed. (default: current dir) -``` - -### SEE ALSO - -* [hasura migrate](hasura_migrate.md) - Manage migrations on the database - -###### Auto generated by spf13/cobra on 28-Sep-2018 diff --git a/cli/docs/hasura_version.md b/cli/docs/hasura_version.md deleted file mode 100644 index 6683fb21ad968..0000000000000 --- a/cli/docs/hasura_version.md +++ /dev/null @@ -1,30 +0,0 @@ -## hasura version - -Print the CLI version - -### Synopsis - -Print the CLI version - -``` -hasura version [flags] -``` - -### Options - -``` - -h, --help help for version -``` - -### Options inherited from parent commands - -``` - --log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO") - --project string directory where commands are executed. (default: current dir) -``` - -### SEE ALSO - -* [hasura](hasura.md) - Hasura GraphQL Engine command line tool - -###### Auto generated by spf13/cobra on 28-Sep-2018 From 8ce0581c3d1faa2530e74c59d94cc2e8c7843746 Mon Sep 17 00:00:00 2001 From: Shahidh K Muhammed Date: Mon, 29 Oct 2018 18:07:49 +0530 Subject: [PATCH 2/2] remove docs reference from cli readme --- cli/README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/cli/README.md b/cli/README.md index a08aa6bd0fc64..7b0dc1272be6b 100644 --- a/cli/README.md +++ b/cli/README.md @@ -37,10 +37,6 @@ cd hasura console ``` -## Docs - -Read complete docs [here](docs/hasura.md). - ## Contributing Checkout the [contributing guide](CONTRIBUTING.md).