diff --git a/README.md b/README.md index 0c0a0f00..0680266e 100644 --- a/README.md +++ b/README.md @@ -56,11 +56,24 @@ To submit a pull request to the documentation, follow this process: 1. Make your changes. - + +1. Get a ruby environment. + If you don't have a ruby environment on your local machine, we suggest using a docker container. The following command assumes you have the docs repos cloned at `~/workspace/DOCS_REPO` on your local machine. +
+ $ docker run -it --mount type=bind,source="$HOME/workspace",target=/workspace -p 4567:4567 ruby:2.3 /bin/bash ++ +1. Go to the docs-book-cloudfoundry repo +
+ # if you are executing bookbinder from your local ruby environment + $ cd docs-book-cloudfoundry + + # if you are executing bookbinder from the docker container from the command above + $ cf /workspace/docs-book-cloudfoundry +1. Run bookbinder on your local changes:
- $ cd docs-book-cloudfoundry $ bundle install $ bundle exec bookbinder watch