Merge pull request #153 from ynput/enhancement/Photoshop-artist-docs

Photoshop: Documentation adjustment and enhancements

website/docs/addon_photoshop_artist.md

@@ -19,19 +19,39 @@ import versions from '@site/docs/assets/json/Ayon_addons_version.json'
 -   [Publish](artist_tools_publisher)
 -   [Manage](artist_tools_inventory)
 
+## Working With AYON in Photoshop
+
+The Photoshop AYON integration allows you to:
+
+- Manage your Photoshop work files using correct naming, version and save location with ease
+- Produce / Automate Image Assets creation which can be easily shared across production environment
+- Make Reviews acting as a thumbnail / preview for production management software like Ftrack, Kitsu etc. so everyone being aware of the newest  version available
+- Loading / Managing asset versions in PS work files within the project
+
 ## Setup
 
-To install the extension, download, install [Anastasyi's Extension Manager](https://install.anastasiy.com/). Open Anastasyi's Extension Manager and select Photoshop in menu. Then go to `{path to PS addon}hosts/photoshop/api/extension.zxp`.
+There need to be done several setup steps first before running the AYON integration. First your active project need to have Photoshop (PS) defined in the project anatomy as an available tool including its filepath to the executable (being set by default). Secondly its neccessary to install PS extension manager which simplifies future extensions installation / management for PS. We skip the first step due to the fact it should be already preset by TD / Admin. And we jump to the second step instead right away.
 
-(Current location will be most likely in artist `AppData`, on Windows it would be something like `c:\Users\YOUR_USER\AppData\Local\Ynput\AYON\addons\core_X.X.X\ayon_core\hosts\photoshop\api`.
-On Linux look in `~/.local/share/Ynput/AYON/addons`, on Mac `~/Library/Application Support/Ynput/AYON/addons`)
-This location is temporary until full separation of addons is implemented. Artist must start Tray at least once for Ayon server to populate this location.)
+To install the `extension manager` , open the following link and download it first [Anastasyi's Extension Manager](https://install.anastasiy.com/).
+Open Anastasyi's Extension Manager and select Photoshop in the menu. Then go to `{path to PS addon}hosts/photoshop/api/extension.zxp`.
+Current location will be most likely in `/User/AppData`, on `WINDOWS` it would be something like `c:\Users\YOUR_USER\AppData\Local\Ynput\AYON\addons\core_xx.xx.xx\ayon_core\hosts\photoshop\api`.
+On Linux look in `~/.local/share/Ynput/AYON/addons`, on Mac `~/Library/Application Support/Ynput/AYON/addons`
+
+:::info
+The file path being temporary until final AYON release though. User also has to start `AYON Launcher`  tray app at least for once to populate aformentioned filepath with those files.
+:::
 
 ## Usage
 
-When you launch Photoshop you will be met with the Workfiles app. If you don't have any previous workfiles, you can just close this window.
+When you launch Photoshop you will be met with the floating `Workfiles` window. If you don't have any previous workfiles, you can just close this window right away.
+
+![Workfiles](assets/photoshop_workfiles.png)
 
-In Photoshop you can find the tools in the `AYON` extension:
+After that you will be introduced to `AYON` toolset on the right side of the Photoshop UI next to its icon.
+![Extension](assets/photoshop_extension.png)
+
+
+You can also locate the extension panel in Photoshop Menu by going to `Window` > `Extensions` > `AYON` if necessary or collapse the menu by hitting the `AYON` icon next to it.
 
 ![Extension](assets/photoshop_extension.png) <!-- picture needs to be changed -->
 
@@ -43,39 +63,88 @@ On newer MacOS you need to:
 - right clicking on the `Adobe Photoshop XXXX.app`
 - then `Get Info`, check `Open using Rosetta`
 :::
+![Extension](assets/photoshop_extension_menu.png)
+
+### Saving active Photoshop document as Workfile
+
+Create or open any valid Photoshop file which will act as your `Workfile` from now on. Navigate to the `AYON` tools and trigger `Workfiles` and hit `Save As`. Your document will be properly named and versioned following rules set for the active project and saved to the correct folder location automatically.Think of this tool as a substitude for classic `File>Save` and `File>Open` as you will use it exclusively when in `AYON` Photoshop mode. 
+
+![Workfile tool](assets/photoshop_workfiles_select.png)
+
+
+:::note
+Even though classic `File>Open` and `File>Save` being available to you, use `AYON`>`Workfiles` instead as you will get proper naming and file destination automatically without need to worry about any of these! However you can trigger classic `CTRL+S` anytime too for quick saving of your progress as you would normally do.
+:::
+
+![Workfile](assets/photoshop_document.png)
+
+In the above picture you can see my `Workfile` being properly named and versioned and its a clear indication of correctly saved document.
 
 ### Publish
 
-When you are ready to share some work, you will need to publish. This is done by opening the `Publisher` through the `Publish...` button.
+When you are ready to share your work with rest of the team, you will need to publish it first. `Publish` action does produce an asset, saved in separate publish folder and written into project database and being instantly available for loading as an `Image` asset into desired destination. This is done by opening the `Publisher` tool through the `Publish...` menu entry in the `AYON` toolset.
+
+![Publish tool](assets/photoshop_publish_select.png)
+
+Publisher shows up allowing you to produce your very first `Image` asset for production. We will briefly inspect Publisher components first.
+
+It consists of multiple tabs at the very top `Create` `Publish` `Report` `Details`, each for a different occasion during publishing process as the naming suggests. We skip `Create` and head to `Publish` tab as we should have already products ready for publishing and no need to create those manually.
 
 ![Publish](assets/photoshop_publish.png)
 
-There is always instance for workfile created automatically (see 'workfileArt' 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).
+If not already, switch to `Publish` tab now (you should see it as picture above).
+
+ On the left side there is list of `Products to publish`. These widgets represents assets which will be produced when the publishing finnishes also having knobs for enabling/disabling publishing next to each, namely `image` , `review` and `workfile`. The `Context` type can be ignored for now as it is implicit widget and does not produce any asset to worry about.
+
+- `Image` represents your artwork aka asset for publishing
+- `Review` represents preview of your `Image` asset usually as a JPG with smaller size
+- `Workfile` acting like backup file copied together with your `Image` asset to separate publish folder 
+
+Disable any product type if needed and when ready, go and hit `Publish` button at the very bottom right.
+
+Your assets just have been publicly available within the project and can be loaded via `Load` action from `AYON` menu.
+
+To summarize it, you can enable or disable any publish product and repeat publishing over and over producing new version of the asset each time if desired.
+
+:::note
+The list of available `products for publishing` can differ in yours as it is depedent on `AYON` settings by studio TDs
+
+:::
 
 #### Create
 
-Main publishable item in Photoshop will be of `image` product type. 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).
+When in the `Publisher` and `Create` tab, you are able to populate your workfile with new `publish` type besides the already present ones. You are free to add/remove any of those which gives you a lot of possibilities in terms of publishing full photoshop document or just particular layer(s).
+
+There is just `Image` product type available to you in the Photoshop which produces 2d pixel image acting for example as a layer in AE composition or as a reference imagePlane in Maya or image in Nuke compostion.
+
+![Publish - Create](assets/photoshop_create.png)
 
