Skip to content

Commit d89554c

Browse files
committed
Add 'npm run watch' to quick guide.
1 parent 43b4cc9 commit d89554c

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/develop-quickstart.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,19 @@ In order to install these packages, you need to configure your `.npmrc` file to
5353
cd kpt-functions-sdk/ts/hello-world
5454
```
5555
56-
2. Install all dependencies and build the package:
56+
2. Install all dependencies:
5757
5858
```sh
5959
npm install
6060
```
61+
62+
3. Run the following in a separate terminal to continuously build your function as you make changes:
6163
62-
3. Run the `label_namespace` function:
64+
```sh
65+
npm run watch
66+
```
67+
68+
4. Run the `label_namespace` function:
6369
6470
```sh
6571
export CONFIGS=../../example-configs
@@ -76,8 +82,8 @@ In order to install these packages, you need to configure your `.npmrc` file to
7682
git diff $CONFIGS
7783
```
7884
79-
4. Try modifying the function in `src/label_namespace.ts` to perform other operations
80-
on `example-configs`, then repeat steps 2 and 3.
85+
5. Try modifying the function in `src/label_namespace.ts` to perform other operations
86+
on `example-configs`, then repeat step 4.
8187
8288
The function should implement the `KptFunc` interface [documented here][api-kptfunc].
8389
@@ -94,4 +100,4 @@ In order to install these packages, you need to configure your `.npmrc` file to
94100
[install-docker]: https://docs.docker.com/v17.09/engine/installation
95101
[download-kpt]: https://github.com/GoogleContainerTools/kpt
96102
[demo-funcs]: https://github.com/GoogleContainerTools/kpt-functions-sdk/tree/master/ts/demo-functions/src
97-
[api-kptfunc]: api/interfaces/_types_.kptfunc.md
103+
[api-kptfunc]: api/interfaces/_types_.kptfunc.md

0 commit comments

Comments
 (0)