Merge branch '524-documentation-update-in-order-to-include-video-onli…

…ne-links' into 'master' Resolve "Documentation update in order to include video online links" Closes #473 and #524 See merge request animation-studio/blender/mixer!261
WSPluta · Apr 8, 2021 · 3a0299d · 3a0299d
2 parents 4b3d9bc + c93a10a
commit 3a0299d
Show file tree

Hide file tree

Showing 12 changed files with 128 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -8,13 +8,13 @@ Mixer is a Blender addon developed at Ubisoft for Real Time Collaboration in 3D
 
 Refer to the online documentation for details about current [features and limitations](https://ubisoft-mixer.readthedocs.io/en/latest/getting-started/features.html).
 
-## Usage
+## Documentation and Usage
 
 Documentation is available at the web site https://ubisoft-mixer.readthedocs.io/ :
 
-- [download and install](https://ubisoft-mixer.readthedocs.io/en/latest/getting-started/install.html) Mixer
-- perform [local tests](https://ubisoft-mixer.readthedocs.io/en/latest/getting-started/first-steps.html)
-- [get connected](https://ubisoft-mixer.readthedocs.io/en/latest/collaborate/get-connected.html) and [work together](https://ubisoft-mixer.readthedocs.io/en/latest/collaborate/work-together.html)
+- [Download and install](https://ubisoft-mixer.readthedocs.io/en/latest/getting-started/install.html) Mixer
+- Perform [local tests](https://ubisoft-mixer.readthedocs.io/en/latest/getting-started/first-steps.html)
+- [Get connected](https://ubisoft-mixer.readthedocs.io/en/latest/collaborate/get-connected.html) and [work together](https://ubisoft-mixer.readthedocs.io/en/latest/collaborate/work-together.html)
 
 ## Updates
 
@@ -26,9 +26,11 @@ The active support repository is on Gitlab https://gitlab.com/ubisoft-animation-
 
 The [Mixer Github repository](https://github.com/ubisoft/mixer) is a mirror that is part of Github [Ubisoft open source](https://github.com/ubisoft) projects group.
 
-## Contributing
+## Feedback and contribution
 
-See [contributing](doc/README.md)
+Post your feedback and discuss your ideas with us on the [Mixer Blender chat](https://blender.chat/channel/mixer-addon).
+
+You can also get involved into the development of Mixer, discover how by reading these [contribution guidelines](doc/README.md).
 
 ## License and copyright
 

diff --git a/docs/collaborate/get-connected.rst b/docs/collaborate/get-connected.rst
@@ -91,7 +91,15 @@ VPN software like Hamachi, Zerotier and others can be used to execute a Mixer se
 Hamachi
 """""""
 
-TODO
+Follow this tutorial to easily install and configurate an Hamachi server:
+
+.. raw:: html
+
+   <div style="position: relative; padding-bottom: 45%; height: 0; overflow: hidden; max-width: 80%; border:solid 0.1em; border-color:#4d4d4d; align=center; margin: auto;">
+      <iframe width="560" height="315" src="https://www.youtube.com/embed/07ifLm0K0mI" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+   </div>
+
+| 
 
 Other VPN software
 """"""""""""""""""""

diff --git a/docs/getting-started/features.rst b/docs/getting-started/features.rst
@@ -18,8 +18,8 @@ See :ref:`work-together` for more details.
 What is synchronized
 --------------------
 
-This table described the status of synchronization for the main Blender data types.
-The custom properties of all datablocks are also synchronized
+Most of the elements contained in a scene, the data types, are synchronized, as well as the custom properties of all datablocks.
+The following table summarizes the covered features and a note indicates when synchronization is not available because the feature has not been implemented yet.
 
 .. |Y| replace:: Yes
 .. |N| replace:: No
@@ -43,11 +43,11 @@ Light           |Y|
 Light probe     |N|
 Line style      |N|
 Mask            |N|
-Material        |Y|                 
-Mesh            |P|                 except split normals, custom properties, see [Edit]_
+Material        |Y|                 See [Nodes]_
+Mesh            |P|                 Except split normals, custom properties, see [Edit]_
 Metaball        |Y|                 See [Edit]_, [Convert]_
 Movie clip      |Y|                 See [Media]_
-Node group      |P|                 Not extensively tested, see [NodeGroups]_
+Node group      |P|                 Not extensively tested, see [Nodes]_
 Object          |P|                 Except motion paths, particles and physics. See [Convert]_ 
 Paint curve     |N|
 Particles       |N|
@@ -58,7 +58,6 @@ Text            |N|
 Texture         |Y|
 Volume          |N|
 VSE             |P|                 Except meta strips. Not extensively tested
-Workspace       |N|
 World           |Y|
 ==============  ==================  ==============================================
 
@@ -94,9 +93,48 @@ World           |Y|
 .. [Media] 
     Media files are synchronized. The result of **reload** or media path modification are not synchronized.
 
-.. [NodeGroups]
+.. [Nodes]
+    Links synchronization sometimes fails. Some cases might cause crashes.
 
-   **Collection** sockets in geometry node groups cause synchronization failures and may crash
+
+.. _not-synchronized:
+
+What is NOT synchronized
+------------------------
+
+In order to provide to all participants a collaborative experience with as much freedom as they have during a solo session some features are deliberately not synchronized.
+This is the case for most User Interface elements, user preferences and configuration.
+
+=====================  =====================================================
+UI and Settings          Comments
+=====================  =====================================================
+User preferences       
+Key mapping            
+Installed add-ons      
+Workspace              
+=====================  =====================================================
+
+=====================  =====================================================
+Scene Manipulation       Comments
+=====================  =====================================================
+Object Editing Mode     
+Active tool             Eg: Move, Rotate, Scale...
+3D cursor               
+Scene display mode      Show gizmos, overlays...
+Viewport shading        
+Play mode               
+=====================  =====================================================
+
+=====================  =====================================================
+Scene Properties       Comments
+=====================  =====================================================
+Scene current camera   See [SceneCurrentCamera]_
+Render engine          See [RenderEngine]_
+=====================  =====================================================
+
+.. [SceneCurrentCamera] Although belonging to the scene properties, preventing the current camera to be synchronized allows each user to view and render the scene from the camera of her choice
+
+.. [RenderEngine] Each user can render either with Eevee, Cycle or another avaiable engine of her choice
 
 .. _caveats:
 

diff --git a/docs/getting-started/first-steps.rst b/docs/getting-started/first-steps.rst
@@ -1,13 +1,12 @@
+.. _first-steps:
+
 First steps
 ===========
 
 The easiest way to test Mixer and find out what you can do with it is by using two Blender instances side by side on the same machine.
 
 Start two Blender instances, lay them side by side. In each one, open the Mixer panel in the 3D editor.
 
-
-.. _first-steps:
-
 Create a Server
 ---------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,11 +3,33 @@ Mixer: a Blender Addon for Collaborative Editing
 
 With Mixer, several Blender users can work together on the same data and collaborate in real time.
 
+Disclaimer
+----------
+
+Mixer is an open source project developed by the R&D department of Ubisoft Animation Studio.
+Although designed to be used in a production context it is still an experimental tool and,
+In spite of all our efforts to make it reliable, it may in some circumstances corrupt you Blender scenes data.
+Be aware that neither Ubisoft nor Ubisoft employees can be taken as responsible in such cases. Use it at your own risks.
+
+**This said, we will do our best to improve Mixer thanks to your feedback in order to provide a memorable creative collaborative experience.
+Have fun !**
+
+
 Getting started
 ---------------
 
-This section will guide you into the process of :ref:`downloading <download>` the Mixer zip file, :ref:`installing<installing>` Mixer as a Blender addon, then
-:ref:`try out<first-steps>` your installation.
+.. raw:: html
+
+   <div style="position: relative; padding-bottom: 45%; height: 0; overflow: hidden; max-width: 80%; border:solid 0.1em; border-color:#4d4d4d; align=center; margin: auto;">
+      <iframe width="560" height="315" src="https://www.youtube.com/embed/6N-XPnvF74Y" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+   </div>
+
+| 
+
+Watch the video tutorial or dive into this step-by-step process:
+   * :ref:`Download <download>` the Mixer zip file
+   * :ref:`Install <installing>` Mixer as a Blender addon
+   * Then :ref:`try out<first-steps>` your installation
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/troubleshoot/issue.rst b/docs/troubleshoot/issue.rst
@@ -1,5 +1,14 @@
+Feedback and Issues
+===================
+
+Feedback
+--------
+
+For feedback, suggestions and to discuss ideas around Mixer you can directly contact us on Blender Chat:
+https://blender.chat/channel/mixer-addon
+
 Reporting an issue
-==================
+------------------
 
 Before reporting an issue, please make sure that are using the :ref:`latest version <installing>` and check :
 
@@ -13,6 +22,6 @@ If you think you have found a bug or would like to propose a new feature, please
 
 Please consider attaching the Mixer log file:
 
-- Open the Mixer preferences using the Mixer panel title bar settings icon
+- open the Mixer preferences using the Mixer panel title bar settings icon
 - in the preferences window, go to the **Connection Settings** group and click on **Open Log Folder**.
 - attach the relevant file to the issue.
diff --git a/mixer/__init__.py b/mixer/__init__.py
@@ -37,9 +37,10 @@
     "description": "Collaborative 3D edition accross 3D software",
     "version": (0, 22, 0),  # Generated by inject_version.py
     "blender": (2, 91, 0),
-    "location": "",
+    "location": "View3D > Mixer",
     "warning": "Experimental addon, can break your scenes",
-    "wiki_url": "https://gitlab.com/ubisoft-animation-studio/mixer",
+    "wiki_url": "https://github.com/ubisoft/mixer/",
+    "doc_url": "https://ubisoft-mixer.readthedocs.io/en/latest/",
     "tracker_url": "",
     "category": "Collaboration",
 }

diff --git a/mixer/ui/about.py b/mixer/ui/about.py
@@ -74,11 +74,28 @@ def draw(self, context):
         # ##############
         row = box.row()
         row.label(text="Documentation:")
+        row.separator()
+        row.operator(
+            "mixer.open_documentation_url", text="Documentation, Tutorials..."
+        ).path = "https://ubisoft-mixer.readthedocs.io/en/latest/"
+
+        # Download
+        # ########
+        row = box.row()
+        row.label(text="Downloads:")
+        row.separator()
+        row.operator(
+            "mixer.open_documentation_url", text="Latest Release..."
+        ).path = "https://github.com/ubisoft/mixer/releases/latest/"
+
+        # Source code
+        # ###########
         row = box.row()
+        row.label(text="Source Code:")
         row.separator()
         row.operator(
-            "mixer.open_documentation_url", text="Documentation, Download, Feedback..."
-        ).path = "https://gitlab.com/ubisoft-animation-studio/mixer#mixer"
+            "mixer.open_documentation_url", text="Mixer on GitHub..."
+        ).path = "https://github.com/ubisoft/mixer/"
 
         box.separator()
 

diff --git a/mixer/ui/prefs.py b/mixer/ui/prefs.py
@@ -41,7 +41,7 @@ def draw(self, context):
         row = layout.row(align=True)
         row.operator(
             "mixer.open_documentation_url", text="Documentation"
-        ).path = "https://gitlab.com/ubisoft-animation-studio/mixer#mixer"
+        ).path = "https://ubisoft-mixer.readthedocs.io/en/latest/"
 
         row = layout.row(align=True)
         row.operator("mixer.about", text="About...")

diff --git a/mixer/utils/utils_ui_operators.py b/mixer/utils/utils_ui_operators.py
@@ -33,7 +33,7 @@
 class Mixer_OT_Open_Documentation_Url(Operator):  # noqa 801
     bl_idname = "mixer.open_documentation_url"
     bl_label = "Open Documentation Web Page"
-    bl_description = "Open documentation.\nShift + Click: Copy the URL into the clipboard"
+    bl_description = "Open web page.\nShift + Click: Copy the URL into the clipboard"
 
     path: StringProperty()
 

diff --git a/mixer/vrtist/ui/about.py b/mixer/vrtist/ui/about.py
@@ -72,13 +72,11 @@ def draw(self, context):
         #
         # Documentation
         # ##############
+        box.separator(factor=2)
         row = box.row()
-        row.label(text="Documentation:")
-        row = box.row()
-        row.separator()
         row.operator(
-            "mixer.open_documentation_url", text="Documentation, Download, Feedback..."
-        ).path = "https://gitlab.com/ubisoft-animation-studio/mixer#mixer"
+            "mixer.open_documentation_url", text="Documentation, Downloads, Feedback..."
+        ).path = "https://github.com/ubisoft/vrtist"
 
         box.separator()
 

diff --git a/mixer/vrtist/ui/prefs.py b/mixer/vrtist/ui/prefs.py
@@ -39,9 +39,7 @@ def draw(self, context):
         row.operator("preferences.addon_show", text="Add-on Preferences...").module = "mixer"
 
         row = layout.row(align=True)
-        row.operator(
-            "mixer.open_documentation_url", text="Documentation"
-        ).path = "https://gitlab.com/ubisoft-animation-studio/mixer#mixer"
+        row.operator("mixer.open_documentation_url", text="Documentation").path = "https://github.com/ubisoft/vrtist"
 
         row = layout.row(align=True)
         row.operator("vrtist.about", text="About...")