Merge pull request #1491 from pypeclub/feature/1490-resolve-documenta…

…tion

website/docs/admin_hosts_resolve.md

@@ -0,0 +1,103 @@
+---
+id: admin_hosts_resolve
+title: DaVinci Resolve Setup
+sidebar_label: DaVinci Resolve
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+## Resolve requirements
+Due to the way resolve handles python and python scripts there are a few steps required steps needed to be done on any machine that will be using OpenPype with resolve.
+
+### Installing Resolve's own python 3.6 interpreter.
+Resolve uses a hardcoded method to look for the python executable path. All of tho following paths are defined automatically by Python msi installer. We are using Python 3.6.2.
+
+<Tabs
+  groupId="platforms"
+  defaultValue="win"
+  values={[
+    {label: 'Windows', value: 'win'},
+    {label: 'Linux', value: 'linux'},
+    {label: 'Mac', value: 'mac'},
+  ]}>
+
+<TabItem value="win">
+
+`%LOCALAPPDATA%\Programs\Python\Python36`
+
+</TabItem>
+<TabItem value="linux">
+
+`/opt/Python/3.6/bin`
+
+</TabItem>
+<TabItem value="mac">
+
+`~/Library/Python/3.6/bin`
+
+</TabItem>
+</Tabs>
+
+
+### Installing PySide2 into python 3.6 for correct gui work
+
+OpenPype is using its own window widget inside Resolve, for that reason PySide2 has to be installed into the python 3.6 (as explained above).
+
+<Tabs
+  groupId="platforms"
+  defaultValue="win"
+  values={[
+    {label: 'Windows', value: 'win'},
+    {label: 'Linux', value: 'linux'},
+    {label: 'Mac', value: 'mac'},
+  ]}>
+
+<TabItem value="win">
+
+paste to any terminal of your choice
+
+```bash
+%LOCALAPPDATA%\Programs\Python\Python36\python.exe -m pip install PySide2
+```
+
+</TabItem>
+<TabItem value="linux">
+
+paste to any terminal of your choice
+
+```bash
+/opt/Python/3.6/bin/python -m pip install PySide2
+```
+
+</TabItem>
+<TabItem value="mac">
+
+paste to any terminal of your choice
+
+```bash
+~/Library/Python/3.6/bin/python -m pip install PySide2
+```
+
+</TabItem>
+</Tabs>
+
+<div class="row markdown">
+
+### Set Resolve's Fusion settings for Python 3.6 interpereter
+
+<div class="col col--6 markdown">
+
+
+As it is shown in bellow picture you have to go to Fusion Tab and then in Fusion menu find Fusion Settings. Go to Fusion/Script and find Default Python Version and swith to Python 3.6
+
+</div>
+
+<div class="col col--6 markdown">
+
+![Create menu](assets/resolve_fusion_tab.png)
+![Create menu](assets/resolve_fusion_menu.png)
+![Create menu](assets/resolve_fusion_script_settings.png)
+
+</div>
+</div>

website/docs/artist_hosts_resolve.md

