ynput / ynput/ayon-documentation

List the conditions to get the new behaviour after a change in settings

Open
#85 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

community Server
Dominant language
TypeScript
Stars
12
Forks
13
PR merge metrics
No merged PRs in 30d

Description

When we change something in Ayon's Settings (Studio Settings, Anatomy, Attributes, etc...), it is difficult to predict if it will immediately affect existing entities (projects, folders, tasks), or if we need to update existing entities, or we need to create new entities.
And for entities that do not already show the new settings, there is no common rule on how to apply them : create a new entity, restart the launcher, restart the DCC, restart the server, etc...

For example here : Web App-->...-->Projects Settings-->[select a project]-->Anatomy
If you tweak Attributes and Roots, you will immediately get the new Roots behaviour on existing Folder/Asset/Task.
But to get the new Attributes, you need to create a new Folder/Asset/Task. Except if Inherit is off.

This is just one example, but there are many others, and currently we use "trial and error" to discover what happens.
So, it would be useful to have a list of all these rules.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the Web App path Web App → … → Projects Settings → select a project → Anatomy, using the Attributes and Roots example in the issue. Inventory the settings categories mentioned and document whether changes affect existing entities, require updates or new entities, or require restarting the launcher, DCC, or server. Done means the rules are collected in one clear list.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.