From 89c2979d0c0f06a6f3f58cdc635f190c2fb657f6 Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Fri, 17 May 2024 11:52:10 +0200 Subject: [PATCH 1/3] Fix documentation for sitesync background service --- website/docs/addon_site_sync_admin.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/website/docs/addon_site_sync_admin.md b/website/docs/addon_site_sync_admin.md index 9236cf1b..918c61ca 100644 --- a/website/docs/addon_site_sync_admin.md +++ b/website/docs/addon_site_sync_admin.md @@ -200,20 +200,20 @@ As current implementation relies heavily on Settings and Site Settings, backgrou To do this: -- run OP `Tray` with environment variable AYON_LOCAL_ID set to name of active (source) site. In most use cases it would be studio (for cases of backups of everything published to studio site to different cloud site etc.) +- run AYON `Tray` with environment variable AYON_LOCAL_ID set to name of active (source) site. In most use cases it would be studio (for cases of backups of everything published to studio site to different cloud site etc.) - start `Tray` - check `Local ID` in information dialog after clicking on version number in the Tray -- open `Site Settings` in the `Ayon Server` +- open `Site Settings` in the `Ayon Server` (`ayon+settings://sitesync?project=ayon_test&site=studio`) - configure for each project necessary active site and remote site - close `Tray` -- run Ayon launcher from a command line with `syncserver` and `--active_site` arguments +- run Ayon launcher from a command line with `syncservice` and `--active_site` arguments This is an example how to trigger background syncing process where active (source) site is `studio`. -(It is expected that OP is installed on a machine, `ayon_console` is on PATH. If not, add full path to executable. -) +(It is expected that AYON is installed on a machine, `ayon_console` is on PATH. If not, add full path to executable. +[)](ayon+settings://sitesync?project=ayon_test&site=studio1) ```shell -ayon_console syncserver --active_site studio +ayon_console addon sitesync syncservice --active_site studio ``` From a69cc768f62815c5b25342a7ab22c7a321a11044 Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Fri, 17 May 2024 11:54:25 +0200 Subject: [PATCH 2/3] Small modifications --- website/docs/addon_site_sync_admin.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/addon_site_sync_admin.md b/website/docs/addon_site_sync_admin.md index 918c61ca..f1e1b934 100644 --- a/website/docs/addon_site_sync_admin.md +++ b/website/docs/addon_site_sync_admin.md @@ -25,7 +25,7 @@ At the moment site sync is only able to deal with published files (eg. in `publi ## Studio Settings -First of all, you need to include Site Sync Addon to your bundle, and to use synchronization, *Site Sync* needs to be enabled globally in **ayon+settings://sitesync**. +First of all, you need to include `Site Sync Addon` to your bundle, and to use synchronization, *Site Sync* needs to be enabled globally in **ayon+settings://sitesync**. ![Configure module](assets/site_sync_system.png) @@ -206,7 +206,7 @@ To do this: - open `Site Settings` in the `Ayon Server` (`ayon+settings://sitesync?project=ayon_test&site=studio`) - configure for each project necessary active site and remote site - close `Tray` -- run Ayon launcher from a command line with `syncservice` and `--active_site` arguments +- run AYON launcher from a command line with `syncservice` and `--active_site` arguments This is an example how to trigger background syncing process where active (source) site is `studio`. From f5f1289c0fd098d073afea2c2a7236028e2a8f4f Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Wed, 22 May 2024 15:52:47 +0200 Subject: [PATCH 3/3] Remove unnecessary link Co-authored-by: Mustafa Taher --- website/docs/addon_site_sync_admin.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/addon_site_sync_admin.md b/website/docs/addon_site_sync_admin.md index f1e1b934..9d6c7984 100644 --- a/website/docs/addon_site_sync_admin.md +++ b/website/docs/addon_site_sync_admin.md @@ -211,7 +211,7 @@ To do this: This is an example how to trigger background syncing process where active (source) site is `studio`. (It is expected that AYON is installed on a machine, `ayon_console` is on PATH. If not, add full path to executable. -[)](ayon+settings://sitesync?project=ayon_test&site=studio1) +) ```shell ayon_console addon sitesync syncservice --active_site studio ```