diff --git a/website/docs/admin_server_bundles_and_addons.md b/website/docs/admin_server_bundles_and_addons.md new file mode 100644 index 00000000..bf04fabb --- /dev/null +++ b/website/docs/admin_server_bundles_and_addons.md @@ -0,0 +1,89 @@ +--- +id: admin_server_bundles_and_addons +title: Bundles & Addons +sidebar_label: Bundles & Addons +description: Bundles & Addons Documentation. +toc_max_heading_level: 5 +--- + +## 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. + +Bundles can be marked as `production`, `staging`, `` variant. + +:::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 +- `--use-staging` +- `--use-dev` + +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) +::: + +:::note +Dev variant is the same as dev bundle name `` +Dev bundle are only accessible for the **assigned admin user**. +::: + +### How Settings work + +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. + +:::tip Settings management +For more info about setting management go to [Addon Settings](admin_server_settings_management.md#addon-settings) +::: + +### Working with bundles +#### Create bundles +You can create a bundle by either one of these ways: +- `+ Add Bundle` +- Right-Click any bundle and Select `Duplicate and Edit` shortcut `Shift+D` +- Select any bundle and click `Duplicate and Edit` button on the upper right. + +#### Configure bundles + +Bundles are configured on creation where you specify +- Bundle name +- Launcher version +- Dev bundle toggle +- Addon versions + +After Creation these are locked and you can then only change +- Dependency Packages. +- Change version of some server addons (that don't affect the pipeline). e.g. Jira Addon. + +:::note +Dev bundle supports more configurations: +- Assigned dev +- Addon versions +- Addon client code directory. This special one allows developers to test the client code directory without uploading the addon. + However, they'll still need to upload the addons to update the settings on the server. +::: + +### Working with Addons +#### Install Addons + +- `Addon Market` +- `Upload Addons` + +:::tip +When updating pipeline release, new addons will be installed. +::: + +#### Uninstall Addons +- `Uninstall Versions` button. + +:::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. +::: + +:::info +Developers can upload/remove addons via ayon python api. +::: \ No newline at end of file diff --git a/website/docs/admin_server_settings_management.md b/website/docs/admin_server_settings_management.md new file mode 100644 index 00000000..997a4d6b --- /dev/null +++ b/website/docs/admin_server_settings_management.md @@ -0,0 +1,29 @@ +--- +id: admin_server_settings_management +title: Settings Management +sidebar_label: Settings Management +description: Settings Management Documentation. +toc_max_heading_level: 5 +--- + + +## Team Settings + +- Add Teams +- Add team members +- Roles + +## Project Anatomy Settings + +- Anatomy Presets +- Anatomy Settings +- Roots Override + +## Addon Settings + +*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. +- 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. diff --git a/website/sidebars.js b/website/sidebars.js index 9fbe9a2e..0a2be699 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -152,6 +152,9 @@ module.exports = { "admin_server_email", ], }, + "admin_settings_project_anatomy", + "admin_server_bundles_and_addons", + "admin_server_settings_management", "admin_server_updating_pipeline", ], }, @@ -167,7 +170,6 @@ module.exports = { "admin_environment", "admin_settings", "admin_colorspace", - "admin_settings_project_anatomy", "addon_core_settings", "addon_applications_admin", ],