-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.
+`Image` creator has multiple options for tweaking its output and way the data being produced.
 
-For separate layers option keep `Create separate instance for each selected` toggled, select multiple layers and hit `Create >>>` button in the middle column.
+- `Create only for selected` - creates `Image` just for selected layer(s)
+- `Create separate instance for each selected` - creates `Image` for each layer in your selection of layers
+- `Use layer name` - appends the layer name to the `Image` product
+- `Create separate review` - creates `Review` product besides the implicit one as a separate product for each `Image`
 
-This will result in:
+In most cases you would like to keep `Create only for selected` toggled `ON` and select exact Photoshop layer(s) which you would like to publish. When this option being `OFF` than there is no need to select anything and `Image` being created for all the visible layers in the active workfile similar to Flatten Image.
 
-![Image instances creates](assets/photoshop_publish_images.png)
+When multiple layers selected and `Create separate instance for each selected` toggled `ON` you will get `Image` for each layer separately.
 
-(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.)
+For example when selecting `Layer01` , `Layer02` and `Layer03` then it will produce these product types
 
-Name of publishable instance (eg. product name) could be configured with a template in `project_settings/global/tools/creator/product_name_profiles`.
-(This must be configured by admin who has access to AYON Settings.)
+![Image instances creates](assets/photoshop_instances.png)
+
+ and also marks actual Photoshop layers with ℗ icon standing for publishing
+
+![Image instances layers](assets/photoshop_layers.png)
+
+
+With `Create separate instance for each selected` toggled `OFF` it will create only single publishable instance which will wrap all selected layers into single Group again marked with ℗ icon.
+
+:::note
+Name of publishable instance (eg. product name) can be configured by studio admin TD with a template in `project_settings/global/tools/creator/product_name_profiles`.
+:::
 
 Trash icon under the list of instances allows to delete any selected `image` instance.
 
@@ -139,7 +208,7 @@ When you want to load existing published work, you can load in smart layers thro
 
 ![Loader](assets/loader.png)
 
-The supported product types for Photoshop are:
+The supported product type for Photoshop being
 
 - `image`
 
@@ -151,7 +220,7 @@ To load an image, right-click on the product you want and choose a representatio
 
 Now that we have some images loaded, we can manage which version is loaded. This is done through the `Scene Inventory`. You can reach it through the extension's `Manage` button.
 
-:::note
+:::warning
 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.
 :::
 
@@ -163,19 +232,23 @@ You can switch to a previous version of the image or update to the latest.
 ![Loader](assets/manage_update.gif)
 
 
-#### Support help
+#### Support & Issues
 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 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
+#### Legacy Publish Instances Support
 
 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.
 
+#### Removing AYON metadata from the document
+
 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!
+
+![Metadata](assets/photoshop_metadata.png)