Giter VIP home page Giter VIP logo

docs-devconnect's Introduction

Developer Connect

Where is the book repo?

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

The book repo uses these branches:

  • edge builds from the master content branch in this repo. Pipeline here.

  • master builds from the published content branches in this repo. Pipeline here.

Branches in this (content) repo

All documentation for the next unreleased version of Developer Connect 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
Branch Name Use for…
master (current work) v0.1 (staged here: http://docs-pcf-staging.cfapps.io/developer-connect/0-alpha/

When the latest alpha version is ready to publish, merge the master branch into an alpha branch. Keep all the alpha versions of the release notes stacked in the Release Notes for Pivotal Developer Connect page.

  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

We need to decide on product name short forms:

Term or product name Notes
Developer Connect product_full, the longest name

Pipelines

Production Pipeline
All live branches build to the cf-services > developer-connnect 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 repo.

  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 repo.

  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.

docs-devconnect's People

Contributors

radaeze avatar theckkw avatar dimitrybesson avatar snneji avatar petahhh avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.