Version Control Update: Item History, Merging, Branches

content/en/user-manual/version-control/branches.md

@@ -24,6 +24,34 @@ To create a branch open the version control panel, select the checkpoint that yo
 
 You will be asked to name your branch. Try to give your branch a description name like `fix-player-bug` or `refactor-sound-effects`. After creating the branch you will automatically be switched to the new branch you just created.
 
+Branches created by you will automatically be favorited so you can quickly find them in the [branch filter](#filtering-branch-list) for favorites.
+
+## Filtering branch list
+
+![Branch filter][9]
+
+You can filter branches between:
+
+- Favorites - Branches that are favorited by you.
+- Open - All branches that are open.
+- Closed - All branches that are closed.
+
+Favoriting a branch can be done with the following options:
+
+### Drop down menu
+
+![Favorite a branch via menu][10]
+
+### Selected branch button
+
+![Favorite a branch via button][11]
+
+## Searching for a branch
+
+![Searching for a branch][8]
+
+To help find a branch in the current list filter, you can use the search bar at the top.
+
 ## Switching to a branch
 
 ![Switch branch][3]
@@ -42,9 +70,11 @@ To close a branch, open the version control panel, select the branch you wish to
 
 ![Close branch dialog][5]
 
-You will be asked to confirm the closing of the branch and you have an option to discard any changes that were made to your branch since you last took a checkpoint. By default, PlayCanvas will save your changes in an additional checkpoint before closing the branch. If you wish to discard these changes you can select the option here.
+You will be asked to confirm the closing of the branch and you have an option to create a checkpoint before closing. This is enabled by default. If you wish to discard these changes you can untick the option here.
+
+**Note: Unticking this checkbox will lose any work you have made in the branch since you last made a checkpoint**
 
-**Note, enabling this checkbox will lose any work you have made in the branch since you last made a checkpoint**.
+Closed branches can also be reopened at a later date.
 
 ## Deleting a branch
 
@@ -55,18 +85,22 @@ Deletion of branches are only supported if the following conditions are met:
 
 To delete a branch open the version control panel, select the branch you wish to delete and choose the "Delete this branch" option in the branch's drop-down menu.
 
-![][delete-branch]
+![Delete a branch][6]
 
 You will be asked to confirm the deletion of the branch by typing the name of the branch in the dialog box.
 
 **Note, deleted branches cannot be recovered after deletion! If in doubt, please close the branch instead.**
 
-![][delete-branch-dialog]
-
-[1]: /images/user-manual/version-control/new-branch.jpg
-[2]: /images/user-manual/version-control/new-branch-dialog.jpg
-[3]: /images/user-manual/version-control/switch-branch.jpg
-[4]: /images/user-manual/version-control/close-branch.jpg
-[5]: /images/user-manual/version-control/close-branch-dialog.jpg
-[delete-branch]: /images/user-manual/version-control/delete-branch.png
-[delete-branch-dialog]: /images/user-manual/version-control/delete-branch-dialog.png
+![Delete a branch warning][7]
+
+[1]: /images/user-manual/version-control/branches/new-branch.png
+[2]: /images/user-manual/version-control/branches/new-branch-dialog.png
+[3]: /images/user-manual/version-control/branches/switch-branch.png
+[4]: /images/user-manual/version-control/branches/close-branch.png
+[5]: /images/user-manual/version-control/branches/close-branch-dialog.png
+[6]: /images/user-manual/version-control/branches/delete-branch.png
+[7]: /images/user-manual/version-control/branches/delete-branch-dialog.png
+[8]: /images/user-manual/version-control/branches/search-for-a-branch.gif
+[9]: /images/user-manual/version-control/branches/filter-branches.gif
+[10]: /images/user-manual/version-control/branches/favorite-branch-via-dropdown.gif
+[11]: /images/user-manual/version-control/branches/favorite-branch-via-button.gif

content/en/user-manual/version-control/item-history.md

@@ -0,0 +1,35 @@
+---
+title: Item History
+layout: usermanual-page.hbs
+position: 11
+---
+
+Checkpoint history is available for every item in the project so you can easily view the changes in the Checkpoints.
+
+Due to the extra information that needs to be stored per checkpoint to support this feature, only checkpoints made after Mar 2, 2022 can be seen with Item History.
+
+See it in action below for all supported items. The `[=]` in the top left of the node means that a Checkpoint has been made but with no changes to the item.
+
+More information on using the Graph View can be found [here][graph-view].
+
+### Entity Item History
+
+![Entity Item History][entity-item-history-img]
+
+### Asset Item History
+
+![Asset Item History][asset-item-history-img]
+
+### Project Settings Item History
+
+![Project Settings Item History][project-settings-item-history-img]
+
+### Scene Item History
+
+![Scene Item History][scene-item-history-img]
+
+[graph-view]: /user-manual/version-control/graph-view/
+[entity-item-history-img]: /images/user-manual/version-control/item-history/entity-item-history.gif
+[asset-item-history-img]: /images/user-manual/version-control/item-history/asset-item-history.gif
+[project-settings-item-history-img]: /images/user-manual/version-control/item-history/project-item-history.gif
+[scene-item-history-img]: /images/user-manual/version-control/item-history/scene-item-history.gif

content/en/user-manual/version-control/merging.md

@@ -29,7 +29,18 @@ First, it's important to note that when you perform a merge in PlayCanvas you ar
 
 To start a merge switch your current branch to the branch you wish to merge into. Then select the branch that you wish to merge from and choose "Merge into current branch" from the branch's drop-down menu.
 
-This will start the merge process.
+![Merge dialog][9]
+
+You have a few options before starting the merge.
+
+On the 'Merge from' branch, you can:
+
+- **Create checkpoint first** - Tick this option to create a checkpoint before the merge. This is useful if there are changes in the branch that have not yet been checkpointed and you want to include them in the merge.
+- **Close branch after merging** - Tick this option to close the 'Merge from' branch after the merge is completed. This is commonly used for feature branches where the feature is completed and to keep the branch list clean from stale/old branches.
+
+On the 'Merge to' branch, you can:
+
+- **Create checkpoint first** - This is ticked by default. As merges are based on checkpoints (i.e. it merges one checkpoint to another), this ensures that any changes on the 'Merge to' branch that aren't checkpointed, will be included in the merge. Unticking this option will discard any changes that are not checkpointed. It is recommended to not untick this option.
 
 ### Automatic Merging
 
@@ -52,9 +63,10 @@ The conflict manager shows each resource that is in conflict on the left, and fo
 While the conflict manager and the merge is in progress your current branch is locked to further edits from other users. This prevents changes being overwritten by your merge when you finish resolving the conflicts. If another user has blocked a branch you need with a merge, you can forcibly end their merge from the editor.
 
 [1]: /user-manual/version-control/branches
-[3]: /images/user-manual/version-control/start-merge.jpg
-[4]: /images/user-manual/version-control/conflict-manager.jpg
-[5]: /images/user-manual/version-control/conflicts-resolved.jpg
-[6]: /images/user-manual/version-control/merging-checkpoints-1.png
-[7]: /images/user-manual/version-control/merging-checkpoints-2.png
-[8]: /images/user-manual/version-control/merging-checkpoints-3.png
+[3]: /images/user-manual/version-control/merging/start-merge.png
+[4]: /images/user-manual/version-control/merging/conflict-manager.jpg
+[5]: /images/user-manual/version-control/merging/conflicts-resolved.jpg
+[6]: /images/user-manual/version-control/merging/merging-checkpoints-1.png
+[7]: /images/user-manual/version-control/merging/merging-checkpoints-2.png
+[8]: /images/user-manual/version-control/merging/merging-checkpoints-3.png
+[9]: /images/user-manual/version-control/merging/merge-dialog.png