Recommended Content Versioning Process
We recommend versioning your content by using both branches and releases.
- Develop the current content on the master branch.
- When the product that you document is nearing release, do the following:
- Finalize the content development of a map associated with the product.
- Test-publish the map and check for errors.
- Release the map. See Create a Release.
- 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.
- On the master branch, develop the documentation for the upcoming product
release.
- 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
- Create a branch from the release that you want to alter. See Branch a Release.
- Edit content in the newly created branch.Note: Your edits impact only that specific branch.
- Test-publish the map and check for errors.
- Release the map. See Create a Release.
- Publish the final deliverable from the altered map release. See Publish a Release.