@@ -0,0 +1,216 @@
+---
+id: artist_hosts_resolve
+title: DaVinci Resolve
+sidebar_label: DaVinci Resolve
+---
+
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+:::warning
+Before you are able to start with OpenPype tools in DaVinci Resolve, installation of its own Python 3.6 interpreter and PySide 2 has to be done. Go to [Installation of python and pyside](#installation-of-python-and-pyside) link for more information
+:::
+
+
+
+## OpenPype global tools
+
+-   [Work Files](artist_tools.md#workfiles)
+-   [Create](artist_tools.md#creator)
+-   [Load](artist_tools.md#loader)
+-   [Manage (Inventory)](artist_tools.md#inventory)
+-   [Publish](artist_tools.md#publisher)
+
+
+<div class="row markdown">
+
+## Creating Shots from timeline items
+
+Before a clip can be published with [Publisher](artist_tools.md#publisher) timeline item has to be marked with OpenPype metadata markers. This way it is converted to a publishable subset.
+
+Lets do it step by step.
+
+</div>
+
+
+<div class="row markdown">
+
+### Color clips before opening Create menu
+
+
+Timeline video clips should be colored to `Chocolate` color for OpenPype to se it as selected for subset creation.
+
+
+<div class="col col--6 markdown">
+
+![Create menu](assets/resolve_select_clips_timeline_chocolate.png)
+
+</div>
+</div>
+
+
+### Rename timeline track names
+
+<div class="row markdown">
+
+
+<div class="col col --6 markdown">
+
+To be able to work with dynamic subset name, which is based on track names it is recommended to rename those tracks to what type of plates their clips represent. Commonly used ones are `main`, `review`, `fg01`, `fg02`, `bg`, `bg01`, etc. It is completely up to you but we recommend to always have at least `main` plate. For example if a clip is on track **element** and subset family is set to **plate** then the resulting subset name will be **plateElement**
+
+<br></br>
+</div>
+
+<div class="col col--6 markdown">
+
+![Create menu](assets/resolve_creator_subset_name.png)
+The name of the resulting *subset* can be seen in the **OpenPypeData** marker.
+<br></br><br></br>
+</div>
+
+<div class="col col--6 markdown">
+
+![Create menu](assets/resolve_remame_track_names.png)
+Simple track setup where we are only using `main` and  `review` track names.
+
+</div>
+<div class="col col--6 markdown">
+
+![Create menu](assets/resolve_create_vertical_rename_timeline.png)
+An example of used track names. The yellow frame is highlighting vertically aligned clips - which are going to be renamed and grouped together under one asset (shot) name. The concept of vertical renaming will be explained later in [Vertical Synchronization of Subset Attributes](#vertical-synchronization-of-subset-attributes).
+
+</div>
+</div>
+
+
+### Create menu...
+
+<div class="row markdown">
+<div class="col col--6 markdown">
+
+After all clips which are intended to be converted to publishable instances are colored to `Chocolate` color, you can open OpenPype menu.
+
+</div>
+<div class="col col--6 markdown">
+
+![Create menu](assets/resolve_menu_openpype.png)
+
+</div>
+
+</div>
+
+<div class="row markdown">
+<div class="col col--6 markdown">
+
+After the menu widget is opened (it can take while so be patient please :).
+
+Hit `Create ...` and then set **Use selection** to active and select the family to **Create Publishable Clips**. 
+
+The Subset name can stay as it is, it is not going to be used because each clip will generate it's own name.
+
+</div>
+<div class="col col--6 markdown">
+
+![Create menu](assets/resolve_create_clips.png)
+
+</div>
+</div>
+
+<div class="row markdown">
+<div class="col col--6 markdown">
+
+The new windows that opens, let's you define various attributes for your future subsets and shots.
+
+Set Rename clips to active if you wish to use different names of shots in pipeline then the original clip names conformed from EDL/XML.
+
+**Count sequence from** - Start of the shot numbering if `#` is used in one of the keywords
+
+**Stepping number** - Sequential gaps in the numbering
+
+As you can see the in `{shot}` key within *Shot Template Keywords* section, you can use `#` symbol do define padding of the number in sequence and where it's going to be used.
+
+</div>
+<div class="col col--6 markdown">
+
+![Create menu](assets/resolve_create_renaming_clips.png)
+
+</div>
+</div>
+
+<div class="row markdown">
+<div class="col col--6 markdown">
+
+Notice the relationship of following sections. Keys from **Shot Template Keywords** sections will be used for formating of templates in **Shot Hierarchy And Rename Settings** section.
+
+**Shot parent hierarchy** will be forming parents of the asset (shot) *the hidden root for this is project folder*. So for example of this template we will get resulging string `shots/sq01`
+
+**Clip name template** in context of clip sitting on track name `main` in second position `mainsq01sh020`. This is due track key is hosting `{_track_}` which is inheriting name form timeline track name. Other allowed namespases are:
+- `{_sequence_}`: timeline name
+- `{_clip_}`: clip name
+- `{_trackIndex_}`: position of track on timeline from bottom
+- `{_clipIndex_}`: clip positon on timeline from left
+
+</div>
+<div class="col col--6 markdown">
+
+![Create menu](assets/resolve_create_template_filling.png)
+
+</div>
+</div>
+
+### Vertical synchronization of subset attributes
+
+In case you are only working with two tracks on timeline where `main` track is going to be used as plates for compositors and `review` track holds mp4 clips for offlines and web preview. **Enable vertical sync** can be deactivated.
+
+In multiple tracks scenario - as mentioned [here](#rename-timeline-track-names) - it is recommended to activate **Enable vertical sync** and define the hero (driving) track to *main*. This will ensure that all of the clips on corresponding to the same shots will have the same publishing parameters.
+
+<br></br>
+
+<div class="row markdown">
+
+<div class="col col--6 markdown">
+
+![Create menu](assets/resolve_create_single_track_rename_hero_track.png)
+
+</div>
+
+<div class="col col--6 markdown">
+
+![Create menu](assets/resolve_create_vertical_rename_creator_ui.png)
+
+</div>
+</div>
+
+
+## Publishing Shots
+
+<div class="row markdown">
+<div class="col--6 markdown">
+
+Once all `Chocolate` colored clips have gone through the [creator](#rcreate-menu), have been colored to `Pink` color and a marker has been created for each of them, it means they have been successfully converted to publishable clips. Now we can run **Publisher** - it's button can be found in the OpenPype menu.
+
+<br></br>
+</div>
+
+<div class="row markdown">
+<div class="col --6 markdown">
+
+![Create menu](assets/resolve_publish_instance_review_main.png)
+Notice that the main track clips and review had been merged into one instance. And since it is main `hero` clip it is also holding all new shot metadata. For that reason it also create secon instance for each with `shot` family. This instance will create all shot hierarchy and pass frame range attributes to shot (asset).
+
+</div>
+</div>
+
+<div class="row markdown">
+<div class="col --6 markdown">
+
+![Create menu](assets/resolve_publish_instance_other_plateSubsets.png)
+Also notice how the subset name is formed form a *track* name and *subset family* from previous steps.
+
+Also important is to notice the asset name in *OpenPypeData* at marker - the name is the same for all **Vertically renamed** shots as they have been grouped together. Unfortunately Resolve is not allowing to rename the clips so the only way to know is to see it in marker's metadata.
+
+</div>
+</div>
+
+</div>

website/sidebars.js

@@ -22,6 +22,7 @@ module.exports = {
                 "artist_hosts_blender",
                 "artist_hosts_harmony",
                 "artist_hosts_aftereffects",
+                "artist_hosts_resolve",
                 "artist_hosts_photoshop",
                 "artist_hosts_tvpaint",
                 "artist_hosts_unreal",
@@ -82,7 +83,8 @@ module.exports = {
             type: "category",
             label: "Integrations",
             items: [
-                "admin_hosts_blender"
+                "admin_hosts_blender",
+                "admin_hosts_resolve"
             ],
         },
         {