Skip to content

Commit 7e3969c

Browse files
Update CONTRIBUTING.md
1 parent a1dd91a commit 7e3969c

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,18 @@ To update the docs for your new module, you'll have to:
2323

2424
#### Using Docker
2525

26-
The root of the project contains a `docker-compose.yml` file. Simply run `docker-compose up` and then access the docs at [http://localhost:8000](http://localhost:8000).
26+
```shell
27+
npm run docs:serve
28+
```
29+
30+
Then access the docs at [http://localhost:8000](http://localhost:8000).
2731

2832
#### Using Python
2933

3034
* Ensure that you have Python 3.8.0 or higher.
3135
* Set up a virtualenv and run `pip install -r requirements.txt` in the `testcontainers-node` root directory.
3236
* Once Python dependencies have been installed, run `mkdocs serve` to start a local auto-updating MkDocs server.
3337

34-
#### PR Preview deployments
35-
36-
Documentation for pull requests will automatically be published by Netlify as 'deploy previews'. These deployment previews can be accessed via the `deploy/netlify` check that appears for each pull request.
38+
#### PR preview deployments
3739

40+
Documentation for pull requests will automatically be published by Netlify as "deploy previews". These deployment previews can be accessed via the `deploy/netlify` check that appears for each pull request.

0 commit comments

Comments
 (0)