diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 00000000000..822956457f7 --- /dev/null +++ b/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 diff --git a/docs/contributing_docs.md b/docs/contributing_docs.md index 294ae54e0de..9ed4b08169c 100644 --- a/docs/contributing_docs.md +++ b/docs/contributing_docs.md @@ -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.