Branches a way for users to independently work on changes to a document without affecting other branches of the document. When a document is created it has a default main branch. Users are able to create branches to isolate changes for review before merging.

Default branch

The default branch is a special protected branch that is created for any new document. This is usually the main branch, and can be customised in the organisation settings.

The default branch for any document can be changed in the document settings.

Protected branches

Branches can be protected to prevent users from staging, committing, or merging changes to the protected document branch.

Admins may want to protect the default branch of a document to control updates to the default branch by users while still allowing users to make updates to their own branch and merging after the changes to the document have been reviewed.

Users with the Document Admin permission are not subject to branch protection.

Branching a document

1. Click on the menu button to open the menu

   

2. Ensure you have an organisation selected

3. Click on Documents under Engineering

4. Click on any document to view the document overview

5. Click on the branch drop down menu

6. Click Create new branch...

7. Enter a Brnahc name for the new branch to be created, confirm the Source branch and click Create

Changing the default branch for a document

1. Click on the menu button to open the menu

   

2. Ensure you have an organisation selected

3. Click on Documents under Engineering

4. Click on any document to view the document overview

5. Click on the Settings tab

6. Change the new default branch in the Default branch drop down menu

7. Click Save