Name: docs-on-demand-service-broker
Owner: Pivotal Cloud Foundry
Description: Documentation for the On Demand Service Broker SDK
Created: 2016-04-08 15:17:37.0
Updated: 2018-05-23 16:50:35.0
Pushed: 2018-05-24 15:37:40.0
Homepage: https://docs.pivotal.io/svc-sdk/odb
Size: 1619
Language: HTML
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Use master for next the unreleased version, and numbered branches for the corresponding live releases.
For example:
| Branch name | Use for? | |————-| ——| | master | Next unreleased version (edge) https://docs-pcf-staging.cfapps.io/svc-sdk/odb/0-22| | v0.21.x | live | | v0.20.x | live | | v0.19.x | live | | v0.18.x | live | | v0.17.x | live | | v0.16.x | live | | v0.15.x | live | | v0.14.x | obsolete, but do not delete the branch | | v0.13.x | obsolete, but do not delete the branch | | v0.12.x | obsolete, but do not delete the branch | | v0.11.x | obsolete, but do not delete the branch | | v0.10.x | obsolete, but do not delete the branch | | v0.9.x | obsolete, but do not delete the branch |
Book repo: docs-book-services-sdk
edge: book branch that publishes the next unreleased version, from the master content branch.
Pipeline: https://concourse.run.pivotal.io/teams/cf-docs/pipelines/cf-services-sdk-edge
master: book branch that publishes all the live versions in production.
Pipeline: https://concourse.run.pivotal.io/teams/cf-docs/pipelines/cf-services-sdk
Instructions on doing a PR: https://docs.google.com/a/pivotal.io/document/d/14Go0uCj20BFMBzL2ddEKsZp-GONhVp0yr2cEFSskWnQ/edit?usp=sharing
1. Commit new feature docs to master only.
2. When the release is ready to publish, the docs team will create a new live/production branch from master, for example, 0.19.x.
1. For fixes and enhancement, do PRs to master.
2. Tell the docs team in the PR, if it should be applied to other specific branches (or do additional PRs to those branches).
If the fix or enhancement is only relevant to a particular branch, then apply the change to that branch only.
In order to display our mermaid templates locally (whilst running through bookbinder watch for example) the mermaid partials are expected to have file names preprended with an underscore. Unfortunately, this is the exact opposite behaviour to that expected by the templating engine in the live docs.
To help with this we have two scripts to localise, and then revert these diagram files:
./scripts/mmd-localise will prepend each mermaid file with an underscore./scripts/mmd-globalise will remove the first underscore from each mermaid file