Merge branch 'main' into documentation/openype-importer

website/docs/addon_3dsmax_admin.md

@@ -0,0 +1,15 @@
+---
+id: addon_3dsmax_admin
+title: 3Ds Max Admin Docs
+sidebar_label: 3Ds Max
+---
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.Max_Badge}
+</ReactMarkdown>
+
+:::note Work in progress
+This part of documentation is still work in progress.
+:::

website/docs/addon_3dsmax_artist.md

@@ -1,9 +1,16 @@
 ---
 id: addon_3dsmax_artist
-title: 3dsmax
-sidebar_label: 3dsmax
+title: 3Ds Max Artist Docs
+sidebar_label: 3Ds Max
 ---
 
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.Max_Badge}
+</ReactMarkdown>
+
 :::note Work in progress
 This part of documentation is still work in progress.
 :::

website/docs/addon_aftereffects_admin.md

@@ -1,9 +1,16 @@
 ---
 id: addon_aftereffects_admin
-title: AfterEffects Admin docs
-sidebar_label: AfterEffects
+title: After Effects Admin Docs
+sidebar_label: After Effects
 ---
 
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.Aftereffects_Badge}
+</ReactMarkdown>
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
@@ -12,12 +19,15 @@ import TabItem from '@theme/TabItem';
 There is a couple of settings that could configure publishing process for **AfterEffects**.
 All of them are Project based, eg. each project could have different configuration.
 
-Location: Settings > Project > AfterEffects
+Location: `ayon+settings://aftereffects/publish`
 
 ![AfterEffects Project Settings](assets/admin_hosts_aftereffects_settings.png)
 
 ## Publish plugins
 
+### Collect Review
+Enable/disable collecting reviews. If disabled, no review will be created at all. 
+
 ### Validate Scene Settings
 
 #### Skip Resolution Check for Tasks
@@ -28,6 +38,13 @@ Set regex pattern(s) to look for in a Task name to skip resolution check against
 
 Set regex pattern(s) to look for in a Task name to skip `frameStart`, `frameEnd` check against values from DB.
 
+### Validate Containers
+Checks if all imported assets to the workfile through `Loader` are in latest version. Limits cases that older version of asset would be used.
+
+If enabled, artist might still decide to disable validation for each publish (for special use cases).
+Limit this optionality by toggling `Optional`.
+`Active` toggle denotes that by default artists sees that optional validation as enabled.
+
 ### AfterEffects Submit to Deadline
 
 * `Use Published scene` - Set to True (green) when Deadline should take published scene as a source instead of uploaded local one.

website/docs/addon_aftereffects_artist.md

@@ -1,8 +1,16 @@
 ---
 id: addon_aftereffects_artist
-title: AfterEffects
-sidebar_label: AfterEffects
+title: After Effects Artist Docs
+sidebar_label: After Effects
 ---
+
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.Aftereffects_Badge}
+</ReactMarkdown>
+
 <!-- based on PS implementation, same principle and menu -->
 ## Available Tools
 
@@ -40,7 +48,7 @@ When you are ready to share some work, you will need to publish it. This is done
 
 There is always instance for workfile created automatically (see 'workfileCompositing' item in `Products to publish` column.) This allows to publish (and therefore backup) workfile which is used to produce another publishable elements (as `image` and `review` items).
 
-Main publishable item in AfterEffects will be of `render` family. Result of this item (instance) is picture sequence that could be a final delivery product or loaded and used in another DCCs.
+Main publishable item in AfterEffects will be of `render` product type. Result of this item (instance) is picture sequence that could be a final delivery product or loaded and used in another DCCs.
 
 First select existing composition and then press `Create >>>` in middle column of `Publisher`.
 
@@ -97,9 +105,9 @@ There are currently 2 options of `render` item:
 
 When you want to load existing published work, you can use the `Loader` tool. You can reach it in the extension's panel.
 
-![Loader](assets/photoshop_loader.png) <!-- picture needs to be changed -->
+![Loader](assets/loader.png) <!-- picture needs to be changed -->
 
