https://github.com/cloudfoundry/docs-bosh
The docs repo for BOSH
https://github.com/cloudfoundry/docs-bosh
Last synced: 2 months ago
JSON representation
The docs repo for BOSH
- Host: GitHub
- URL: https://github.com/cloudfoundry/docs-bosh
- Owner: cloudfoundry
- License: apache-2.0
- Created: 2014-01-30T17:58:46.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2025-12-04T15:53:37.000Z (4 months ago)
- Last Synced: 2025-12-07T23:53:38.373Z (4 months ago)
- Language: HTML
- Size: 13.1 MB
- Stars: 37
- Watchers: 77
- Forks: 272
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
README
General documentation for [BOSH](https://bosh.io/). We render these docs with [mkdocs](https://www.mkdocs.org/) using a [slightly-adapted](theme) [material](https://github.com/squidfunk/mkdocs-material) theme, and you can find a rendered version of these docs at [bosh.io/docs](https://bosh.io/docs/).
## Production
Commits made to the master branch of this repo will trigger a [councourse build](https://ci.bosh-ecosystem.cf-app.com/teams/main/pipelines/bosh-io-web) which will automatically push changes live.
## Development
For local development:
* Clone this repo.
* Initialize the submodule (external/bpm-release).
* Use [Docker](https://docs.docker.com/install/) start a local server.
```shell
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 .