From 5dc26d3053fcb458364053d46e7f6f9415c355a5 Mon Sep 17 00:00:00 2001 From: breandan considine Date: Fri, 27 Nov 2015 06:56:01 -0500 Subject: [PATCH] Update Docker instructions for clarity --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc76ff58d72..35434818066 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,11 +34,11 @@ In order to build the documentation site, you will need: **Docker** -To build and run this site on Docker, run the following commands from inside the parent directory (with the `sdkdocs-template` submodule initialized, please see the [boot2docker documentation](https://github.com/boot2docker/boot2docker#folder-sharing) for how to enable folder sharing with Docker containers): +To build and run this site on Docker, first clone this repository and initialize the `sdkdocs-template` subodule, then run the following commands from inside the parent directory (for Mac OS X and Windows users, please refer to the [boot2docker documentation](https://github.com/boot2docker/boot2docker#folder-sharing) for installation instructions and how to enable folder sharing with Docker containers): * `docker build -t intellij-sdk-docs . && docker run -p 4000:4000 -v $PWD:/usr/src/app intellij-sdk-docs` -This will will forward port 4000 from the Docker container (which can be configured the [Rakefile](https://github.com/JetBrains/intellij-sdk-docs/blob/master/Rakefile), just update the `-p :` flag) and mount the working directory to `/usr/src/app` where `intellij-sdk-docs` expects to find a Jekyll site. From there, it will run `rake bootstrap && rake preview`. Finally, you can access your site at by visiting [http://localhost:4000/intellij/sdk/docs/](http://localhost:4000/intellij/sdk/docs/). Please keep in mind if you are running boot2docker, that it may bind a [different address](https://github.com/boot2docker/boot2docker#container-port-redirection). +This command will forward port 4000 from the Docker container (which can be configured in the [Rakefile](https://github.com/JetBrains/intellij-sdk-docs/blob/master/Rakefile), by updating the `-p :` flag) and mount the working directory to `/usr/src/app` (where `intellij-sdk-docs` should reside). From there, Docker will run `rake bootstrap && rake preview`. Finally, you can access your newly created site at by visiting [http://localhost:4000/intellij/sdk/docs/](http://localhost:4000/intellij/sdk/docs/). Please keep in mind that boot2docker will bind a [different address](https://github.com/boot2docker/boot2docker#container-port-redirection). **OS X**