-The supported families for loading into AfterEffects are:
+The supported product types for loading into AfterEffects are:
 
 - `image`
 - `plate`
@@ -111,7 +119,7 @@ The supported families for loading into AfterEffects are:
 
 To load an item, right-click on the product you want and choose a representation you want to load:
 
-![Loader](assets/photoshop_loader_load.gif)
+![Loader](assets/loader_load.gif)
 
 ### Manage
 
@@ -121,12 +129,12 @@ Now that we have some content loaded, you can manage which version is loaded. Th
 Loaded images have to stay as smart layers in order to be updated. If you rasterize the layer, you can no longer update it to a different version using AYON tools.
 :::
 
-![Loader](assets/photoshop_manage.png)
+![Loader](assets/manage.png)
 
 You can switch to a previous version of the image or update to the latest.
 
-![Loader](assets/photoshop_manage_switch.gif)
-![Loader](assets/photoshop_manage_update.gif)
+![Loader](assets/manage_switch.gif)
+![Loader](assets/manage_update.gif)
 
 #### Support help
 If you would like to ask for help admin or support, you could use any of the three options on the `Note` button on bottom left:
@@ -144,3 +152,64 @@ could be used right away.
 
 If you hit on unexpected behaviour with old instances, contact support first, then you could try to delete and recreate instances from scratch.
 Nuclear option is to purge workfile metadata in `Window > Metadata > Basic > Label`. This is only for most determined daredevils though!
+
+### Setting section
+
+Composition properties should be controlled by state in Asset Management System (Ftrack etc). Extension provides couple of buttons to trigger this propagation.
+
+#### Set Resolution
+
+Set width and height from AMS to composition.
+
+#### Set Frame Range
+
+Start frame and duration in workarea is set according to the settings in AMS. Handles are incorporated (not inclusive).
+It is expected that composition(s) is selected first before pushing this button!
+
+#### Apply All Settings
+
+Both previous settings are triggered at same time.
+
+### Experimental tools
+
+Currently empty. Could contain special tools available only for specific hosts for early access testing.
+
+
+### Workfile builder section
+
+Next 3 menu items handle creation and usage advanced workfile builder. This could be used to prepare workfile template with placeholders for loaded items and publishable items.
+This allow to build template with layers for guides, any text layers and layer for image content which get dynamically populated when template is used an populated by an artist.
+
+#### Create placeholder
+
+Load or Create placeholders could be used to provide dynamic content or preparation steps for publish.
+
+##### Load Placeholder
+
+This one provide way how to load particular representation for particular product for particular asset for particular task.
+Eg. Whenever artist start `animation` task they want to load `png` representation of `imageMain` product of current context's asset.
+
+![Load placeholder](assets/aftereffects_load_placeholder.png)
+
+#### Create Placeholder
+
+This allows to create new composition and when populated it will be enhanced with metadata for publish instance which will be created.
+
+![Create placeholder](assets/aftereffects_create_placeholder.png)
+
+
+### Example
+
+This is how it looks when `Load placeholder` was used to create `LOADERPLACEHOLDER` item which is added as a layer into `CREATEPLACEHOLDER` composition
+created by `Create placeholder`.
+
+![Prepared template](assets/aftereffects_prepared_template.png)
+
+Load placeholder was configured to load `image` product type, product with name `imageMain` and `png` representation.
+
+Any additional layers could be added into composition, when `Build Workfile from template` will be used by an artist, load placeholders will be replace
+by loaded item(s).
+
+![Prepared template](assets/aftereffects_populated_template.png)
+
+Same prepared template could be used for any asset, in each case correct asset according to context will be used automatically.

website/docs/addon_blender_admin.md

@@ -1,9 +1,16 @@
 ---
 id: addon_blender_admin
-title: Blender Admin docs
+title: Blender Admin Docs
 sidebar_label: Blender
 ---
 
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.Blender_Badge}
+</ReactMarkdown>
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
@@ -95,7 +102,7 @@ Enable it to define a default unit scale.
 //
 
 ### Workfile Builder
