Skip to content

Commit d549cc7

Browse files
authored
chore: docs fixes (#165)
1 parent 941e049 commit d549cc7

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,7 @@ vendor/
2525
/stencil
2626
/config.yaml
2727
node_modules
28+
29+
__debug*
30+
example
31+

config/config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ timeout: 5s
1818
newrelic:
1919
appname: example
2020
enabled: false
21-
license: "<key>"
21+
license: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
2222
# Database configurations for stencil backend
2323
db:
2424
# Connection string for postgres database

docs/docs/guides/1_quickstart.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,27 +121,29 @@ $ echo "{
121121
<TabItem value="cli" label="CLI">
122122

123123
```bash
124+
# --host does not contain the protocol scheme http:// since they internally use GRPC.
125+
124126
# Create namespace named "quickstart" with backward compatibility enabled
125-
$ stencil namespace create quickstart -c COMPATIBILITY_BACKWARD -f FORMAT_PROTOBUF -d "For quickstart guide" --host http://localhost:8000
127+
$ stencil namespace create quickstart -c COMPATIBILITY_BACKWARD -f FORMAT_PROTOBUF -d "For quickstart guide" --host localhost:8000
126128

127129
# List namespaces
128-
$ stencil namespace list --host http://localhost:8000
130+
$ stencil namespace list --host localhost:8000
129131

130132
# Upload generated schema proto descriptor file to server with schema name as `example` under `quickstart` namespace.
131133
$ stencil schema create example --namespace=quickstart –-filePath=schema.desc
132134

133135
# Get list of schemas available in a namespace
134-
$ stencil schema list --host http://localhost:8000
136+
$ stencil schema list --host localhost:8000
135137

136138
# Get list of versions available for particular schema. These versions are auto generated.
137139
# Version numbers managed by stencil.
138-
$ stencil schema version example -n quickstart --host http://localhost:8000
140+
$ stencil schema version example -n quickstart --host localhost:8000
139141

140142
# Download specific version of particular schema
141-
$ stencil schema get example --version 1 --host http://localhost:8000
143+
$ stencil schema get example --version 1 --host localhost:8000
142144

143145
# Download latest version of particular schema
144-
$ stencil schema get example -n quickstart --host http://localhost:8000
146+
$ stencil schema get example -n quickstart --host localhost:8000
145147
```
146148

147149
</TabItem>

0 commit comments

Comments
 (0)