Skip to content

Commit e027242

Browse files
committed
Update CONTRIBUTING.md
1 parent 66038e2 commit e027242

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ node_groups:
169169
Add this to your bash profile (e.g. `~/.bash_profile`, `~/.profile` or `~/.bashrc`), replacing the placeholders accordingly:
170170

171171
```bash
172-
# set the default image for APIs
172+
# set the default image registry
173173
export CORTEX_DEV_DEFAULT_IMAGE_REGISTRY="<account_id>.dkr.ecr.<region>.amazonaws.com/cortexlabs"
174174
175175
# redirect analytics and error reporting to our dev environment
@@ -209,7 +209,7 @@ Here is the typical full dev workflow which covers most cases:
209209
1. `make cluster-up` (creates a cluster using `dev/config/cluster.yaml`)
210210
2. `make devstart` (deletes the in-cluster operator, builds the CLI, and starts the operator locally; file changes will trigger the CLI and operator to re-build)
211211
3. Make your changes
212-
4. `make images-dev` (only necessary if API images or the manager are modified)
212+
4. `make images-dev` (only necessary if changes were made outside of the operator and CLI)
213213
5. Test your changes e.g. via `cortex deploy` (and repeat steps 3 and 4 as necessary)
214214
6. `make cluster-down` (deletes your cluster)
215215

@@ -224,6 +224,4 @@ If you are only modifying the CLI, `make cli-watch` will build the CLI and re-bu
224224

225225
If you are only modifying the operator, `make operator-local` will build and start the operator locally, and build/restart it when files are changed.
226226

227-
If you are modifying code in the API images (i.e. any of the Python serving code), `make images-dev` may build more images than you need during testing. For example, if you are only testing using the `python-handler-cpu` image, you can run `./dev/registry.sh update-single python-handler-cpu`.
228-
229227
See `Makefile` for additional dev commands.

0 commit comments

Comments
 (0)