Skip to content

Commit 8a3fbc1

Browse files
authored
docs: correction (#193)
* docs: correction On-behalf-of: @SAP [email protected] Signed-off-by: Artem Shcherbatiuk <[email protected]>
1 parent 8b22ff9 commit 8a3fbc1

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/quickstart.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,8 @@ This page shows you how to get started to use the GraphQL Gateway for Kubernetes
1414
git clone [email protected]:openmfp/kubernetes-graphql-gateway.git && cd kubernetes-graphql-gateway
1515
```
1616

17-
## Running the API Listener
1817

19-
1. Setup the environment:
18+
## Setup the environment:
2019
```shell
2120
# this will disable authorization
2221
export LOCAL_DEVELOPMENT=true
@@ -25,15 +24,20 @@ export ENABLE_KCP=false
2524
# you must point to the config of the cluster you want to run against
2625
export KUBECONFIG=YOUR_KUBECONFIG_PATH
2726
```
28-
2. In the same shell, run the listener:
27+
## Running the Listener
28+
29+
Make sure you have done steps from the [setup section](#setup-the-environment).
30+
2931
```shell
3032
task listener
3133
```
3234
This will create a directory `./bin/definitions` and start watching the cluster APIs for changes.
3335
In that directory a file will be created for each workspace in KCP or a standard Kubernetes cluster.
3436
The file will contain the API definitions for the resources in that workspace.
3537

36-
## Running the GraphQL Gateway
38+
## Running the Gateway
39+
40+
Make sure you have done steps from the [setup section](#setup-the-environment).
3741

3842
In the root directory of the `kubernetes-graphql-gateway` repository, open a new shell and run the Graphql gateway as follows:
3943
```shell

0 commit comments

Comments
 (0)