From de2423b8304d19350104d69fb61542147c254b25 Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Thu, 13 Apr 2023 01:00:08 +0200 Subject: [PATCH 1/4] Add extra terminology to the key concepts glossary --- website/docs/artist_concepts.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/website/docs/artist_concepts.md b/website/docs/artist_concepts.md index 7582540811..13c0691218 100644 --- a/website/docs/artist_concepts.md +++ b/website/docs/artist_concepts.md @@ -14,13 +14,25 @@ OpenPype has a limitation regarding duplicated names. Name of assets must be uni ### Subset -Usually, an asset needs to be created in multiple *'flavours'*. A character might have multiple different looks, model needs to be published in different resolutions, a standard animation rig might not be usable in a crowd system and so on. 'Subsets' are here to accommodate all this variety that might be needed within a single asset. A model might have subset: *'main'*, *'proxy'*, *'sculpt'*, while data of *'look'* family could have subsets *'main'*, *'dirty'*, *'damaged'*. Subsets have some recommendations for their names, but ultimately it's up to the artist to use them for separation of publishes when needed. +A published output from an asset results in a subset + +The subset type is referred to as [family](#family), for example a rig, pointcache, look. +A single asset can have many subsets, even of a single family, named [variants](#variant). +By default a subset is named as a combination of family + variant, sometimes prefixed with the task name (like workfile) + +### Variant + +Usually, an asset needs to be created in multiple *'flavours'*. A character might have multiple different looks, model needs to be published in different resolutions, a standard animation rig might not be usable in a crowd system and so on. 'Variants' are here to accommodate all this variety that might be needed within a single asset. A model might have variant: *'main'*, *'proxy'*, *'sculpt'*, while data of *'look'* family could have subsets *'main'*, *'dirty'*, *'damaged'*. Variants have some recommendations for their names, but ultimately it's up to the artist to use them for separation of publishes when needed. ### Version -A numbered iteration of a given subset. Each version contains at least one [representation][daa74ebf]. +A numbered iteration of a given subset. Each version contains at least one [representation][#representation]. - [daa74ebf]: #representation "representation" +#### Hero version + +A hero version is a version that is always the latest published version. When a new publish is generated its written over the previous hero version replacing it in-place as opposed to regular versions where each new publish is a higher version number. + +This is an optional feature. The generation of hero versions can be completely disabled in OpenPype by an admin through the Studio Settings. ### Representation @@ -33,18 +45,22 @@ At this moment names of assets, tasks, subsets or representations can contain on ### Family -Each published [subset][3b89d8e0] can have exactly one family assigned to it. Family determines the type of data that the subset holds. Family doesn't dictate the file type, but can enforce certain technical specifications. For example OpenPype default configuration expects `model` family to only contain geometry without any shaders or joints when it is published. +Each published [subset][#subset] can have exactly one family assigned to it. Family determines the type of data that the subset holds. Family doesn't dictate the file type, but can enforce certain technical specifications. For example OpenPype default configuration expects `model` family to only contain geometry without any shaders or joints when it is published. +### Task - [3b89d8e0]: #subset "subset" +A task defines a work area for an asset an artist can work in. For example asset *hero* can have tasks *modeling* and *rigging*. Tasks also have types. Multiple tasks of the same type may exist in an asset. A task with type FX could for example appear twice as *fx_fire* and *fx_cloth*. +Without a task you cannot launch a host application. +### Workfile + +The source scene file an artist works in within their task. These are versioned scene files and can be loaded and saved (automatically named) through the [workfiles tool](artist_tools_workfiles.md). ### Host General term for Software or Application supported by OpenPype and Avalon. These are usually DCC applications like Maya, Houdini or Nuke, but can also be a web based service like Ftrack or Clockify. - ### Tool Small piece of software usually dedicated to a particular purpose. Most of OpenPype and Avalon tools have GUI, but some are command line only. @@ -54,6 +70,10 @@ Small piece of software usually dedicated to a particular purpose. Most of OpenP Process of exporting data from your work scene to versioned, immutable file that can be used by other artists in the studio. +#### (Publish) Instance + +A publish instance is a single entry which defines a publish output. Publish instances persist with the workfile. This way we can expect that a publish from a newer workfile will produce similar consistent versioned outputs. + ### Load Process of importing previously published subsets into your current scene, using any of the OpenPype tools. From 30d12155938caadac47fec4b9ea2a572883c4782 Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Thu, 13 Apr 2023 09:07:29 +0200 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Toke Jepsen --- website/docs/artist_concepts.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/docs/artist_concepts.md b/website/docs/artist_concepts.md index 13c0691218..52a6d0d233 100644 --- a/website/docs/artist_concepts.md +++ b/website/docs/artist_concepts.md @@ -14,11 +14,11 @@ OpenPype has a limitation regarding duplicated names. Name of assets must be uni ### Subset -A published output from an asset results in a subset +A published output from an asset results in a subset. The subset type is referred to as [family](#family), for example a rig, pointcache, look. A single asset can have many subsets, even of a single family, named [variants](#variant). -By default a subset is named as a combination of family + variant, sometimes prefixed with the task name (like workfile) +By default a subset is named as a combination of family + variant, sometimes prefixed with the task name (like workfile). ### Variant @@ -49,7 +49,7 @@ Each published [subset][#subset] can have exactly one family assigned to it. Fam ### Task -A task defines a work area for an asset an artist can work in. For example asset *hero* can have tasks *modeling* and *rigging*. Tasks also have types. Multiple tasks of the same type may exist in an asset. A task with type FX could for example appear twice as *fx_fire* and *fx_cloth*. +A task defines a work area for an asset where an artist can work in. For example asset *characterA* can have tasks named *modeling* and *rigging*. Tasks also have types. Multiple tasks of the same type may exist on an asset. A task with type `fx` could for example appear twice as *fx_fire* and *fx_cloth*. Without a task you cannot launch a host application. @@ -72,7 +72,7 @@ Process of exporting data from your work scene to versioned, immutable file that #### (Publish) Instance -A publish instance is a single entry which defines a publish output. Publish instances persist with the workfile. This way we can expect that a publish from a newer workfile will produce similar consistent versioned outputs. +A publish instance is a single entry which defines a publish output. Publish instances persist within the workfile. This way we can expect that a publish from a newer workfile will produce similar consistent versioned outputs. ### Load From a016f34c54cb9607c5cea52754d65b3d9630a0f2 Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Thu, 13 Apr 2023 09:11:27 +0200 Subject: [PATCH 3/4] Fix links --- website/docs/artist_concepts.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/artist_concepts.md b/website/docs/artist_concepts.md index 52a6d0d233..c968d34a6d 100644 --- a/website/docs/artist_concepts.md +++ b/website/docs/artist_concepts.md @@ -26,7 +26,7 @@ Usually, an asset needs to be created in multiple *'flavours'*. A character migh ### Version -A numbered iteration of a given subset. Each version contains at least one [representation][#representation]. +A numbered iteration of a given subset. Each version contains at least one [representation](#representation). #### Hero version @@ -45,7 +45,7 @@ At this moment names of assets, tasks, subsets or representations can contain on ### Family -Each published [subset][#subset] can have exactly one family assigned to it. Family determines the type of data that the subset holds. Family doesn't dictate the file type, but can enforce certain technical specifications. For example OpenPype default configuration expects `model` family to only contain geometry without any shaders or joints when it is published. +Each published [subset](#subset) can have exactly one family assigned to it. Family determines the type of data that the subset holds. Family doesn't dictate the file type, but can enforce certain technical specifications. For example OpenPype default configuration expects `model` family to only contain geometry without any shaders or joints when it is published. ### Task From 818382afed10c766952aa83e0dbdf32895d4dbf2 Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Thu, 13 Apr 2023 09:12:28 +0200 Subject: [PATCH 4/4] Avoid confusion with variant --- website/docs/artist_concepts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/artist_concepts.md b/website/docs/artist_concepts.md index c968d34a6d..1e55c8139d 100644 --- a/website/docs/artist_concepts.md +++ b/website/docs/artist_concepts.md @@ -36,7 +36,7 @@ This is an optional feature. The generation of hero versions can be completely d ### Representation -Each published variant can come out of the software in multiple representations. All of them hold exactly the same data, but in different formats. A model, for example, might be saved as `.OBJ`, Alembic, Maya geometry or as all of them, to be ready for pickup in any other applications supporting these formats. +Each published subset version can come out of the software in multiple representations. All of them hold exactly the same data, but in different formats. A model, for example, might be saved as `.OBJ`, Alembic, Maya geometry or as all of them, to be ready for pickup in any other applications supporting these formats. #### Naming convention