docs-bbr's Introduction

BOSH Backup and Restore

This repository contains the documentation for BOSH Backup and Restore (BBR), a framework for backing up and restoring BOSH deployments and BOSH Directors. This is the generic BBR documentation: it describes how to use BBR with any BOSH deployment or BOSH Director.

How This Repo Is Published

This repo is published to the following locations:

https://docs.cloudfoundry.org/bbr/ (OSS CF documentation)

BBR Release Notes

The BBR release notes are published on GitHub: https://github.com/cloudfoundry-incubator/bosh-backup-and-restore/releases

Where the Subnavs Live

The BBR documentation published in the OSS CF documentation at https://docs.cloudfoundry.org/bbr/ is included in the main subnav in docs-book-cloudfoundry: https://github.com/cloudfoundry/docs-book-cloudfoundry/blob/master/master_middleman/source/subnavs/_cf-subnav.erb. The BBR section appears under Information for Operators > Deploying Cloud Foundry.

Template Variables

BBR template variables that contextualize topics for OSS CF live in the docs-book-cloudfoundry template variables file.

These variables appear in the following topics:

One Big Table of All BBR Docs

This table lists the GitHub locations and URLs for all BBR documentation.

Name	GitHub Location	URL
Generic BBR docs in OSS CF	https://github.com/cloudfoundry/docs-bbr	https://docs.cloudfoundry.org/bbr/
Generic BBR docs in OSS CF subnav	https://github.com/cloudfoundry/docs-book-cloudfoundry/blob/master/master_middleman/source/subnavs/_cf-subnav.erb	https://docs.cloudfoundry.org/bbr/
BBR release notes for OSS CF	https://github.com/cloudfoundry-incubator/bosh-backup-and-restore/releases
BBR template variables in `docs-book-cloudfoundry`	https://github.com/cloudfoundry/docs-book-cloudfoundry/blob/master/config/template_variables.yml	n/a

docs-bbr's People