Skip to content

Commit c12936f

Browse files
fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! !fixup Introduce devcontainer service container based development environment (#705)
1 parent 1bf514f commit c12936f

4 files changed

Lines changed: 6 additions & 5 deletions

File tree

.env.dist

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
# Docker Compose configuration #
33
################################
44

5-
# Docker compose project name must match directory name of the project to allow devcontainer to communicate with other containers
5+
# Must match Docker Compose project name used to start the other service containers to allow devcontainer
6+
# to communicate with them (setup.sh derives this from the directory basename by default)
67
COMPOSE_PROJECT_NAME=react-ui
78

89
# Docker compose ports for Docs server instances

docker/react_ui_devcontainer/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM debian:bookworm AS react-ui-devcontainer
1+
FROM debian:bookworm-slim AS react-ui-devcontainer
22

33
# Build arguments for user configuration
44
# Those can be changed using fixuid's remapping feature when running the container

setup.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ DEFAULT_USER_ID=1000
55
DEFAULT_GROUP_ID=1000
66

77
set -e
8-
trap 'echo "Failed to setup project"; rf -f .env.temp; exit 1' ERR
8+
trap 'echo "Failed to set up project"; rm -f .env.temp; exit 1' ERR
99

1010
# Function to handle sed command with cross-platform compatibility
1111
sed_cmd() {

src/docs/contribute/general-guidelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ settings. See `.env.dist` for available options.
7272

7373
Open the project in an IDE that supports [Development Containers] (e.g.
7474
[Visual Studio Code][vscode-devcontainers], [JetBrains IDEs][jetbrains-devcontainers]).
75-
The IDE will automatically setup the environment using the configuration in
75+
The IDE will automatically set up the environment using the configuration in
7676
`.devcontainer/devcontainer.json`.
7777

7878
#### Using Docker Compose
@@ -193,7 +193,7 @@ mkdocs build
193193
To start building JavaScript files in watch mode:
194194

195195
```bash
196-
npm run start
196+
npm start
197197
```
198198

199199
To start the documentation server:

0 commit comments

Comments
 (0)