219 bundle documentation #298
Conversation
| ## About Bundles & Addons | ||
| ### Bundles vs Addon | ||
| A bundle is a set of addons. | ||
| addon is a set of code and settings used to extend AYON server and pipeline. |
There was a problem hiding this comment.
| addon is a set of code and settings used to extend AYON server and pipeline. | |
| An addon is a set of code and settings used to extend AYON server and pipeline. |
|
|
||
| :::note Launch with different variants | ||
| You can use different variants with the launcher. | ||
| you can specify with variant to use by using the following flags with ayon launcher |
There was a problem hiding this comment.
| you can specify with variant to use by using the following flags with ayon launcher | |
| You can specify which variant to use by using the following flags with ayon launcher: |
| You can overriding the default behavior and specifying the bundle on launch. | ||
| more info check [How to use different bundles with different projects?](https://community.ynput.io/t/how-to-use-different-bundles-with-different-projects/1096) |
There was a problem hiding this comment.
| You can overriding the default behavior and specifying the bundle on launch. | |
| more info check [How to use different bundles with different projects?](https://community.ynput.io/t/how-to-use-different-bundles-with-different-projects/1096) | |
| You can override the default behavior and explicitly specify a bundle on launch, see: | |
| [How to use different bundles with different projects?](https://community.ynput.io/t/how-to-use-different-bundles-with-different-projects/1096) |
| :::note | ||
| Dev variant is the same as dev bundle name `<dev-bundle-name>` | ||
| Dev bundle are only accessible for the **assigned admin user**. |
There was a problem hiding this comment.
| :::note | |
| Dev variant is the same as dev bundle name `<dev-bundle-name>` | |
| Dev bundle are only accessible for the **assigned admin user**. | |
| :::note Dev variants | |
| For a dev bundle the its dev variant has the sae name `<dev-bundle-name>`. | |
| Dev bundles are only accessible for the **assigned admin user**. | |
| Dev bundles will only be displayed if the user has **Developer Mode** enabled on the AYON web frontend. |
| This variant is used across the addons. | ||
| Each addon is saved on the server with different variant of settings. | ||
| The variant used in addons is exposed on the bundle. | ||
| The variant value on the bundle is like a main switch that set all the addons to use that variant value. |
There was a problem hiding this comment.
I couldn't make any sense of this myself. 🗡️
Which variant? How is it used? Etc. It tells me too little about settings and more about variants and bundles.
Maybe the "title" of the section is what confuses me "How settings work" - but it doesn't seem to be about that at all?
I feel like this community forum topic has some great wording explaining how settings actually work and behave: https://community.ynput.io/t/copying-settings-between-bundles/1867
| - `Uninstall Versions` button. | ||
|
|
||
| :::caution | ||
| WIth local server deployment, |
There was a problem hiding this comment.
| WIth local server deployment, | |
| With local server deployment, |
| :::caution | ||
| WIth local server deployment, | ||
| You can add or remove addons by extracting and deleting files from your addons directory on your ayon-docker server. | ||
| ::: |
There was a problem hiding this comment.
I'm worried this may have unforeseen consequences and isn't something we should recommend in any way.
This should really be a last resort.
@martastain thoughts?
If we want to keep this I'd rephrase it:
Technically it is possible to add or remove addons to the server by extracting to or deleting files from your addons directory on the
ayon-dockerserver directly. However, we recommend using the AYON frontend or API to manage the addons to ensure the correct behavior. Managing the files on the server directly should be a last resort.
| ::: | ||
|
|
||
| :::info | ||
| Developers can upload/remove addons via ayon python api. |
There was a problem hiding this comment.
This would be best with an example, or a link to documentation that shows that particular part of that API.
| *Addon settings are accessed via Bundles.* | ||
|
|
||
| - Studio Settings: Addon settings on studio level. | ||
| - Project Settings: Addon settings on project level. They inherit studio settings and allowing overrides per project. |
There was a problem hiding this comment.
| - Project Settings: Addon settings on project level. They inherit studio settings and allowing overrides per project. | |
| - Project Settings: Addon settings on project level. They inherit studio settings and allow pinned overrides per project. A pinned override does not inherit from studio settings anymore and is explicitly set on the project settings. |
| - Studio Site Settings: Addon local settings on studio level. They don't inherit (nor override) any other settings. | ||
| - Project Site Settings: Addon local settings on project level. They don't inherit (nor override) any other settings. |
There was a problem hiding this comment.
Should this state that it's per site id? Or what is "local" in this case?
Changelog Description
resolve #219
resolve #226
Note
Currently, I've added the first drafts, they are more of bullet points, I still need to polish them and some screenshots.
At this stage of this PR, it'd be great to get your input on the structure of the added docs.
Additional Info
Some related discussions in forums that add food for thought.
Testing notes: