OP-3908 - updates to documentation

website/docs/artist_hosts_photoshop.md

@@ -22,32 +22,75 @@ When you launch Photoshop you will be met with the Workfiles app. If dont have a
 
 In Photoshop you can find the tools in the `OpenPype` extension:
 
-![Extension](assets/photoshop_extension.PNG) <!-- picture needs to be changed -->
+![Extension](assets/photoshop_extension.png) <!-- picture needs to be changed -->
 
 You can show the extension panel by going to `Window` > `Extensions` > `OpenPype`.
 
-### Create
+### Publish
 
-When you have created an image you want to publish, you will need to create special groups or tag existing groups. To do this open the `Creator` through the extensions `Create` button.
+When you are ready to share some work, you will need to publish. This is done by opening the `Publisher` through the `Publish...` button.
 
-![Creator](assets/photoshop_creator.PNG)
+![Publish](assets/photoshop_publish.png)
 
-With the `Creator` you have a variety of options to create:
+There is always instance for workfile created automatically (see 'workfileArt' item in `Subsets to publish` column.) This allows to publish (and therefore backup)
+workfile which is used to produce another publishable elements (as `image` and `review` items).
 
-- Check `Use selection` (A dialog will ask whether you want to create one image per selected layer).
-    - Yes.
-        - No selection.
-            - This will create a single group named after the `Subset` in the `Creator`.
-        - Single selected layer.
-            - The selected layer will be grouped under a single group named after the selected layer.
-        - Single selected group.
-            - The selected group will be tagged for publishing.
-        - Multiple selected items.
-            - Each selected group will be tagged for publishing and each layer will be grouped individually.
-    - No.
-        - All selected layers will be grouped under a single group named after the `Subset` in the `Creator`.
-- Uncheck `Use selection`.
-    - This will create a single group named after the `Subset` in the `Creator`.
+#### Create
+
+Main publishable item in Photoshop will be of `image` family. Result of this item (instance) is picture that could be loaded and used in another DCCs (for example as
+single layer in composition in AfterEffects, reference in Maya etc).
+
+There are couple of options what to publish:
+- separate image per layer (or group of layers)
+- all visible layers (groups) flattened into single image
+
+In most cases you would like to keep `Create only for selected` toggled on and select what you would like to publish. Toggling this off
+will allow you to create instance(s) for all visible layers without a need to select them explicitly.
+
+For separate layers option keep `Create separate instance for each selected` toggled, select multiple layers and hit `Create >>>` button in the middle column.
+
+This will result in:
+
+![Image instances creates](assets/photoshop_publish_images.png)
+
+(In Photoshop's `Layers` tab standard layers will be wrapped into group and enriched with ℗ symbol to denote publishable instance. With `Create separate instance for each selected` toggled off
+it will create only single publishable instance which will wrap all visible layers.)
+
+Name of publishable instance (eg. subset name) could be configured with a template in `project_settings/global/tools/creator/subset_name_profiles`.
+(This must be configured by admin who has access to Openpype Settings.)
+
+Trash icon under the list of instances allows to delete any selected `image` instance.
+
+Workfile instance will be automatically recreated though. If you do not want to publish it, use pill toggle on the instance item.
+
+If you would like to modify publishable instance, click on `Publish` tab at the top. This would allow you to change name of publishable
+instances, disable them from publishing, change their task etc.
+
+Publisher allows publishing into different context, just click on any instance, update `Variant`, `Asset` or `Task` in the form in the middle and don't forget to click on the 'Confirm' button.
+
+#### Validate
+
+If you would like to run validation rules set by your Studio, click on funnel icon at the bottom right. This will run through all
+enabled instances, you could see more information after clicking on `Details` tab.
+
+![Image instances creates](assets/photoshop_publish_validations.png)
+
+In this dialog you could see publishable instances in left colummn, triggered plugins in the middle and logs in the right column.
+
+In left column you could see that `review` instance was created automatically. This instance flattens all publishable instances or
+all visible layers if no publishable instances were created into single image which could serve as a single reviewable element (for example in Ftrack).
+
+Creation of Review could be disabled in `project_settings/photoshop/publish/CollectReview`.
+
+If you are satisfied with results of validation phase (and there are no errors there), you might hit `Publish` button at bottom right.
+This will run through extraction phase (it physically creates images from `image` instances, creates `review` etc) and publishes them
+(eg. stores files into their final destination and stores metadata about them into DB).
+This part might take a while depending on amount of layers in the workfile, amount of available memory and performance of your machine.
+
+You may encounter issues with publishing which will be indicated with red squares. If these issues are within the validation section, then you can fix the issue. If there are issues outside of validation section, please let the OpenPype team know.
+
+You can always start new publish run with a circle arrow button at the bottom right. You might also want to move between phases (Create, Update etc)
+by clicking on available tabs at the top of the dialog.
 
 #### Simplified publish
 
