/docs-redis

Redis for PCF docs

Primary LanguageHTML

Redis for PCF Docs

Where is the book repository?

https://github.com/pivotal-cf/docs-book-redis

The book repository uses these branches:

  • Edge builds from the master content branch are available on staging here. Pipeline here.
  • Master builds from the published content branches in this repository (2.0, 1.14, 1.13, etc). Pipeline here.

Partials

Cross-product partials for Redis for PCF are single sourced from the Services Partials repository.

Previously, these partials were sourced from the v018.x branch of the On Demand Service Broker SDK content repository.

Branches in this (content) repository

Master - Use for next unreleased version

All documentation for the next unreleased version of Redis is in master.

Always make changes you want carried forward in the master branch. This includes:

  • Unreleased features
  • Doc bug fixes
  • Doc reorganization or enhancement

Live Branches In Production (Public)

Cherry picking to and from MASTER

  1. Always cherry-pick any changes to live branches into master if you want those changes carried forward.

  2. If necessary, immediately cherry-pick/copy changes from master that you want to push immediately to production into the appropriate live branch above.

Style Sheet

Use this section to specify spelling of special words for Redis for PCF:

  • on-demand plan
  • shared-VM plan

Pipelines

Edge Pipeline
The master branch builds to the
cf-services-edge > redis-edge pipeline, and does not go to production until release time: Edge pipeline.

Production Pipeline
All live branches build to the cf-services > redis pipeline, and are manually pushed to production as needed: Production pipeline.

How to Cherry-pick from one Branch to Another

  1. Make changes in the first branch (usually master), commit them, and then push them to the repository.

  2. Copy part of the SHA for the above commit. To find this, you can do a git log, or look at the list of commits in the github repository.

  3. Checkout the second branch, where you want to copy the changes you made in the first branch.

  4. Run this command, using the SHA snippet you copied above: git cherry-pick <SHA_SNIPPET>

    For example: git cherry-pick 5dc22fe00

    Do the cherry-pick immediately to lessen the chances of conflicts. Otherwise, you may need to resolve conflicts in order to complete the cherry-pick.

  5. Do a git push after the cherry-pick is complete.