From 6a992409f0adac4cf4fe534e5feee5e6f610b363 Mon Sep 17 00:00:00 2001 From: Libor Batek Date: Wed, 25 Jan 2023 09:51:42 +0100 Subject: [PATCH 01/12] Added more elaborate info on installing/running OP and corrected few typos. --- website/docs/artist_getting_started.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index 2f88a9f238..474a39642b 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -18,13 +18,17 @@ If this is not the case, please contact your administrator to consult on how to If you are working from home though, you'll need to install it yourself. You should, however, receive the OpenPype installer files from your studio admin, supervisor or production, because OpenPype versions and executables might not be compatible between studios. -To install OpenPype you just need to unzip it anywhere on the disk +Installing OpenPype is possible by Windows installer or by unzipping it anywhere on the disk from downloaded ZIP archive. -To use it, you have two options +There are two options running OpenPype -**openpype_gui.exe** is the most common for artists. It runs OpenPype GUI in system tray. From there you can run all the available tools. To use any of the features, OpenPype must be running in the tray. +first most common one by using OP icon on the Desktop triggering -**openpype_console.exe** in useful for debugging and error reporting. It opens console window where all the necessary information will appear during user's work. +**openpype_gui.exe** suitable for artists. It runs OpenPype GUI in the OS tray. From there you can run all the available tools. To use any of the features, OpenPype must be running in the tray. + +or alternatively by using + +**openpype_console.exe** located in the OpenPype folder which is suitable for TDs/admins for debugging and error reporting. It opens console window where all the necessary information will appear during user's work. Date: Wed, 25 Jan 2023 14:17:20 +0100 Subject: [PATCH 02/12] additional changes incorporated --- website/docs/artist_getting_started.md | 54 +++++++++----------------- 1 file changed, 19 insertions(+), 35 deletions(-) diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index 474a39642b..40961dbc77 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -7,6 +7,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; + ## Working in the studio In studio environment you should have OpenPype already installed and deployed, so you can start using it without much setup. Your admin has probably put OpenPype icon on your desktop or even had your computer set up so OpenPype will start automatically. @@ -15,63 +16,46 @@ If this is not the case, please contact your administrator to consult on how to ## Working from home -If you are working from home though, you'll need to install it yourself. You should, however, receive the OpenPype installer files from your studio +If you are working from **home** though, you'll **need to install** it yourself. You should, however, receive the OpenPype installer files from your studio admin, supervisor or production, because OpenPype versions and executables might not be compatible between studios. Installing OpenPype is possible by Windows installer or by unzipping it anywhere on the disk from downloaded ZIP archive. -There are two options running OpenPype +For more detailed info about installation on different OS please visit [Installation section](artist_install.md). + +There are two ways running OpenPype first most common one by using OP icon on the Desktop triggering -**openpype_gui.exe** suitable for artists. It runs OpenPype GUI in the OS tray. From there you can run all the available tools. To use any of the features, OpenPype must be running in the tray. +**openpype_gui.exe** suitable **for artists**. It runs OpenPype GUI in the OS tray. From there you can run all the available tools. To use any of the features, OpenPype must be running in the tray. or alternatively by using -**openpype_console.exe** located in the OpenPype folder which is suitable for TDs/admins for debugging and error reporting. It opens console window where all the necessary information will appear during user's work. - - - - - - -WIP - Windows instructions once installers are finished - - - - -WIP - Linux instructions once installers are finished - - - - -WIP - Mac instructions once installers are finished - - - +**openpype_console.exe** located in the OpenPype folder which is suitable for **TDs/Admin** for debugging and error reporting. This one runs with opened console window where all the necessary info will appear during user's work session. ## First Launch -When you first start OpenPype, you will be asked to give it some basic information. +When you first start OpenPype, you will be asked to fill in some basic informations. + ### MongoDB In most cases that will only be your studio MongoDB Address. +It's a URL that you should have received from your Studio admin and most often will look like this -It is a URL that you should receive from you studio and most often will look like this `mongodb://username:passwword@mongo.mystudiodomain.com:12345` or `mongodb://192.168.100.15:27071`, it really depends on your studio setup. When OpenPype Igniter +`mongodb://username:passwword@mongo.mystudiodomain.com:12345` + + or + + `mongodb://192.168.100.15:27071` + +it really depends on your studio setup. When OpenPype Igniter asks for it, just put it in the corresponding text field and press `install` button. ### OpenPype Version Repository -Sometimes your studio might also ask you to fill in the path to it's version +Sometimes your Studio might also ask you to fill in the path to it's version repository. This is a location where OpenPype will be looking for when checking if it's up to date and where updates are installed from automatically. @@ -80,7 +64,7 @@ This path is usually taken from the database directly, so you shouldn't need it. ## Updates -If you're connected to your studio, OpenPype will check for, and install updates automatically every time you run it. That's why during the first start, it will go through a quick update installation process, even though you might have just installed it. +If you're connected to your Studio, OpenPype will check for, and install updates automatically every time you run it. That's why during the first start, it will go through a quick update installation process, even though you might have just installed it. ## Advanced Usage From a8fcd42b6afedbcc0bb82869d0c703edf09f30e2 Mon Sep 17 00:00:00 2001 From: Libor Batek Date: Tue, 31 Jan 2023 10:59:47 +0100 Subject: [PATCH 03/12] adjusted according comments --- website/docs/artist_getting_started.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index 40961dbc77..5ab89e31d8 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -19,19 +19,22 @@ If this is not the case, please contact your administrator to consult on how to If you are working from **home** though, you'll **need to install** it yourself. You should, however, receive the OpenPype installer files from your studio admin, supervisor or production, because OpenPype versions and executables might not be compatible between studios. -Installing OpenPype is possible by Windows installer or by unzipping it anywhere on the disk from downloaded ZIP archive. +Installing OpenPype is possible by Installer or by unzipping downloaded ZIP archive to any drive location. -For more detailed info about installation on different OS please visit [Installation section](artist_install.md). +> For more detailed info about installing OpenPype please visit [Installation section](artist_install.md). -There are two ways running OpenPype +--- -first most common one by using OP icon on the Desktop triggering +You can run OpenPype by desktop "OP" icon (if exists after installing) or by directly executing -**openpype_gui.exe** suitable **for artists**. It runs OpenPype GUI in the OS tray. From there you can run all the available tools. To use any of the features, OpenPype must be running in the tray. +**openpype_gui.exe** located in the OpenPype folder. This executable being suitable **for artists**. -or alternatively by using +or alternatively by + +**openpype_console.exe** which is more suitable for **TDs/Admin** for debugging and error reporting. This one runs with opened console window where all the necessary info will appear during user's work session. + +> By seeing the "OP" icon in the OS tray user can easily tell OpenPype already running. -**openpype_console.exe** located in the OpenPype folder which is suitable for **TDs/Admin** for debugging and error reporting. This one runs with opened console window where all the necessary info will appear during user's work session. ## First Launch From 8f83673f7f8dd93c063072437c8c32d8278677df Mon Sep 17 00:00:00 2001 From: Libor Batek <112623825+LiborBatek@users.noreply.github.com> Date: Wed, 1 Feb 2023 10:12:02 +0100 Subject: [PATCH 04/12] Update website/docs/artist_getting_started.md Co-authored-by: Roy Nieterau --- website/docs/artist_getting_started.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index 5ab89e31d8..3db4421181 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -21,7 +21,9 @@ admin, supervisor or production, because OpenPype versions and executables might Installing OpenPype is possible by Installer or by unzipping downloaded ZIP archive to any drive location. -> For more detailed info about installing OpenPype please visit [Installation section](artist_install.md). +:::tip Using the OpenPype Installer +See the [Installation section](artist_install.md) for more information on how to use the OpenPype Installer +::: --- From 7ee305a17329892a28025d65fb906fd376a4d3a3 Mon Sep 17 00:00:00 2001 From: Libor Batek <112623825+LiborBatek@users.noreply.github.com> Date: Wed, 1 Feb 2023 10:12:15 +0100 Subject: [PATCH 05/12] Update website/docs/artist_getting_started.md Co-authored-by: Roy Nieterau --- website/docs/artist_getting_started.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index 3db4421181..b9a75786cd 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -35,7 +35,9 @@ or alternatively by **openpype_console.exe** which is more suitable for **TDs/Admin** for debugging and error reporting. This one runs with opened console window where all the necessary info will appear during user's work session. -> By seeing the "OP" icon in the OS tray user can easily tell OpenPype already running. +:::tip Is OpenPype running? +OpenPype runs in the operating system's tray. If you see the OpenPype icon in the tray you can easily tell OpenPype is currently running. +::: From 4193ab3a9a8bc07f3cd21a03b434fcff5bf9f0dd Mon Sep 17 00:00:00 2001 From: Libor Batek <112623825+LiborBatek@users.noreply.github.com> Date: Wed, 1 Feb 2023 10:12:41 +0100 Subject: [PATCH 06/12] Update website/docs/artist_getting_started.md Co-authored-by: Roy Nieterau --- website/docs/artist_getting_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index b9a75786cd..ef7e682c94 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -44,7 +44,7 @@ OpenPype runs in the operating system's tray. If you see the OpenPype icon in th ## First Launch -When you first start OpenPype, you will be asked to fill in some basic informations. +When you first start OpenPype, you will be asked to fill in some basic information. ### MongoDB From 56c7c00bf8ecefbb7330f41f4b50bc3145a9474d Mon Sep 17 00:00:00 2001 From: Libor Batek <112623825+LiborBatek@users.noreply.github.com> Date: Wed, 1 Feb 2023 10:12:53 +0100 Subject: [PATCH 07/12] Update website/docs/artist_getting_started.md Co-authored-by: Roy Nieterau --- website/docs/artist_getting_started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index ef7e682c94..0ad98961d5 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -48,8 +48,8 @@ When you first start OpenPype, you will be asked to fill in some basic informati ### MongoDB -In most cases that will only be your studio MongoDB Address. -It's a URL that you should have received from your Studio admin and most often will look like this +In most cases you will only have to supply the MongoDB Address. +It's the database URL you should have received from your Studio admin and often will look like this `mongodb://username:passwword@mongo.mystudiodomain.com:12345` From 1ae99a2d2fae6274115aaeb0cd170587938972cb Mon Sep 17 00:00:00 2001 From: Libor Batek <112623825+LiborBatek@users.noreply.github.com> Date: Wed, 1 Feb 2023 10:14:00 +0100 Subject: [PATCH 08/12] Update website/docs/artist_getting_started.md Co-authored-by: Roy Nieterau --- website/docs/artist_getting_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index 0ad98961d5..72a218f77e 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -62,7 +62,7 @@ asks for it, just put it in the corresponding text field and press `install` but ### OpenPype Version Repository -Sometimes your Studio might also ask you to fill in the path to it's version +Sometimes your Studio might also ask you to fill in the path to its version repository. This is a location where OpenPype will be looking for when checking if it's up to date and where updates are installed from automatically. From fae61816c60e2c2b351749ae240f279b00cce538 Mon Sep 17 00:00:00 2001 From: Libor Batek <112623825+LiborBatek@users.noreply.github.com> Date: Wed, 1 Feb 2023 10:14:16 +0100 Subject: [PATCH 09/12] Update website/docs/artist_getting_started.md Co-authored-by: Roy Nieterau --- website/docs/artist_getting_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index 72a218f77e..1b32c6a985 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -27,7 +27,7 @@ See the [Installation section](artist_install.md) for more information on how to --- -You can run OpenPype by desktop "OP" icon (if exists after installing) or by directly executing +You can run OpenPype by desktop "OP" icon (if it exists after installing) or by directly executing **openpype_gui.exe** located in the OpenPype folder. This executable being suitable **for artists**. From 022e369d311dc09ca4404e7862f57e6b13323c4f Mon Sep 17 00:00:00 2001 From: Libor Batek <112623825+LiborBatek@users.noreply.github.com> Date: Wed, 1 Feb 2023 10:15:36 +0100 Subject: [PATCH 10/12] Update website/docs/artist_getting_started.md Co-authored-by: Roy Nieterau --- website/docs/artist_getting_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index 1b32c6a985..8350333610 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -63,7 +63,7 @@ asks for it, just put it in the corresponding text field and press `install` but ### OpenPype Version Repository Sometimes your Studio might also ask you to fill in the path to its version -repository. This is a location where OpenPype will be looking for when checking +repository. This is a location where OpenPype will search for the latest versions, check if it's up to date and where updates are installed from automatically. This path is usually taken from the database directly, so you shouldn't need it. From 8351ce0fba1e09689f9e41339e90463a4fde419a Mon Sep 17 00:00:00 2001 From: Libor Batek <112623825+LiborBatek@users.noreply.github.com> Date: Wed, 1 Feb 2023 10:17:04 +0100 Subject: [PATCH 11/12] grammar fixes Co-authored-by: Roy Nieterau --- website/docs/artist_getting_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index 8350333610..14951e599d 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -71,7 +71,7 @@ This path is usually taken from the database directly, so you shouldn't need it. ## Updates -If you're connected to your Studio, OpenPype will check for, and install updates automatically every time you run it. That's why during the first start, it will go through a quick update installation process, even though you might have just installed it. +If you're connected to your Studio, OpenPype will check for, and install updates automatically every time you run it. That's why during the first start it can go through a quick update installation process, even though you might have just installed it. ## Advanced Usage From 7217ba6b770d03c77736ba7e72cb2e04ff3b8dff Mon Sep 17 00:00:00 2001 From: Libor Batek Date: Thu, 2 Feb 2023 09:06:01 +0100 Subject: [PATCH 12/12] added pic for systray icon --- website/docs/artist_getting_started.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md index 14951e599d..301a58fa56 100644 --- a/website/docs/artist_getting_started.md +++ b/website/docs/artist_getting_started.md @@ -17,7 +17,7 @@ If this is not the case, please contact your administrator to consult on how to ## Working from home If you are working from **home** though, you'll **need to install** it yourself. You should, however, receive the OpenPype installer files from your studio -admin, supervisor or production, because OpenPype versions and executables might not be compatible between studios. +admin, supervisor or production, because OpenPype versions and executables might not be compatible between studios. Installing OpenPype is possible by Installer or by unzipping downloaded ZIP archive to any drive location. @@ -25,7 +25,6 @@ Installing OpenPype is possible by Installer or by unzipping downloaded ZIP arch See the [Installation section](artist_install.md) for more information on how to use the OpenPype Installer ::: ---- You can run OpenPype by desktop "OP" icon (if it exists after installing) or by directly executing @@ -33,12 +32,15 @@ You can run OpenPype by desktop "OP" icon (if it exists after installing) or by or alternatively by -**openpype_console.exe** which is more suitable for **TDs/Admin** for debugging and error reporting. This one runs with opened console window where all the necessary info will appear during user's work session. +**openpype_console.exe** which is more suitable for **TDs/Admin** for debugging and error reporting. This one runs with +opened console window where all the necessary info will appear during user's work session. :::tip Is OpenPype running? -OpenPype runs in the operating system's tray. If you see the OpenPype icon in the tray you can easily tell OpenPype is currently running. +OpenPype runs in the operating system's tray. If you see turquoise OpenPype icon in the tray you can easily tell OpenPype is currently running. +Keep in mind that on Windows this icon might be hidden by default, in which case, the artist can simply drag the icon down to the tray. ::: +![Systray](assets/artist_systray.png) ## First Launch @@ -49,7 +51,7 @@ When you first start OpenPype, you will be asked to fill in some basic informati ### MongoDB In most cases you will only have to supply the MongoDB Address. -It's the database URL you should have received from your Studio admin and often will look like this +It's the database URL you should have received from your Studio admin and often will look like this `mongodb://username:passwword@mongo.mystudiodomain.com:12345` @@ -64,14 +66,14 @@ asks for it, just put it in the corresponding text field and press `install` but Sometimes your Studio might also ask you to fill in the path to its version repository. This is a location where OpenPype will search for the latest versions, check -if it's up to date and where updates are installed from automatically. +if it's up to date and where updates are installed from automatically. -This path is usually taken from the database directly, so you shouldn't need it. +This path is usually taken from the database directly, so you shouldn't need it. ## Updates -If you're connected to your Studio, OpenPype will check for, and install updates automatically every time you run it. That's why during the first start it can go through a quick update installation process, even though you might have just installed it. +If you're connected to your Studio, OpenPype will check for, and install updates automatically every time you run it. That's why during the first start it can go through a quick update installation process, even though you might have just installed it. ## Advanced Usage