-Find more informations about the Workfile Builder in the [Nuke Documentation](admin_hosts_nuke#workfile-builder).
+Find more informations about the Workfile Builder in the [Nuke Documentation](addon_nuke_admin.md#workfile-builder).
 
 ### Publish plugins
  Find here the publish plugins.

website/docs/addon_blender_artist.md

@@ -1,9 +1,16 @@
 ---
 id: addon_blender_artist
-title: Blender
+title: Blender Artist Docs
 sidebar_label: Blender
 ---
 
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.Blender_Badge}
+</ReactMarkdown>
+
 ## AYON global tools
 
 -   [Work Files](artist_tools_workfiles)

website/docs/addon_clockify_admin.md

@@ -1,10 +1,20 @@
 ---
 id: addon_clockify_admin
-title: Clockify Admin docs 
+title: Clockify Admin Docs 
 sidebar_label: Clockify
 ---
 
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.Clockify_Badge}
+</ReactMarkdown>
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
+:::note Work in progress
+This part of documentation is still work in progress.
+:::
 

website/docs/addon_deadline_admin.md

@@ -1,9 +1,16 @@
 ---
 id: addon_deadline_admin
-title: Deadline Admin docs
+title: Deadline Admin Docs
 sidebar_label: Deadline
 ---
 
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.Deadline_Badge}
+</ReactMarkdown>
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 

website/docs/addon_ftrack_actions.md

@@ -1,9 +1,16 @@
 ---
 id: addon_ftrack_actions
 title: Ftrack Actions
-sidebar_label: Ftrack actions
+sidebar_label: Ftrack Actions
 ---
 
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.Ftrack_Badge}
+</ReactMarkdown>
+
 Actions are small useful tools that help artists, managers and administrators.
 To avoid overfilled action menu some actions are filtered by entity types and some of them by user roles permissions.
 
