Skip to content

Commit

Permalink
Add docker-compose.yml to simplify local doc development (#1653)
Browse files Browse the repository at this point in the history
Co-Authored-By: Richard North <rich.north@gmail.com>
  • Loading branch information
mikesir87 and rnorth committed Aug 6, 2019
1 parent bdb82b7 commit fbf5092
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
11 changes: 11 additions & 0 deletions docker-compose.yml
@@ -0,0 +1,11 @@
version: "3.7"

services:
docs:
image: python:3.6
command: sh -c "pip install -r requirements.txt && mkdocs serve -a 0.0.0.0:8000"
working_dir: /docs
volumes:
- ./:/docs
ports:
- 8000:8000
6 changes: 5 additions & 1 deletion docs/contributing_docs.md
Expand Up @@ -9,7 +9,11 @@ We publish our documentation using Netlify.

## Previewing rendered content

### Previewing docs locally
### Using Docker locally

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).

### Using Python locally

* Ensure that you have Python 3.6.0 or higher.
* Set up a virtualenv and run `pip install -r requirements.txt` in the `testcontainers-java` root directory.
Expand Down

0 comments on commit fbf5092

Please sign in to comment.