diff --git a/CHANGELOG.md b/CHANGELOG.md index 6fde5e2..f247d68 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -44,7 +44,7 @@ All notable changes to this project will be documented in this file. - Auto updater support - Performances improvements on Meshes, Gpencils, Actions - Multi-scene workflow support -- Render setting synchronisation +- Render setting synchronization - Kick command ### Changed diff --git a/docs/getting_started/glossary.rst b/docs/getting_started/glossary.rst index ce49c48..1164faf 100644 --- a/docs/getting_started/glossary.rst +++ b/docs/getting_started/glossary.rst @@ -51,3 +51,9 @@ Glossary +--------------------+---------------------------------------------------------------------------------------------+ + .. _common-right: + + common right + + When a data block is under common right, it is available for everyone to modification. + The rights will be given to the user that select it first. \ No newline at end of file diff --git a/docs/getting_started/quickstart.rst b/docs/getting_started/quickstart.rst index 5cd3346..39aaf6f 100644 --- a/docs/getting_started/quickstart.rst +++ b/docs/getting_started/quickstart.rst @@ -93,6 +93,9 @@ It will do two things: * Start a local server * Connect you to it as an :ref:`admin` +During online session, various actions are available to you, go to :ref:`how-to-manage` section to +learn more about them. + .. _how-to-join: How to join a session @@ -205,8 +208,8 @@ Kick a user The **CROSS button** (Also called **kick** operator) allow the admin to kick the selected user. On the target user side, the session will properly disconnect. --------------------- -Manage users display + +Change users display -------------------- Presence is the multi-user module responsible for users display. During the session, @@ -228,9 +231,31 @@ various drawn parts via the following flags: - **Show users**: display users current viewpoint - **Show different scenes**: display users working on other scenes ----------------------- -Manage replicated data ----------------------- +----------- +Manage data +----------- + +In order to understand replication data managment, a quick introduction to the multi-user data workflow is required. +First thing to know: until now, the addon rely on a data-based replication. In simple words, it means that it replicate +user's action results. +To replicate datablocks between clients the multi-user rely on what tends to be a distributed architecture: + +- The server store the "master" version of the work. +- Each client have a local version of the work. + +When an artist modified something in the scene, here is what is happening in the background: + +1. Modified data are **COMMITTED** to the local repository. +2. Once committed locally, they are **PUSHED** to the server +3. As soon as the server is getting updates, they are stored locally and pushed to every other clients + +At the top of this data management system, a right management system prevent +multiple users from modifying same data at same time. A datablock may belong to +a connected user or be under :ref:`common-right<**COMMON**>` rights. + +.. note:: + In a near future, the right management system will support roles to allow multiple users to + work on different aspect of the same datablock. .. figure:: img/quickstart_properties.png :align: center