Skip to content

Commit

Permalink
chore: docs fixes (#165)
Browse files Browse the repository at this point in the history
  • Loading branch information
punit-kulal authored Aug 9, 2023
1 parent 941e049 commit d549cc7
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,7 @@ vendor/
/stencil
/config.yaml
node_modules

__debug*
example

2 changes: 1 addition & 1 deletion config/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ timeout: 5s
newrelic:
appname: example
enabled: false
license: "<key>"
license: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
# Database configurations for stencil backend
db:
# Connection string for postgres database
Expand Down
14 changes: 8 additions & 6 deletions docs/docs/guides/1_quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,27 +121,29 @@ $ echo "{
<TabItem value="cli" label="CLI">

```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
```

</TabItem>
Expand Down

0 comments on commit d549cc7

Please sign in to comment.