How to use change request for version control

The GitBook Editor will trigger a new build each time you save a file (or when you edit the glossary or the summary). In other words, with single branch which is a Primary version (i.e. master branch), every save is an update/ publish.

Using the change request feature (i.e. normal branches or versions) is recommended mainly for the following reasons:

  • To prevent a working version of the book is published
  • To manage workflows for co-authoring
  • To avoid unnecessary operation burden to the search engine - every time the content is updated, it re-builds whole indexing

Create your version by creating change request

When co-authoring a book 'Chance request' is a great means for version control - think of Trunk and Branch datasets in OrgVue.

  1. Create a new change request by clicking 'create a change request' in the top left corner in the GitBook Editor!
  2. Enter a name of your version that describe your modification and hit Send
  3. You will be directed to the version you just created
  4. Edit your book like usual
  5. Remember to hit Publish button at the top right to Save your changes

    NOTE: Actually the label 'Publish' is wrong in non-primary versions as it doesn't publish the content but only save it.

You can view and edit other versions that are active including Primary version by clicking the version name

Accept a change request (= merge it with the primary version)

Typically the book owner will accept the change request after review and publish the content into the primary version.


results matching ""

    No results matching ""