The master branch is the tree-trunk, so always make changes you want carried forward in this branch. This includes:
- Unreleased features
- Doc bug fixes
- Doc reorganization or enhancement
Then, if necessary, immediately cherry-pick/copy any changes that you want to push immediately to production into the appropriate branches listed below:
| Branch Name | Use for… |
|---|---|
| master | 1.n Use for staging doc for the next release. (staged here: http://docs-pcf-staging.cfapps.io/cloud-service-broker/1-n/) |
| 1.0 | 1.0 (live: http://docs.pivotal.io/cloud-service-broker/1-0/) |
| GCP-AWS-docs | This branch contains the installing-with-gcp.html.md.erb and installing-with-aws.html.md.erb topics. We are keeping these topics for when CSB supports these IaaSes |
The book repo associated with this content is pivotal-cf/docs-book-csb.
When a commit is made into any of the above branches, the documentation is deployed by [this concourse build][docs-staging-deploy]. All the supported versions will be accessible on the staging website.
Click the deploy button in the pipeline! Living the dream :-D
If there is some documentation to add for an unreleased patch version of Cloud Service Broker then create a branch off of the live branch you intend to modify and create a pull request against that branch. After the version that change is targeting is released, the pull request can be merged and will be live the next time a documentation deployment occurs.
If the documentation is meant to be target several released versions, then you will need to:
- create a pull request for each individual minor version
- or ask the technical writer to cherry-pick to particular branches/versions.
Cross-product partials (if any) for Cloud Service Broker are single sourced from the Docs Partials repository.
Because master is the latest and greatest documentation, the process would be to cut a x.x-live branch for the version that master was targeting during that time. A corresponding section in config.yml in the [docs-book-pcfservices][docs-book-pcfservices] repository would also need to be made.
After this point, master will then be the target for the next version of the Cloud Service Broker product.
This is a word list for terminology and word usage specific to the Cloud Service Broker for docs.