From 036509dc4733595e07b000097b6b841b2c76e40e Mon Sep 17 00:00:00 2001 From: Libor Batek Date: Wed, 25 Jan 2023 14:17:20 +0100 Subject: [PATCH] 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