Version Content

We recommend versioning your content by using both branches and releases.

  1. Develop the current content on the master branch.
    Current development
  2. When the product that you document is nearing release, do the following:
    1. Finalize the content development of a map associated with the product.
    2. Test-publish the map and check for errors.
    3. Release the map. See Create a Release.
    4. Publish the final deliverable from the release. See Publish a Release.
      Note: Publishing the final deliverable from a release ensures that any changes on any branch do not affect the deliverable.
  3. On the master branch, develop the documentation for the upcoming product release.
    Release and current development
  4. If you want to alter a past documentation release, do the following:
    Note: Altering past documentation releases may be necessary in the following cases:
    • There is a bug in the documentation
    • A past release of a given product is updated and the corresponding documentation is no longer accurate
    1. Create a branch from the release that you want to alter. See Branch a Release.
    2. Edit content in the newly created branch.
      Note: Your edits impact only that specific branch.
    3. Test-publish the map and check for errors.
    4. Release the map. See Create a Release.
    5. Publish the final deliverable from the altered map release. See Publish a Release.