From 9ac3bf0140d0097de34f81b6b47bfdba07334faf Mon Sep 17 00:00:00 2001 From: Michael Irwin Date: Tue, 23 Jul 2019 16:10:58 -0400 Subject: [PATCH 1/2] Add docker-compose.yml to simplify local doc development --- docker-compose.yml | 11 +++++++++++ docs/contributing_docs.md | 6 +++++- 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 docker-compose.yml 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..a46cb2e9b66 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 + +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). + +### 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. From 75b14f4b744b51011bc9b12b6022582111a1b3a1 Mon Sep 17 00:00:00 2001 From: Michael Irwin Date: Fri, 2 Aug 2019 17:06:08 -0400 Subject: [PATCH 2/2] Update docs/contributing_docs.md Co-Authored-By: Richard North --- docs/contributing_docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing_docs.md b/docs/contributing_docs.md index a46cb2e9b66..9ed4b08169c 100644 --- a/docs/contributing_docs.md +++ b/docs/contributing_docs.md @@ -11,7 +11,7 @@ We publish our documentation using Netlify. ### 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). +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