Skip to content

Commit 2d449e5

Browse files
committed
update docs with new make dev_up behavior
1 parent ba6d66d commit 2d449e5

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

docs/guide/content/development_guide/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,13 @@ make loop_build
1212
make dev_up
1313
```
1414
The `make dev_up` command starts the development environment using Docker Compose with local development configuration.
15-
It runs in the foreground, streaming logs from all containers to your terminal.
16-
The shell prompt will not return until you stop the environment manually.
15+
It runs in the background. The shell prompt will return immediately.
1716

18-
To stop the environment, press <kbd>Ctrl</kbd>+<kbd>C</kbd>. This will gracefully shut down all containers.
19-
Alternatively, in another terminal you can run: `make dev_down`
17+
To stop the environment, run:
2018

19+
```bash
20+
make dev_down
21+
```
2122
Once the containers are running visit [https://localhost:33000/pun/sys/loop](https://localhost:33000/pun/sys/loop) and log in with the test user `ood/ood`.
2223

2324
The documentation is organized by topic to help you find what you need quickly:

docs/guide/content/development_guide/local_environment.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,17 +56,19 @@ make dev_up
5656
```
5757

5858
The `make dev_up` command starts the development environment using Docker Compose with local development configuration.
59-
It runs in the foreground, streaming logs from all containers to your terminal.
60-
The shell prompt will not return until you stop the environment manually.
59+
It runs in the background. The shell prompt will return immediately.
6160

62-
To stop the environment, press <kbd>Ctrl</kbd>+<kbd>C</kbd>. This will gracefully shut down all containers.
63-
Alternatively, in another terminal you can run: `make dev_down`
61+
To stop the environment, run:
62+
63+
```bash
64+
make dev_down
65+
```
6466

6567
#### Development vs Vanilla Environment
6668

6769
The project provides two different targets for running the application locally:
6870

69-
- **`make dev_up`** - **Recommended for development**. Uses additional volume mounts for local configuration and development files. This target loads both the main `docker-compose.yml` and the local override file `docker/docker-local-override.yaml`.
71+
- **`make dev_up`** - **Recommended for development**. Uses additional volume mounts and copies files for local configuration and development. This target loads both the main `docker-compose.yml` and the local override file `docker/docker-local-override.yaml`.
7072

7173
- **`make loop_up`** - **Vanilla installation**. Uses only the base Docker Compose configuration without local development overrides. Use this when you need to test the application in a configuration closer to production or for troubleshooting configuration issues.
7274

0 commit comments

Comments
 (0)