Getting Started

Version Branching

Branches are concurrent/parallel versions of content. It means you can create a separate parallel branch/fork of your content, a Publication or a topic, that can live side by side with the original.

It is similar to a copy, but with more features. A branch "knows" that it originates from another version, and if needed, you can later merge the content of the two different versions.

Some typical use cases for creating branches are:

  • You are working on a version for a specific product, and it is still in development, being updated, etc. But then the next release of the product is due, and you need to start working on the documentation for that version.

  • You need to send a project to translation, but you still need to keep working on further developments meanwhile.

  • You are considering some major changes to the documentation and its structure, and you want to experiment before abandoning the old version, or similarly:

  • You are working on a major change for the documentation that will take some time, but the development team is making many small continuous updates that require updates in the live documentation. So you need to be able to publish intermittently until the major overhaul of the documentation is done.

  • You may have two different versions that need to live concurrently, but some changes should be easily implemented in both.

  • And so on.

Project branches and topic branches

You can create a branch from either a publication (or "project"). They are similar, but with some differences:

  • A project branch will initially reuse all the same topics as its origin branch (the project "Main branch"). So if you make changes to any of those topics, you will make that change for any other project branch from the same project. This is just like with any two or more projects that reuse the same topics. You can remove and add topics to one or the other, and it will not affect the other branch.

    If you want to change a topic in one project branch, but not the other, you can create a topic branch of that particular topic.

  • A topic branch is initially a complete copy of the original topic (the topic "Main branch"). You can make changes in a topic branch, and it will not affect the original Main branch.

Search results