diff --git a/website/docs/addon_core_settings.md b/website/docs/addon_core_settings.md index 44501495..a1336d92 100644 --- a/website/docs/addon_core_settings.md +++ b/website/docs/addon_core_settings.md @@ -42,7 +42,7 @@ Project settings can have project specific values. Each new project is using stu ## Tools ### Creator -Settings related to [Creator tool](../artist_tools_creator). +Settings related to [Creator tool](artist_tools_creator). #### Product name profiles ![core_tools_creator_product_template](assets/core_tools_creator_product_template.png) @@ -75,7 +75,7 @@ Some creators may have other keys as their context may require more information ### Workfiles -Settings related to [Workfile tool](../artist_tools_workfiles). +Settings related to [Workfile tool](artist_tools_workfiles). #### Open last workfile at launch This feature allows you to define a rule for each task/host or toggle the feature globally to all tasks as they are visible in the picture. @@ -86,7 +86,7 @@ This feature allows you to define a rule for each task/host or toggle the featur #### Template name profiles -Allows to select [anatomy template](admin_settings_project_anatomy.md#templates) based on context of product being published. +Allows to select [anatomy template](admin_settings_project_anatomy#templates) based on context of product being published. For example for `render` profile you might want to publish and store assets in different location (based on anatomy setting) then for `publish` profile. Profile filtering is used to select between appropriate template for each context of published products. @@ -127,7 +127,7 @@ AYON distributes its own OCIO configs. Those can be found in `{ayon install dir} ### Using OCIO config Global config path is set by default to AYON distributed configs. At the moment there are only two - **aces_1.2** and **nuke-default**. Since this path input is not platform specific it is required to use at least an environment variable for platform specific config root directory. Order of paths matter so first existing path found is used. -Each OCIO config path input supports formatting using environment variables and [anatomy template keys](../admin_settings_project_anatomy#available-template-keys). The default global OCIO config path is `{AYON_ROOT}/vendor/bin/ocioconfig/OpenColorIOConfigs/aces_1.2/config.ocio`. +Each OCIO config path input supports formatting using environment variables and [anatomy template keys](admin_settings_project_anatomy#available-template-keys). The default global OCIO config path is `{AYON_ROOT}/vendor/bin/ocioconfig/OpenColorIOConfigs/aces_1.2/config.ocio`. If the project settings for a particular host has its own OCIO config **enabled** and set to at least one path and the path exists, it overrides the global OCIO config for that host. diff --git a/website/docs/addon_flow_admin.md b/website/docs/addon_flow_admin.md new file mode 100644 index 00000000..5beaaea6 --- /dev/null +++ b/website/docs/addon_flow_admin.md @@ -0,0 +1,147 @@ +--- +id: addon_flow_admin +title: Flow (ShotGrid) +sidebar_label: Flow (ShotGrid) +--- + +import ReactMarkdown from "react-markdown"; +import versions from '@site/docs/assets/json/Ayon_addons_version.json' + + +{versions.Flow_Badge} + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::info Addon name +In Ayon, we've been using the name Shotgrid. But since we plan to change it, we'll start calling it Flow addon in our documentation. Sometimes, we might use SG too, just to keep things interesting. +::: + +### Introduction + +Flow ( previously known as ShotGrid or ShotGun) is a production tracking and asset management software that helps studios manage their projects, assets, and shots. The Ayon Flow integration allows you to seamlessly connect your Ayon Studio with Flow and automate the synchronization of your project data between the two systems. The integration enables you to synchronize folder attributes, status, tags, and reviewables between Ayon and Flow + +Current version of the integration also supports following features: + +- Folder attributes two way synchronization +- Folder tasks two way synchronization +- Status synchronization (currently only Ayon to Flow) +- Tags synchronization (currently only Ayon to Flow) +- Reviewables upload to Flow for review +- Three types of Ayon client (desktop) user login: + - via environment variable, + - via Tray widget for User email and password inputs, + - via Tray widget for User email input - with secret shared User api key set in addon settings + + +### Configuring Ayon + +Before any project can be synchronized form Flow first we need to configure the addon's Studio settings. + +#### Setting up Flow Script connection + +1. Go to your Flow server and within your admin menu (1) select Scripts menu item (2). ![Flow Scripts](assets/shotgrid/sg_server_scripts.png) +2. You'll need to create a new item for each access level and give it a name. We're calling our items `ayon_connector` and _`ayon_user_publishing`_. Each item is linked to a different **permission group**. It's important to know that the `ayon_connector` script is only for services, while `ayon_user_publishing` is for users logging into the Ayon Desktop app. This helps us manage different access levels. ![Flow Scripts items](assets/shotgrid/sg_server_scripts_items.png) +3. When you create a script item, remember to save the generated hash key right away because it's only shown once. + +#### Setting Ayon Secrets + +Add the ayon_connector key to Ayon Secrets and name it some easy way so here in our example we are naming it `sg_server_script_key`. You can also add the `ayon_user_publishing` secret here just for future reference, but it will never be used as within SG addon settings. + +#### Flow addon Studio settings configuration + +:::tip Addon Frontend Tab +To be able to use Shotgrid tab in Studio settings you need to have correctly configured addon at **production bundle** state. Please restart the server after you finalized the settings. After that, you should see the Shotgrid tab in Studio settings. +::: + +To get the addon's frontend tab working and sync all Flow projects, you need to set up a few things: + +* Shotgrid URL (`ayon+settings://shotgrid/shotgrid_server`) +* ShotGrid's Script API key (`ayon+settings://shotgrid/service_settings/script_key`) +* ShotGrid's Script Name (`ayon+settings://shotgrid/service_settings/script_name`) + +#### Setting up the ShotGrid URL +First, enter your Flow server URL in the **Shotgrid URL** field. It looks something like `https://yourcompany.shotgrid.autodesk.com`. + +#### Setting up the ShotGrid's Script API key for Services +Next, in the Services section, put your **ShotGrid's Script API key**. You should already have this key. Then, add your **ShotGrid's Script Name**. If you've followed the steps before, you might name it `ayon_connector`. + +![Ayon Scripts items](assets/shotgrid/ay_server_scripts_items.png) + +#### Setting login types for Users +You need to decide how users will log into the Ayon Desktop app. Here are three options: + +1. **Via Environment variable** - This is the default login method. Enter the user's email as `AYON_SG_USERNAME` on each user's computer in your studio. With this method, users won't see their login details on the Tray app widget. +![Ayon user login env](assets/shotgrid/ay_user_login_env.png) + +2. **Via Tray App with password** - Users log in with their email and password. It's a common method, and you can set permissions in Flow. You can create different permission groups for users. However, sometimes users might not have access to certain projects. +![Ayon user login password](assets/shotgrid/ay_user_login_pass.png) + +3. **Via Tray App with shared API key** - Users log in with their email only. The shared secret API key is in the addon settings. This lets you set one permission group for all users. +![Ayon user login shared](assets/shotgrid/ay_user_login_shared.png) + + +#### Setting up local storage for Flow + +In order to use power of Flows file system you have to configure local storage settings. This is done by enabling local storage and adding local storage name which had been previously configured in **Flow's Admin menu** > **Site preferences** > **File management**. Here it is important to **Enable linking to local files** (1) and create preset (2) for multiplatform file system. Copy name of the created preset (3) and paste it in Ayon Studio settings. +![Flow local storage](assets/shotgrid/sg_local_storage.png) + +Paths should be mirroring defined paths in Ayon Anatomy root configuration. ![Anatomy roots](assets/shotgrid/ay_anatomy_roots.png) + +The name of the preset copied previously should be pasted in Ayon Studio settings. ![Ayon local storage](assets/shotgrid/ay_local_storage.png) + +#### Anatomy preset configuration + +To use the Flow addon with Ayon, you need to set up an Anatomy preset. This preset helps sync things between Ayon and Flow. To get started, you can create a new preset or pick an existing one. Right now, the only thing to remember is that _Task Types_, _Folder Types_, and _Statuses_ should each have only one item. Make sure it matches a common item you'd find in Flow. + +Here's how to add a **Comp** task type with the shortcode **cmp**. Make sure to include it in the **Flow Admin menu** under **Pipeline steps**. + +Follow these steps for Folder Type and Statuses too, as explained below. + +To create new Anatomy preset follow these steps: + +![Ayon anatomy preset](assets/shotgrid/sg_anatomy_preset.png) + +1. Go to **Anatomy presets** tab in Studio settings +2. Hit Save as new preset button +3. Name it something like Flow or SG +4. Remove all Folder types except one - make sure it has corresponding type in Flow +5. Remove all Task types except one - make sure it has corresponding type in Flow +6. Remove all Statuses except one - make sure it has corresponding status in Flow + +And now the anatomy preset is ready to be used in Flow addon settings. + +![Ayon anatomy preset set](assets/shotgrid/ay_anatomy_preset_set.png) + +#### Selecting enabled entities for synchronization + +Flow's enabled entity enumerator (`ayon+settings://shotgrid/compatibility_settings/shotgrid_enabled_entities`) lets us pick which entities to sync between Ayon and Flow. We do this by choosing the entities from the list and saving our choices. But remember, we must also turn on these entities in Flow's Project Tracking settings. Ensure all required entities are visible (not hidden). + +![Flow enabled entities](assets/shotgrid/sg_tracking_settings.png) + + +#### Configuring folder attributes synchronization + +To sync folder attributes between Ayon and Flow, set up the **Folder Attributes Map**. Choose attributes to sync by adding the name to the **SG** column (1). Attributes with no value won't be considered. Use the **Scope** column (2) to pick only the Flow entities that should have the attribute. For instance, the **fps** attribute might be used only for Versions, Shots, and Project entities. + +:::note SG attribute names +Use names without the "sg_" prefix, even though they exist in Flow's Field registry with this prefix. The system adds them automatically during synchronization. We first check if a name exists without the prefix and then try it with the prefix for the specific entity. If it's already in the registry, we use it; if not, we create it in Flow's field registry. + +Check the Available Fields in **Flow's Admin menu** > **Fields** +::: + +Here is a typical example of folder attributes mapping: + +![Flow folder attributes](assets/shotgrid/ay_attribute_mapping.png) + + +#### Targeting reviewables to Flow + +You can effortlessly ensure that all reviewables will be uploaded to Flow. For this purpose, you simply need to attach a specific tag to Extract Review output presets. You can achieve this by following these steps: + +1. Navigate either to your Studio Settings or any Project settings. +2. Find and add the **shotgridreview** tag to any of the selected preset's output. + You can do this at the following path `ayon+settings://core/publish/ExtractReview/profiles/0/outputs`. + +![Flow shotgrid review tag](assets/shotgrid/review_tag.png) diff --git a/website/docs/addon_houdini_admin.md b/website/docs/addon_houdini_admin.md index 0c97e497..f15d9579 100644 --- a/website/docs/addon_houdini_admin.md +++ b/website/docs/addon_houdini_admin.md @@ -16,7 +16,7 @@ import versions from '@site/docs/assets/json/Ayon_addons_version.json' ### Add Self Publish Button -Enabling this setting will cause Houdini creator to add a **self publish button** when creating new publish instances. More Info on how how the **self publish button** works [here](artist_hosts_houdini#ayon-publishing-process) +Enabling this setting will cause Houdini creator to add a **self publish button** when creating new publish instances. More Info on how how the **self publish button** works [here](addon_houdini_artist#ayon-publishing-process) ![general_settings_self_publish_button](assets/houdini/admin/general_settings_self_publish_button.png) @@ -106,7 +106,9 @@ Enable or disable the plugins. Some of them have extra options such as defining ## Publish plugins Enable or disable the plugins executed at publishing. -- Collect Rop Frame Range +- Collect Asset Handles +- Collect Chunk Size +- Validate Instance in same Context - Validate Latest Containers - Validate Mesh is Static - Validate Review Colorspace @@ -114,13 +116,16 @@ Enable or disable the plugins executed at publishing. - Validate Unreal Static Mesh Name - Validate workfile paths settings -### Collect Rop Frame Range +### Collect Asset Handles Disable this if you want the publisher to ignore start and end handles specified in the asset data for publish instances. > Artists are allowed to override this value in the publisher UI. ![houdini_publish_plugins_collectors_frame_range](assets/houdini/admin/houdini_publish_plugins_collectors_frame_range.png) +### Validate Instance in same Context +When working in per-shot style you always publish data in context of current asset (shot). This validator checks if this is so. It is optional so it can be disabled when needed. + --- ## FAQ diff --git a/website/docs/addon_houdini_artist.md b/website/docs/addon_houdini_artist.md index 5f4cf64b..878b139f 100644 --- a/website/docs/addon_houdini_artist.md +++ b/website/docs/addon_houdini_artist.md @@ -352,7 +352,10 @@ Steps: ![publisher_ui_vray_rop](assets/houdini/artist/publisher_ui_vray_rop.png) -## Publishing cache to Deadline +## Deadline submission and publishing +Currently, The `Publisher Tool` is used to submit and publish your cache or render from deadline. + +### Publishing cache to Deadline Artist can publish cache to deadline while using local machine for other tasks which increases productivity. Caching on the farm is supported for: @@ -376,6 +379,42 @@ When the render is finished, all the caches would be located in your publish fol You can see them in the Loader. ![Houdini Farm Per Task](assets/houdini/artist/houdini_farm_cache_loader.png) +### Publishing render to Deadline + +Rendering on the farm is supported for: +- **Karma ROP** +- **Mantra ROP** +- **Redshift ROP** +- **Arnold ROP** +- **VRay ROP** + +On instance creation, There are two main settings : +- `Submitting to Farm`: + Where you choose either to submit to farm or render locally. + *Local Render is not implemented yet. So, please keep it enabled.* +- `Split export and render jobs`: + It enables exporting render scene descriptions/proxies e.g. `.ifd`, `.rs`, `.ass`, `.vrscene` + It effectively save render licenses. + +![Houdini Render Creator](assets/houdini/artist/houdini_render_creator.png) + +On Publishing, You can find some of deadline options. +![Houdini Render Publish](assets/houdini/artist/houdini_render_publish.png) + +Here's how it looks like on Deadline in both cases. + +| Split Jobs | No Split | +|--|--| +| ![Houdini Render Publish Split](assets/houdini/artist/houdini_render_publish_split.png) | ![Houdini Render Publish No Split](assets/houdini/artist/houdini_render_publish_no_split.png) | + +:::note Enable/disable splitting +To enable/disable split after publish instance creation. +You'd need to find the export option in ROP node and enable/disable it. +E.g In Mantra: + +![Houdini Render Publish Split Setting](assets/houdini/artist/houdini_render_publish_split_setting.png) +::: + ## Load published products Loading is done by - **load...** : load products from the current project diff --git a/website/docs/addon_nuke_admin.md b/website/docs/addon_nuke_admin.md index 0c13469d..4ec82f13 100644 --- a/website/docs/addon_nuke_admin.md +++ b/website/docs/addon_nuke_admin.md @@ -27,7 +27,7 @@ All Workfile Builder related settings can be found here. This is a list of avail :::important Auto Load Last Version -In case you want to set the auto load of the latest available version of workfiles, you can do it from [here](project_settings_core#open-last-workfile-at-launch). +In case you want to set the auto load of the latest available version of workfiles, you can do it from [here](addon_core_settings#open-last-workfile-at-launch). ::: ### Create first workfile diff --git a/website/docs/addon_slack.md b/website/docs/addon_slack.md index 454c0bd8..3d4e112d 100644 --- a/website/docs/addon_slack.md +++ b/website/docs/addon_slack.md @@ -86,7 +86,7 @@ You might try to add `{review_filepath}` to message content instead of using `Up (It won't show a playable preview though!) #### Message -Message content can use Templating (see [Available template keys](admin_settings_project_anatomy.md#available-template-keys)). +Message content can use Templating (see [Available template keys](admin_settings_project_anatomy#available-template-keys)). Few keys also have Capitalized and UPPERCASE format. Values will be modified accordingly ({Asset} >> "Asset", {FAMILY} >> "RENDER"). diff --git a/website/docs/artist_tools.md b/website/docs/artist_tools.md index 57ee4489..4951cc14 100644 --- a/website/docs/artist_tools.md +++ b/website/docs/artist_tools.md @@ -15,4 +15,3 @@ AYON offers a collection of core tools in tandem with the Integrations: - [Inventory](artist_tools_inventory) - [Workfiles](artist_tools_workfiles) - [Look Assigner](artist_tools_look_assigner) -- [Product Manager](artist_tools_product_manager) diff --git a/website/docs/assets/houdini/admin/houdini_publish_plugins_collectors_frame_range.png b/website/docs/assets/houdini/admin/houdini_publish_plugins_collectors_frame_range.png index 06f4f3a4..7b3f7c48 100644 Binary files a/website/docs/assets/houdini/admin/houdini_publish_plugins_collectors_frame_range.png and b/website/docs/assets/houdini/admin/houdini_publish_plugins_collectors_frame_range.png differ diff --git a/website/docs/assets/houdini/artist/houdini_render_creator.png b/website/docs/assets/houdini/artist/houdini_render_creator.png new file mode 100644 index 00000000..8d26d091 Binary files /dev/null and b/website/docs/assets/houdini/artist/houdini_render_creator.png differ diff --git a/website/docs/assets/houdini/artist/houdini_render_publish.png b/website/docs/assets/houdini/artist/houdini_render_publish.png new file mode 100644 index 00000000..6e58bdfa Binary files /dev/null and b/website/docs/assets/houdini/artist/houdini_render_publish.png differ diff --git a/website/docs/assets/houdini/artist/houdini_render_publish_no_split.png b/website/docs/assets/houdini/artist/houdini_render_publish_no_split.png new file mode 100644 index 00000000..73d40d2c Binary files /dev/null and b/website/docs/assets/houdini/artist/houdini_render_publish_no_split.png differ diff --git a/website/docs/assets/houdini/artist/houdini_render_publish_split.png b/website/docs/assets/houdini/artist/houdini_render_publish_split.png new file mode 100644 index 00000000..06cbc1b6 Binary files /dev/null and b/website/docs/assets/houdini/artist/houdini_render_publish_split.png differ diff --git a/website/docs/assets/houdini/artist/houdini_render_publish_split_setting.png b/website/docs/assets/houdini/artist/houdini_render_publish_split_setting.png new file mode 100644 index 00000000..ca442d4d Binary files /dev/null and b/website/docs/assets/houdini/artist/houdini_render_publish_split_setting.png differ diff --git a/website/docs/assets/json/Ayon_addons_version.json b/website/docs/assets/json/Ayon_addons_version.json index b9b923dd..2dec4462 100644 --- a/website/docs/assets/json/Ayon_addons_version.json +++ b/website/docs/assets/json/Ayon_addons_version.json @@ -13,7 +13,7 @@ "Fusion_Badge" : "[![Fusion Addon - 0.1.0](https://img.shields.io/badge/Fusion_Addon-0.1.0-f8f428)](https://github.com/ynput/OpenPype/tree/develop/openpype/hosts/fusion)", "Harmony_Badge" : "[![Harmony Addon - 0.1.2](https://img.shields.io/badge/Harmony_Addon-0.1.2-8bcbb8)](https://github.com/ynput/OpenPype/tree/develop/openpype/hosts/harmony)", "Hiero_Badge" : "[![Hiero Addon - 0.1.0](https://img.shields.io/badge/Hiero_Addon-0.1.0-fab41a)](https://github.com/ynput/OpenPype/tree/develop/openpype/hosts/hiero)", - "Houdini_Badge" : "[![Houdini addon - 0.2.6](https://img.shields.io/badge/Houdini_Addon-0.2.6-FF4713?logo=houdini)](https://github.com/ynput/OpenPype/tree/develop/openpype/hosts/houdini)", + "Houdini_Badge" : "[![Houdini addon - 0.2.12](https://img.shields.io/badge/Houdini_Addon-0.2.12-FF4713?logo=houdini)](https://github.com/ynput/ayon-core/tree/develop/client/ayon_core/hosts/houdini)", "Kitsu_Badge" : "[![Kitsu Addon - 0.1.3](https://img.shields.io/badge/Kitsu_Addon-0.1.3-e56b27)](https://github.com/ynput/ayon-kitsu)", "Max_Badge" : "[![3Ds Max Addon - 0.1.2](https://img.shields.io/badge/3Ds_Max_Addon-0.1.2-3190b2)](https://github.com/ynput/OpenPype/tree/develop/openpype/hosts/max)", "Maya_Badge" : "[![Maya addon - 0.1.6](https://img.shields.io/badge/Maya_Addon-0.1.6-3190b2)](https://github.com/ynput/OpenPype/tree/develop/openpype/hosts/maya)", @@ -24,7 +24,7 @@ "Photoshop_Badge" : "[![Photoshop Addon - 0.1.0](https://img.shields.io/badge/Photoshop_Addon-0.1.0-041d36?logo=adobephotoshop)](https://github.com/ynput/OpenPype/tree/develop/server_addon/photoshop)", "Resolve_Badge" : "[![Davinci Resolve Addon - 0.1.0](https://img.shields.io/badge/Davinci_Resolve_Addon-0.1.0-2f4a67)](https://github.com/ynput/OpenPype/tree/develop/openpype/hosts/resolve)", "RoyalRender_Badge" : "[![Royal Render Addon - 0.1.1](https://img.shields.io/badge/Royal_Render_Addon-0.1.1-black)](https://github.com/ynput/OpenPype/tree/develop/openpype/modules/royalrender)", - "ShotGrid_Badge" : "[![ShotGrid Addon - 0.2.9](https://img.shields.io/badge/ShotGrid_Addon-0.2.9-3190b2)](https://github.com/ynput/ayon-shotgrid)", + "Flow_Badge" : "[![Flow (ShotGrid) Addon - 0.4.0](https://img.shields.io/badge/Flow_(ShotGrid)_Addon-0.4.0-3190b2)](https://github.com/ynput/ayon-shotgrid)", "SitSync_Badge" : "![SiteSync Addon - 1.0.1](https://img.shields.io/badge/SiteSync_Addon-1.0.1-00d6a1)", "Slack_Badge" : "[![Slack Addon - 1.0.1](https://img.shields.io/badge/Slack_Addon-1.0.1-4A154B?logo=slack&logoColor=a9e3cc)](https://github.com/ynput/ayon-slack)", "SubstancePainter_Badge" : "[![Substance Painter Addon - 0.1.0](https://img.shields.io/badge/Substance_Painter_Addon-0.1.0-e1212e)](https://github.com/ynput/OpenPype/tree/develop/openpype/hosts/substancepainter)", diff --git a/website/docs/assets/shotgrid/ay_anatomy_preset_set.png b/website/docs/assets/shotgrid/ay_anatomy_preset_set.png new file mode 100644 index 00000000..e0f9301c Binary files /dev/null and b/website/docs/assets/shotgrid/ay_anatomy_preset_set.png differ diff --git a/website/docs/assets/shotgrid/ay_anatomy_roots.png b/website/docs/assets/shotgrid/ay_anatomy_roots.png new file mode 100644 index 00000000..7c259dc9 Binary files /dev/null and b/website/docs/assets/shotgrid/ay_anatomy_roots.png differ diff --git a/website/docs/assets/shotgrid/ay_attribute_mapping.png b/website/docs/assets/shotgrid/ay_attribute_mapping.png new file mode 100644 index 00000000..9896756e Binary files /dev/null and b/website/docs/assets/shotgrid/ay_attribute_mapping.png differ diff --git a/website/docs/assets/shotgrid/ay_local_storage.png b/website/docs/assets/shotgrid/ay_local_storage.png new file mode 100644 index 00000000..4fc50598 Binary files /dev/null and b/website/docs/assets/shotgrid/ay_local_storage.png differ diff --git a/website/docs/assets/shotgrid/ay_server_scripts_items.png b/website/docs/assets/shotgrid/ay_server_scripts_items.png new file mode 100644 index 00000000..b81fdf57 Binary files /dev/null and b/website/docs/assets/shotgrid/ay_server_scripts_items.png differ diff --git a/website/docs/assets/shotgrid/ay_user_login_env.png b/website/docs/assets/shotgrid/ay_user_login_env.png new file mode 100644 index 00000000..a9b4498c Binary files /dev/null and b/website/docs/assets/shotgrid/ay_user_login_env.png differ diff --git a/website/docs/assets/shotgrid/ay_user_login_pass.png b/website/docs/assets/shotgrid/ay_user_login_pass.png new file mode 100644 index 00000000..dc163f63 Binary files /dev/null and b/website/docs/assets/shotgrid/ay_user_login_pass.png differ diff --git a/website/docs/assets/shotgrid/ay_user_login_shared.png b/website/docs/assets/shotgrid/ay_user_login_shared.png new file mode 100644 index 00000000..b77c4d65 Binary files /dev/null and b/website/docs/assets/shotgrid/ay_user_login_shared.png differ diff --git a/website/docs/assets/shotgrid/review_tag.png b/website/docs/assets/shotgrid/review_tag.png new file mode 100644 index 00000000..9e8199af Binary files /dev/null and b/website/docs/assets/shotgrid/review_tag.png differ diff --git a/website/docs/assets/shotgrid/sg_anatomy_preset.png b/website/docs/assets/shotgrid/sg_anatomy_preset.png new file mode 100644 index 00000000..383d0c15 Binary files /dev/null and b/website/docs/assets/shotgrid/sg_anatomy_preset.png differ diff --git a/website/docs/assets/shotgrid/sg_local_storage.png b/website/docs/assets/shotgrid/sg_local_storage.png new file mode 100644 index 00000000..21b94990 Binary files /dev/null and b/website/docs/assets/shotgrid/sg_local_storage.png differ diff --git a/website/docs/assets/shotgrid/sg_server_scripts.png b/website/docs/assets/shotgrid/sg_server_scripts.png new file mode 100644 index 00000000..ee864477 Binary files /dev/null and b/website/docs/assets/shotgrid/sg_server_scripts.png differ diff --git a/website/docs/assets/shotgrid/sg_server_scripts_items.png b/website/docs/assets/shotgrid/sg_server_scripts_items.png new file mode 100644 index 00000000..2c6c5322 Binary files /dev/null and b/website/docs/assets/shotgrid/sg_server_scripts_items.png differ diff --git a/website/docs/assets/shotgrid/sg_tracking_settings.png b/website/docs/assets/shotgrid/sg_tracking_settings.png new file mode 100644 index 00000000..87a9042c Binary files /dev/null and b/website/docs/assets/shotgrid/sg_tracking_settings.png differ diff --git a/website/sidebars.js b/website/sidebars.js index a60c70a8..ef98d239 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -135,6 +135,7 @@ module.exports = { "addon_traypublisher_admin", "addon_wrap_admin", "addon_syncsketch_admin", + "addon_flow_admin", ], }, "admin_releases", diff --git a/website/src/data/addons/data/img/flow-icon.png b/website/src/data/addons/data/img/flow-icon.png new file mode 100644 index 00000000..170f8d4c Binary files /dev/null and b/website/src/data/addons/data/img/flow-icon.png differ diff --git a/website/src/data/addons/data/shotgrid.ts b/website/src/data/addons/data/shotgrid.ts index d40fa70d..0a2dcf1d 100644 --- a/website/src/data/addons/data/shotgrid.ts +++ b/website/src/data/addons/data/shotgrid.ts @@ -2,12 +2,15 @@ import { type Addon } from "../types"; import versions from "@site/docs/assets/json/Ayon_addons_version.json"; const addon: Addon = { - title: "Shotgrid", + title: "Flow (Shotgrid)", description: - "ShotGrid is a cloud-based project management software that helps creative studios track and manage their projects, assets, and workflows.", - icon: "shotgrid-icon.png", + "Flow (ShotGrid) is a cloud-based project management software that helps creative studios track and manage their projects, assets, and workflows.", + icon: "flow-icon.png", features: ["sgSync"], - badge: versions.ShotGrid_Badge, + badge: versions.Flow_Badge, + docs: { + admin: "addon_flow_admin", + }, github: "https://github.com/ynput/ayon-shotgrid", discussion: "https://community.ynput.io/t/shotgrid-integration-addon/63", }; diff --git a/website/src/data/features/data.ts b/website/src/data/features/data.ts index 474e51bb..01eebf8f 100644 --- a/website/src/data/features/data.ts +++ b/website/src/data/features/data.ts @@ -60,9 +60,9 @@ const features: { [type in FeatureType]: Feature } = { "Tools for creating shots, assets and task within your project if you don't use third party project management", }, sgSync: { - title: "Shotgrid Sync", + title: "Flow (Shotgrid) Sync", description: - "A way to syncronize projects across AYON and Shotgrid, as well as react to events in either platform.", + "A way to synchronize projects across AYON and Flow (Shotgrid), as well as react to events in either platform.", preview: "shotgrid_sync.png", }, libraryLoader: { diff --git a/website/src/data/features/img/shotgrid_sync.png b/website/src/data/features/img/shotgrid_sync.png index e273ab36..948a5e8b 100644 Binary files a/website/src/data/features/img/shotgrid_sync.png and b/website/src/data/features/img/shotgrid_sync.png differ diff --git a/website/src/data/features/types.ts b/website/src/data/features/types.ts index de5f0529..9eeace9f 100644 --- a/website/src/data/features/types.ts +++ b/website/src/data/features/types.ts @@ -31,4 +31,5 @@ export type FeatureType = | "nodePresets" | "burnins" | "bakingColorspacePresets" - | "scriptBuilding"; + | "scriptBuilding" + | "sgSync";