silvestre / docs-bosh

The docs repo for BOSH

General documentation for BOSH. We render these docs with mkdocs using a slightly-adapted material theme, and you can find a rendered version of these docs at bosh.io/docs.

Production

Commits made to the master branch of this repo will trigger a councourse build which will automatically push changes live.

Development

For local development:

• Clone this repo.
• Initialize the submodule (external/bpm-release).
• Use Docker start a local server.

git clone https://github.com/cloudfoundry/docs-bosh.git
cd docs-bosh

git submodule update --init --recursive

# for quick development reloads
docker run --rm -it -p 8000:8000 -v "${PWD}:/docs" \
  squidfunk/mkdocs-material:2.7.2 \
  -- serve --dev-addr=0.0.0.0:8000 --dirtyreload

# for a production-like build environment (link checking, etc.)
docker run --rm -it -p 8000:8000 -v "${PWD}:/docs" \
  squidfunk/mkdocs-material:2.7.2

You can then make changes in a text editor, and refresh in a local browser at http://localhost:8000/.