From d257003d665c18d18cf36c801b78cafe27a93206 Mon Sep 17 00:00:00 2001 From: murphy Date: Tue, 1 Feb 2022 17:47:08 +0100 Subject: [PATCH] fixed relative links to .md files --- website/docs/admin_distribute.md | 2 +- website/docs/admin_hosts_maya.md | 2 +- website/docs/admin_hosts_tvpaint.md | 6 ++-- website/docs/admin_openpype_commands.md | 2 +- website/docs/admin_settings.md | 11 +++---- website/docs/admin_settings_local.md | 28 ++++++++++++++++++ website/docs/admin_settings_system.md | 4 +-- website/docs/artist_hosts_blender.md | 10 +++---- website/docs/artist_hosts_maya.md | 22 +++++++------- website/docs/artist_hosts_nuke_tut.md | 14 ++++----- website/docs/artist_tools.md | 4 +-- .../settings/settings_colour_coding.png | Bin 0 -> 15757 bytes .../docs/assets/settings/settings_local.png | Bin 0 -> 7212 bytes website/docs/dev_build.md | 2 +- website/docs/manager_ftrack.md | 8 ++--- website/docs/manager_ftrack_actions.md | 4 +-- website/docs/module_deadline.md | 4 +-- website/docs/module_ftrack.md | 16 +++++----- website/docs/module_slack.md | 2 +- website/docusaurus.config.js | 2 +- 20 files changed, 86 insertions(+), 57 deletions(-) create mode 100644 website/docs/admin_settings_local.md create mode 100644 website/docs/assets/settings/settings_colour_coding.png create mode 100644 website/docs/assets/settings/settings_local.png diff --git a/website/docs/admin_distribute.md b/website/docs/admin_distribute.md index b574a21cb2..d5399cfbcc 100644 --- a/website/docs/admin_distribute.md +++ b/website/docs/admin_distribute.md @@ -33,7 +33,7 @@ You have two ways of making this happen #### Automatic Updates Everytime and Artist launches OpenPype on their workstation, it will look to a pre-defined -[openPype update location](#self) for any versions that are newer than the +[openPype update location](admin_settings_system.md#openpype-deployment-control) for any versions that are newer than the latest, locally installed version. If such version is found, it will be downloaded, automatically extracted to the correct place and launched. This will become the default version to run for the artist, until a higher version is detected in the update location again. diff --git a/website/docs/admin_hosts_maya.md b/website/docs/admin_hosts_maya.md index 05a231c21a..93bf32798f 100644 --- a/website/docs/admin_hosts_maya.md +++ b/website/docs/admin_hosts_maya.md @@ -12,7 +12,7 @@ sidebar_label: Maya Render Settings Validator is here to make sure artists will submit renders we correct settings. Some of these settings are needed by OpenPype but some -can be defined by TD using [OpenPype Settings UI](admin_settings). +can be defined by TD using [OpenPype Settings UI](admin_settings.md). OpenPype enforced settings include: diff --git a/website/docs/admin_hosts_tvpaint.md b/website/docs/admin_hosts_tvpaint.md index a99cd19010..aa4354c2cf 100644 --- a/website/docs/admin_hosts_tvpaint.md +++ b/website/docs/admin_hosts_tvpaint.md @@ -10,13 +10,13 @@ import TabItem from '@theme/TabItem'; ## Subset name templates Definition of possibile subset name templates in TVPaint integration. -### [Render Layer](artist_hosts_tvpaint#render-layer) +### Render Layer Render layer has additional keys for subset name template. It is possible to use **render_layer** and **render_pass**. - Key **render_layer** is alias for variant (user's input). - For key **render_pass** is used predefined value `"Beauty"` (ATM value can't be changed). -### [Render pass](artist_hosts_tvpaint#render-pass) +### Render pass Render pass has additional keys for subset name template. It is possible to use **render_layer** and **render_pass**. - Key **render_layer** is filled with value of **render_pass** from `renderLayer` group. - Key **render_pass** is alias for variant (user's input). @@ -26,5 +26,5 @@ It is recommended to use same subset name template for both **renderLayer** and - Example template: `"{family}{Task}_{Render_layer}_{Render_pass}"` ::: -### [Review](artist_hosts_tvpaint#review) and [Workfile](artist_hosts_tvpaint#workfile) +### Review and Workfile Families **review** and **workfile** are not manually created but are automatically generated during publishing. That's why it is recommended to not use **variant** key in their subset name template. diff --git a/website/docs/admin_openpype_commands.md b/website/docs/admin_openpype_commands.md index 0831cf4f5a..0c90f93396 100644 --- a/website/docs/admin_openpype_commands.md +++ b/website/docs/admin_openpype_commands.md @@ -26,7 +26,7 @@ openpype_console --use-version=3.0.0-foo+bar `--validate-version` to validate integrity of given version -For more information [see here](admin_use#run-openpype). +For more information [see here](admin_use.md#run-openpype). ## Commands diff --git a/website/docs/admin_settings.md b/website/docs/admin_settings.md index 0cd10f81dc..d590f18724 100644 --- a/website/docs/admin_settings.md +++ b/website/docs/admin_settings.md @@ -9,11 +9,10 @@ import TabItem from '@theme/TabItem'; OpenPype stores all of it's settings and configuration in the mongo database. To make the configuration as easy as possible we provide a robust GUI where you can access and change everything that is configurable -**Settings** GUI can be started from the tray menu. +**Settings** GUI can be started from the tray menu Admin -> Studio Settings. Please keep in mind that these settings are set-up for the full studio and not per-individual. If you're looking for individual artist settings, you can head to -[Local Settings](#local-settings) section in the artist documentation. - +[Local Settings](admin_settings_local.md) section in the artist documentation. ## Categories @@ -23,16 +22,18 @@ We use simple colour coding to show you any changes to the settings: - **Orange**: [Project Override](#project-overrides) - **Blue**: Changed and unsaved value +![Colour coding](assets\settings\settings_colour_coding.png) + You'll find that settings are split into categories: -### [System](admin_settings_system) +### System System sections contains all settings that can be configured on a studio level, but cannot be changed on a per-project basis. These include mostly high level options like path to mongo database, toggling major modules on and off and configuring studio wide application availability. -### [Project](admin_settings_project) +### Project Project tab contains most of OpenPype settings and all of them can be configured and overriden on a per-project basis if need be. This includes most of the workflow behaviors like what formats to export, naming conventions, publishing validations, automatic assets loaders and a lot more. diff --git a/website/docs/admin_settings_local.md b/website/docs/admin_settings_local.md new file mode 100644 index 0000000000..b254beb53b --- /dev/null +++ b/website/docs/admin_settings_local.md @@ -0,0 +1,28 @@ +--- +id: admin_settings_local +title: Working with local settings +sidebar_label: Working with local settings +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +OpenPype stores some of it's settings and configuration in local file system. These settings are specific to each individual machine and provides the mechanism for local overrides + +**Local Settings** GUI can be started from the tray menu. + +![Local Settings](assets/settings/settings_local.png) + +## Categories + +### OpenPype Mongo URL + +### General + +### Experimental tools + +### Applications + +### Project Settings + + diff --git a/website/docs/admin_settings_system.md b/website/docs/admin_settings_system.md index 78be9fb01e..5c2908e933 100644 --- a/website/docs/admin_settings_system.md +++ b/website/docs/admin_settings_system.md @@ -28,13 +28,13 @@ Uses `subst` command, if configured volume character in `Destination` field alre ### OpenPype deployment control **`Versions Repository`** - Location where automatic update mechanism searches for zip files with -OpenPype update packages. To read more about preparing OpenPype for automatic updates go to [Admin Distribute docs](admin_distribute#2-openpype-codebase) +OpenPype update packages. To read more about preparing OpenPype for automatic updates go to [Admin Distribute docs](admin_distribute.md#2-openpype-codebase) **`Production version`** - Define what is current production version. When value is not set then latest version available in versions repository is resolved as production version. **`Staging version`** - Define what is current staging version. When value is not set then latest staging version available in versions repository is resolved as staging version. -For more information about Production and Staging go to [Distribute](admin_distribute#staging-vs-production). +For more information about Production and Staging go to [Distribute](admin_distribute.md#staging-vs-production). **Production version** and **Staging version** fields will define which version will be used in studio. Filling explicit version will force new OpenPype processes to use it. That gives more control over studio deployment especially when some workstations don't have access to version repository (e.g. remote users). It can be also used to downgrade studio version when newer version have production breaking bug. diff --git a/website/docs/artist_hosts_blender.md b/website/docs/artist_hosts_blender.md index 877e99bff4..cfbcced22f 100644 --- a/website/docs/artist_hosts_blender.md +++ b/website/docs/artist_hosts_blender.md @@ -55,12 +55,12 @@ can edit that field to change it to different asset (but that one must already e `Subset` field is a name you can decide on. It should describe what kind of data you have in the model. For example, you can name it `Proxy` to indicate that this is -low resolution stuff. See [Subset](artist_concepts#subset). +low resolution stuff. See [Subset](artist_concepts.md#subset).