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.

Sign up for GitHub

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 container steps to readme #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add docker container steps to readme #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,24 @@ To submit a pull request to the documentation, follow this process:
</pre>

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.
<pre>
$ docker run -it --mount type=bind,source="$HOME/workspace",target=/workspace -p 4567:4567 ruby:2.3 /bin/bash
</pre>

1. Go to the docs-book-cloudfoundry repo
<pre>
# 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
</pre>
1. Run bookbinder on your local changes:

<pre>
$ cd docs-book-cloudfoundry
$ bundle install
$ bundle exec bookbinder watch
</pre>
Expand Down