hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 18:27:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update Docker instructions for clarity

Browse Source
This commit is contained in:
breandan considine 2015-11-27 06:56:01 -05:00
parent 6cb2bf49da
commit 5dc26d3053
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -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 <HOST_PORT>:<CONTAINER_PORT>` 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 <HOST_PORT>:<CONTAINER_PORT>` 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**