@@ -55,39 +98,28 @@ There is a simplified workflow for simple use case where only single image shoul
 No image instances must be present in a workfile and `project_settings/photoshop/publish/CollectInstances/flatten_subset_template` must be filled in Settings.
 Then artists just need to hit 'Publish' button in menu.
 
-### Publish
-
-When you are ready to share some work, you will need to publish. This is done by opening the `Pyblish` through the extensions `Publish` button.
-
-![Publish](assets/photoshop_publish.PNG) <!-- picture needs to be changed -->
-
-This tool will run through checks to make sure the contents you are publishing is correct. Hit the "Play" button to start publishing.
-
-You may encounter issues with publishing which will be indicated with red squares. If these issues are within the validation section, then you can fix the issue. If there are issues outside of validation section, please let the OpenPype team know.
-
 #### Repair Validation Issues
 
-All validators will give some description about what the issue is. You can inspect this by going into the validator through the arrow:
+If there is some issue in validator phase, you will receive something like this:
 
-![Inspect](assets/photoshop_publish_inspect.PNG) <!-- picture needs to be changed -->
+![Validation error](assets/photoshop_publish_failed.png)
 
-You can expand the errors by clicking on them for more details:
+All validators will give some description about what the issue is. You can inspect this by clicking on items in the left column.
 
-![Expand](assets/photoshop_publish_expand.PNG) <!-- picture needs to be changed -->
+If there is an option of automatic repair, there will be `Repair` button on the right. In other case you need to fix the issue manually.
+(By deleting and recreating instance etc.)
 
-Some validator have repair actions, which will fix the issue. If you can identify validators with actions by the circle icon with an "A":
-
-![Actions](assets/photoshop_publish_actions.PNG) <!-- picture needs to be changed -->
-
-To access the actions, you right click on the validator. If an action runs successfully, the actions icon will turn green. Once all issues are fixed, you can just hit the "Refresh" button and try to publish again.
-
-![Repair](assets/photoshop_publish_repair.gif) <!-- picture needs to be changed -->
+#### Buttons on the bottom right are for:
+- `Refresh publishing` - set publishing process to starting position - useful if previous publish failed, or you changed configuration of a publish
+- `Stop/pause publishing` - if you would like to pause publishing process at any time
+- `Validate` - if you would like to run only collecting and validating phases (nothing will be published yet)
+- `Publish` - standard way how to kick off full publishing process
 
 ### Load
 
 When you want to load existing published work, you can load in smart layers through the `Loader`. You can reach the `Loader` through the extension's `Load` button.
 
-![Loader](assets/photoshop_loader.PNG) <!-- picture needs to be changed -->
+![Loader](assets/photoshop_loader.png) <!-- picture needs to be changed -->
 
 The supported families for Photoshop are:
 
@@ -105,7 +137,7 @@ Now that we have some images loaded, we can manage which version is loaded. This
 Loaded images has to stay as smart layers in order to be updated. If you rasterize the layer, you cannot update it to a different version.
 :::
 
-![Loader](assets/photoshop_manage.PNG)
+![Loader](assets/photoshop_manage.png)
 
 You can switch to a previous version of the image or update to the latest.
 
@@ -113,65 +145,19 @@ You can switch to a previous version of the image or update to the latest.
 ![Loader](assets/photoshop_manage_update.gif)
 
 
