219 bundle documentation

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
+---
+
+## Bundles vs Addon
+A bundle is a set of addons.
+An addon is a set of code and settings used to extend AYON server and pipeline.
+
+Bundles can be marked as `production`, `staging`, `<dev-bundle-name>` variant.
+
+:::note Launch with different variants
+You can use different variants with the launcher.
+You can specify which variant to use by using the following flags with AYON launcher:
+- `--use-staging`
+- `--use-dev`
+
+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 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.
+:::
+
+## 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 in multiple 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.
+:::

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 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.

website/sidebars.js

@@ -167,6 +167,8 @@ module.exports = {
                         "admin_server_email",
                     ],
                 },
+                "admin_server_bundles_and_addons",
+                "admin_server_settings_management",
                 "admin_server_market",
                 "admin_server_updating_pipeline",
                 "admin_server_permissions",