Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust Resolve documentation (user+admin) for recent publisher work. #289

Merged
merged 6 commits into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions website/docs/addon_resolve_admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ import TabItem from '@theme/TabItem';
## Resolve requirements
Resolve uses a separate Python interpreter (it does not come with Python itself). The interpreter needs to have installed PySide2 (or PySide6 if on MacOS) and OpenTimelineIO dependencies for Ayon to work correctly. Bellow you can find instructions on how to install them into an installed Python of your choice.

- Resolve 19 - our recommended version range `Python 3.9.x` (in complience with Ayon), also been tested with `Python 3.10.x`
- Resolve 18 - our recommended version range `Python 3.9.x` (in complience with Ayon)
- Resolve 17 - our recommended version `Python 3.6.2`
- Resolve 18 - our recommended version range `Python 3.10.x` (in complience with Ayon)

:::warning
Resolve Studio is the only version that works with the Ayon toolkit because of external scripting requirements which the free edition of Resolve is lacking.
Expand Down Expand Up @@ -78,11 +79,16 @@ python3 -m pip install PySide6

### OpenTimelineIO

:::warning Permissions
Installation guide for OpenTimelineIO in Python 3.6 can be found [here](https://github.com/ynput/OpenPype/blob/develop/openpype/hosts/resolve/README.markdown#basic-setup).
:::

AYON is using OpenTimelineIO for editorial publishing. OpenTimelineIO has to be installed into the python.
AYON is using OpenTimelineIO for editorial publishing. OpenTimelineIO has to be installed into the Resolve Python environment.
Tested versions:
- Resolve 19 - `OpenColorIO 0.17.0` with `Python 3.9.x` or `Python 3.10.x`
- Resolve 18 - `OpenColorIO 0.17.0` with `Python 3.9.x`
- Resolve 17 - `OpenColorIO 0.13.0` with `Python 3.6.2` (see special build instruction below)

:::tip OpenColorIO 0.13.0
Installation guide for OpenTimelineIO 0.13.0 in Python 3.6 can be found [here](https://github.com/ynput/ayon-resolve/blob/develop/client/ayon_resolve/README.markdown).
:::

<Tabs
groupId="platforms"
Expand Down
17 changes: 10 additions & 7 deletions website/docs/addon_resolve_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,9 @@ After all clips which are intended to be converted to publishable instances are

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**.
Hit `Create ...` and then select the product type to **Create Publishable Clip**.

You can leave `Use only clips with Chocolate clip colors` enabled to publish only the selection.

The Product name can stay as it is, it is not going to be used because each clip will generate it's own name.

Expand All @@ -129,7 +131,7 @@ The Product name can stay as it is, it is not going to be used because each clip
<div class="row markdown">
<div class="col col--6 markdown">

The new windows that opens, let's you define various attributes for your future products and shots.
The "Create options" section let you define various attributes for your future products 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.

Expand Down Expand Up @@ -233,13 +235,14 @@ There are two ways to create a publishable editorial package: by creating a new

### Create/Convert a Timeline from Media Pool into an Editorial Package

To create an editorial package, select a timeline in the media pool (1) and use the Create tool (2) to mark the timeline with Editorial Package (3) publishable product data. Keep _`Use selection`_ (5) active and choose _`Editorial Package`_ (3) as the product type. You can also use a Variant (4) to differentiate between different versions of timelines within the same target context. Hit Create (6).
To create an editorial package, select a timeline in the media pool (1) and use the AYON Create tool (2).
Then set the target folder (3) context and task (4).

![Create Editorial pkg01](assets/resolve/user_editorial_pkg_create01.png)
Choose _`Editorial Package`_ (5) as the product type. You can also use a Variant (6) to differentiate between different versions of timelines within the same target context. Hit Create (7).

In the next step, define the target folder (1) context and task (2) for the product to be published into and hit **OK** (3). Now, your timeline is ready to be published.
Now, your timeline is ready to be published.

![Create Editorial pkg02](assets/resolve/user_editorial_pkg_create02.png)
![Create Editorial pkg01](assets/resolve/user_editorial_pkg_create01.png)

:::warning Metadata storing
AYON is storing metadata for production tracking in the media pool clip's **VFX Notes**. The content of this key should not be changed or removed.
Expand All @@ -254,7 +257,7 @@ Loading a previously published package adds publishable product data to the time

### Publishing Editorial Package

Open the publisher (1) from the AYON menu. Ensure that only the Editorial Package product type (2) is activated (click the square icon (3) next to the name) in the left panel of the publisher window. You can then publish by clicking the _`Play`_ button (4).
Open the publisher (1) from the AYON menu. Ensure that your editorial package instance is enabled in the "Product to publish" section (2). You can then publish by clicking the _`Publish`_ button (3).

![Publishing editorial package 01](assets/resolve/user_editorial_pkg_publishing01.png)

Expand Down
Binary file modified website/docs/assets/resolve/user_editorial_pkg_create01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/assets/resolve/user_editorial_pkg_publishing01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/assets/resolve_create_clips.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/assets/resolve_create_renaming_clips.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/assets/resolve_create_template_filling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/assets/resolve_menu_openpype.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.