Use master for next the unreleased version, and numbered branches for the corresponding live releases. The latest version on master is routed to "/svc-sdk/odb/0-2n". This is to facilitate ease of access, push quicker to production, and reduce the need for large changes to the associated files.
For example:
| Branch name | Use for |
|---|---|
| master | Unreleased version (edge - 0.24) https://docs-pcf-staging.cfapps.io/svc-sdk/odb/0-2n |
| v0.23.x | live on Sept 18, 2018 https://docs-pcf-staging.cfapps.io/svc-sdk/odb/0-23 |
| v0.22.x | live |
| 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 |
Note: Edits to partials on the v0.18.x branch should be sycned with their corresponding partial in the Services Partials repo. Eventually, docs-on-demamd-service-broker partials will sourced from the Services Partials repo and removed here.
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
Cross-product partials for On-Demand Service Broker SDK are single sourced from the Services Partials repo.
Previously, these partials were sourced from the v018.x branch of the On Demand Service Broker SDK content repo.
Instructions on doing a PR: https://docs.google.com/a/pivotal.io/document/d/14Go0uCj20BFMBzL2ddEKsZp-GONhVp0yr2cEFSskWnQ/edit?usp=sharing
-
Commit new feature docs to master only.
-
When the release is ready to publish, the docs team will create a new live/production branch from master, for example, 0.19.x.
-
For fixes and enhancement, make PRs to master.
-
Tell the docs team in the PR, if it should be applied to other specific branches (or make 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-localisewill prepend each mermaid file with an underscore./scripts/mmd-globalisewill remove the first underscore from each mermaid file