From d549cc75635dd7372b7d9020c730238da2314e2c Mon Sep 17 00:00:00 2001 From: Punit Kulal Date: Wed, 9 Aug 2023 22:28:47 +0530 Subject: [PATCH] chore: docs fixes (#165) --- .gitignore | 4 ++++ config/config.yaml | 2 +- docs/docs/guides/1_quickstart.md | 14 ++++++++------ 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index ab3c6c1b..c2ae81f5 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,7 @@ vendor/ /stencil /config.yaml node_modules + +__debug* +example + diff --git a/config/config.yaml b/config/config.yaml index 84d716df..29f51613 100644 --- a/config/config.yaml +++ b/config/config.yaml @@ -18,7 +18,7 @@ timeout: 5s newrelic: appname: example enabled: false - license: "" + license: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" # Database configurations for stencil backend db: # Connection string for postgres database diff --git a/docs/docs/guides/1_quickstart.md b/docs/docs/guides/1_quickstart.md index 73d56dab..eb049f15 100644 --- a/docs/docs/guides/1_quickstart.md +++ b/docs/docs/guides/1_quickstart.md @@ -121,27 +121,29 @@ $ echo "{ ```bash +# --host does not contain the protocol scheme http:// since they internally use GRPC. + # Create namespace named "quickstart" with backward compatibility enabled -$ stencil namespace create quickstart -c COMPATIBILITY_BACKWARD -f FORMAT_PROTOBUF -d "For quickstart guide" --host http://localhost:8000 +$ stencil namespace create quickstart -c COMPATIBILITY_BACKWARD -f FORMAT_PROTOBUF -d "For quickstart guide" --host localhost:8000 # List namespaces -$ stencil namespace list --host http://localhost:8000 +$ stencil namespace list --host localhost:8000 # Upload generated schema proto descriptor file to server with schema name as `example` under `quickstart` namespace. $ stencil schema create example --namespace=quickstart –-filePath=schema.desc # Get list of schemas available in a namespace -$ stencil schema list --host http://localhost:8000 +$ stencil schema list --host localhost:8000 # Get list of versions available for particular schema. These versions are auto generated. # Version numbers managed by stencil. -$ stencil schema version example -n quickstart --host http://localhost:8000 +$ stencil schema version example -n quickstart --host localhost:8000 # Download specific version of particular schema -$ stencil schema get example --version 1 --host http://localhost:8000 +$ stencil schema get example --version 1 --host localhost:8000 # Download latest version of particular schema -$ stencil schema get example -n quickstart --host http://localhost:8000 +$ stencil schema get example -n quickstart --host localhost:8000 ```