@@ -73,7 +80,7 @@ Project Manager or Supervisor must set project's applications during project pre
 Synchronization to AYON is key process to keep AYON data updated. Action updates selected entities (Project, Shot, Sequence, etc.) and all nested entities to AYON database. If action is successfully finished [Sync Hier Attrs](#sync-hier-attrs) action is triggered.
 
 There are 2 versions of **Sync to AYON**, first labeled as **server** second as **local**.
-* **server** version will be processed with [event server](module_ftrack.md#event-server)
+* **server** version will be processed with [event server](addon_ftrack_admin#event-server)
 * **local** version will be processed with user's AYON tray application
 
 It is recommended to use **local** version if possible to avoid unnecessary deceleration of event server.
@@ -85,7 +92,7 @@ It is recommended to use **local** version if possible to avoid unnecessary dece
 Synchronization to AYON of Ftrack's hierarchical Custom attributes is a bit complicated so we decided to split synchronization process into 2 actions. This action updates hierarchical Custom attributes of selected entities (Project, Shot, Sequence, etc.) and all their nested entities to pipeline database. This action is also triggered automatically after successfully finished [Sync To AYON](#sync-to-ayon) action.
 
 There are 2 versions of **Sync Hier Attrs** first labeled as **server** second as **local**.
-* **server** version will be processed with [event server](module_ftrack.md#event-server)
+* **server** version will be processed with [event server](addon_ftrack_admin.md#event-server)
 * **local** version will be processed with user's AYON application
 
 It is recommended to use **local** version if possible to avoid unnecessary deceleration of event server.

website/docs/addon_ftrack_admin.md

@@ -1,9 +1,16 @@
 ---
 id: addon_ftrack_admin
-title: Ftrack Admin docs
+title: Ftrack Admin Docs
 sidebar_label: Ftrack
 ---
 
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.Ftrack_Badge}
+</ReactMarkdown>
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
@@ -16,17 +23,17 @@ Ftrack is currently the main project management option for AYON. This documentat
 If you want to connect Ftrack to AYON you might need to make few changes in Ftrack settings. These changes would take a long time to do manually, so we prepared a few Ftrack actions to help you out. First, you'll need to launch AYON settings, enable [Ftrack module](admin_settings_system.md#Ftrack), and enter the address to your Ftrack server.
 
 ### Login
-Once your server is configured, restart AYON and you should be prompted to enter your [Ftrack credentials](artist_ftrack.md#How-to-use-Ftrack-in-AYON) to be able to run our Ftrack actions. If you are already logged in to Ftrack in your browser, it is enough to press `Ftrack login` and it will connect automatically.
+Once your server is configured, restart AYON and you should be prompted to enter your [Ftrack credentials](addon_kitsu_artist.md#How-to-use-Ftrack-in-AYON) to be able to run our Ftrack actions. If you are already logged in to Ftrack in your browser, it is enough to press `Ftrack login` and it will connect automatically.
 
-For more details step by step on how to login to Ftrack in AYON to go [artist Ftrack login](artist_ftrack.md#How-to-use-Ftrack-in-AYON) documentation.
+For more details step by step on how to login to Ftrack in AYON to go [artist Ftrack login](addon_kitsu_artist.md#How-to-use-Ftrack-in-AYON) documentation.
 
 You can only use our Ftrack Actions and publish to Ftrack if each artist is logged in.
 
 
 ### Custom Attributes
 After successfully connecting AYON with you Ftrack, you can right-click on any project in Ftrack and you should see a bunch of actions available. The most important one is called `AYON Admin` and contains multiple options inside.
 
-To prepare Ftrack for working with AYON you'll need to run [AYON Admin - Create/Update Custom Attributes](manager_ftrack_actions.md#create-update-custom-attributes), which creates and sets the Custom Attributes necessary for AYON to function.
+To prepare Ftrack for working with AYON you'll need to run [AYON Admin - Create/Update Custom Attributes](addon_ftrack_manager.md#create-update-custom-attributes), which creates and sets the Custom Attributes necessary for AYON to function.
 
 
 ## Event Server
@@ -60,15 +67,15 @@ Events are helpers for automation. They react to Ftrack Web Server events like c
 
 ### Sync to AYON
 
-Automatic [synchronization to pipeline database](manager_ftrack.md#synchronization-to-ayon-server).
+Automatic [synchronization to pipeline database](addon_ftrack_manager.md#synchronization-to-ayon-server).
 
-This event updates entities on their changes Ftrack. When new entity is created or existing entity is modified. Interface with listing information is shown to users when [synchronization rules](manager_ftrack.md#synchronization-rules) are not met. This event may also undo changes when they might break pipeline. Namely _change name of synchronized entity_, _move synchronized entity in hierarchy_.
+This event updates entities on their changes Ftrack. When new entity is created or existing entity is modified. Interface with listing information is shown to users when [synchronization rules](addon_ftrack_manager.md#synchronization-rules) are not met. This event may also undo changes when they might break pipeline. Namely _change name of synchronized entity_, _move synchronized entity in hierarchy_.
 
 ### Synchronize Hierarchical and Entity Attributes
 
 Auto-synchronization of hierarchical attributes from Ftrack entities.
 
-Related to [Synchronize to AYON database](manager_ftrack.md#synchronization-to-ayon-server) event _(without it, it makes no sense to use this event)_. Hierarchical attributes must be synchronized with special way so we needed to split synchronization into 2 parts. There are [synchronization rules](manager_ftrack.md#synchronization-rules) for hierarchical attributes that must be met otherwise interface with messages about not meeting conditions is shown to user.
+Related to [Synchronize to AYON database](addon_ftrack_manager.md#synchronization-to-ayon-server) event _(without it, it makes no sense to use this event)_. Hierarchical attributes must be synchronized with special way so we needed to split synchronization into 2 parts. There are [synchronization rules](addon_ftrack_manager.md#synchronization-rules) for hierarchical attributes that must be met otherwise interface with messages about not meeting conditions is shown to user.
 
 ### Update Hierarchy thumbnails