Skip to content

Commit 894e538

Browse files
committed
Update developer documentation
1 parent e117e38 commit 894e538

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

docker-compose.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# DJ_VERSION=$(grep -oP '\d+\.\d+\.\d+' datajoint/version.py) docker compose --profile test up --build --exit-code-from djtest djtest
1+
# HOST_UID=$(id -u) PY_VER=3.11 DJ_VERSION=$(grep -oP '\d+\.\d+\.\d+' datajoint/version.py) docker compose --profile test up --build --exit-code-from djtest djtest
22
services:
33
db:
44
image: datajoint/mysql:${MYSQL_VER:-8.0}

docs/src/develop.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,20 @@ Here are some options that provide a great developer experience:
1111
- Build time for a 2-Core codespace is **~6m**. This is done infrequently and cached for convenience.
1212
- Start time for a 2-Core codespace is **~2m**. This will pull the built codespace from cache when you need it.
1313
- *Tip*: GitHub auto names the codespace but you can rename the codespace so that it is easier to identify later.
14-
- **Local IDE**:
14+
- **Local IDE (VSCode - Dev Containers)**:
1515
- Ensure you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
1616
- Ensure you have [Docker](https://docs.docker.com/get-docker/)
1717
- Ensure you have [VSCode](https://code.visualstudio.com/)
1818
- Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
1919
- `git clone` the codebase repository and open it in VSCode
2020
- Use the `Dev Containers extension` to `Reopen in Container` (More info in the `Getting started` included with the extension)
21-
22-
You will know your environment has finished loading once you see a terminal open related to `Running postStartCommand` with a final message: `Done`.
21+
- You will know your environment has finished loading once you see a terminal open related to `Running postStartCommand` with a final message: `Done. Press any key to close the terminal.`.
22+
- **Local IDE (Docker Compose)**:
23+
- Ensure you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
24+
- Ensure you have [Docker](https://docs.docker.com/get-docker/)
25+
- `git clone` the codebase repository and open it in VSCode
26+
- Issue the following command in the terminal to build and run the Docker container: `HOST_UID=$(id -u) PY_VER=3.11 DJ_VERSION=$(grep -oP '\d+\.\d+\.\d+' datajoint/version.py) docker compose --profile test run --rm -it djtest -- sh -c 'pip install -qe ".[test]" && bash'`
27+
- Issue the following command in the terminal to stop the Docker compose stack: `docker compose --profile test down`
2328

2429
## Features
2530

0 commit comments

Comments
 (0)