-### New Publisher
-
-All previous screenshot came from regular [pyblish](https://pyblish.com/) process, there is also a different UI available. This process extends existing implementation and adds new functionalities.
-
-To test this in Photoshop, the artist needs first to enable experimental `New publisher` in Settings. (Tray > Settings > Experimental tools)
-![Settings](assets/experimental_tools_settings.png)
-
-New dialog opens after clicking on `Experimental tools` button in Openpype extension menu.
-![Menu](assets/experimental_tools_menu.png)
-
-After you click on this button, this dialog will show up.
-
-![Menu](assets/artist_photoshop_new_publisher_workfile.png)
-
-You can see the first instance, called `workfileYourTaskName`. (Name depends on studio naming convention for Photoshop's workfiles.). This instance is so called "automatic", 
-it was created without instigation by the artist. You shouldn't delete this instance as it might hold necessary values for future publishing, but you can choose to skip it
-from publishing (by toggling the pill button inside of the rectangular object denoting instance).
-
-New publisher allows publishing into different context, just click on a workfile instance, update `Variant`, `Asset` or `Task` in the form in the middle and don't forget to click on the 'Confirm' button.
-
-Similarly to the old publishing approach, you need to create instances for everything you want to publish. You will initiate by clicking on the '+' sign in the bottom left corner.
-
-![Instance creator](assets/artist_photoshop_new_publisher_instance.png)
-
-In this dialog you can select the family for the published layer or group. Currently only 'image' is implemented.
-
-On right hand side you can see creator attributes:
-- `Create only for selected` - mimics `Use selected` option of regular publish
-- `Create separate instance for each selected` - if separate instance should be created for each layer if multiple selected
-
-![Instance created](assets/artist_photoshop_new_publisher_instance_created.png)
-
-Here you can see a newly created instance of image family. (Name depends on studio naming convention for image family.) You can disable instance from publishing in the same fashion as a workfile instance.
-You could also decide delete instance by selecting it and clicking on a trashcan icon (next to plus button on left button)
-
-Buttons on the bottom right are for:
-- `Refresh publishing` - set publishing process to starting position - useful if previous publish failed, or you changed configuration of a publish
-- `Stop/pause publishing` - if you would like to pause publishing process at any time
-- `Validate` - if you would like to run only collecting and validating phases (nothing will be published yet)
-- `Publish` - standard way how to kick off full publishing process
-
-In the unfortunate case of some error during publishing, you would receive this kind of error dialog.
-
-![Publish failed](assets/artist_photoshop_new_publisher_publish_failed.png)
-
-In this case there is an issue that you are publishing two or more instances with the same subset name ('imageMaing'). If the error is recoverable by the artist, you should
-see helpful information in a `How to repair?` section or fix it automatically by clicking on a 'Wrench' button on the right if present.
-
-If you would like to ask for help admin or support, you could use any of the three buttons on bottom left:
+#### 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:
+- `Go to details` - switches into a more detailed list of published instances and plugins.
 - `Copy report` - stash full publishing log to a clipboard
-- `Export and save report` - save log into a file for sending it via mail or any communication tool
-- `Show details` - switches into a more detailed list of published instances and plugins. Similar to the old pyblish list.
+- `Export report` - save log into a file for sending it via mail or any communication tool
 
 If you are able to fix the workfile yourself, use the first button on the right to set the UI to initial state before publish. (Click the `Publish` button to start again.)
 
+#### Legacy instances
+
+All screenshots from Publish are from updated dialog, before publishing was being done by regular `Pyblish` tool.
 New publishing process should be backward compatible, eg. if you have a workfile with instances created in the previous publishing approach, they will be translated automatically and
 could be used right away.
 
-If you would create instances in a new publisher, you cannot use them in the old approach though!
-
-If you would hit on unexpected behaviour with old instances, contact support first, then you could try some steps to recover your publish. Delete instances in New publisher UI, or try `Subset manager` in the extension menu.
+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 `File > File Info > Origin > Headline`. This is only for most determined daredevils though!