Skip to content

Commit

Permalink
Improve contributing instructions so it's easier to find what to run …
Browse files Browse the repository at this point in the history
…where
  • Loading branch information
adamkudrna committed Dec 28, 2023
1 parent a83edb5 commit 828688b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,39 +32,39 @@ docker compose run --rm node_shell

#### Run the Dev Server

1. Install dependencies (run within `node_shell`):
1. **Within `node_shell`:** Install dependencies:

```bash
npm ci
```

2. Run development server (run on host):
2. **On host:** Run development server:

```bash
docker compose up node_dev_server mkdocs_dev_server
```

#### Build the Project

1. Make sure the dev server is not running (run on host):
1. **On host:** Make sure the dev server is not running:

```bash
docker compose down
```

2. Install dependencies (run within `node_shell`):
2. **Within `node_shell`:** Install dependencies:

```bash
npm ci
```

3. Build JS (run on host):
3. **On host:** Build JS:

```bash
docker compose run --rm node_build_site
```

4. Build mkDocs (run on host):
4. **On host:** Build mkDocs:

```bash
docker compose run --rm mkdocs_build_site
Expand Down

0 comments on commit 828688b

Please sign in to comment.