Copy Settings Documentation

[BigRoy]

Is there an existing issue for this?

• I have searched the existing issues.

Please describe the feature you have in mind and explain what the current shortcomings are?

There are a lot of different Settings in AYON.

• Anatomy
• Studio Settings
• Project Settings

And there are a lot of ways to "copy paste" these types of settings, and potentially more coming with ynput/ayon-frontend#752 and reported here we may need to document the different types of "Settings Management" and how to copy e.g. specific settings that you'd want from one place to another.

But a user may also face issues with Copy and Paste in the settings pages as this issue describes: ynput/ayon-frontend#762
So we may want to also highlight that and maybe have some graphics displaying how to enable that using tip section in the documentation.

How would you imagine the implementation of the feature?

We may need some very clear wording in the documentation that we have a few levels of granularity to copying settings:

1. Copy settings from... on bundles page copies all studio settings and project overrides for that bundle* (not released yet)
2. Copy settings from... on studio settings page copies only the studio settings between the bundles
3. Copy settings from... on studio settings page on a particular addon copies between studio settings for only a specific addon version.
4. Copy settings from... on project settings page copies only the project settings for the selected project between the bundles.
5. Copy settings from... on project settings page on a particular addon copies project overrides for only selected project for only specific addon version.

The "Copy Settings" toggle on creating a new bundle is basically that top one (number 1) described above - it will copy all studio settings and project setting overrides between the bundles.

That's a lot of different dialogs we have. And someone may be as stupid as me and definitely at one point will by accident be using the wrong page, using the wrong dialog unintentionally.

Also #219 will be crucial because to understand settings we'd also need to document that

• Addons have settings PER variant PER addon version.

Because that is the hardest concept to grasp that you're copying to variant for each addon version... and not to the bundle.

Are there any labels you wish to add?

• I have added the relevant labels to the enhancement request.

Describe alternatives you've considered:

Better settings UIs and dialogs will definitely help already.

Additional context:

The current settings documentation is old anyway, with screenshots that come mostly from OpenPype's Qt dialogs still: https://ayon.ynput.io/docs/admin_settings

So some love for this page is more than welcome!

Issues with Copy & Paste also came up on the forum