Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docker-compose.yml to simplify local doc development #1653

Merged
merged 4 commits into from Aug 6, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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

At 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).
mikesir87 marked this conversation as resolved.
Show resolved Hide resolved

### 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