diff --git a/.travis.yml b/.travis.yml index 935e1e92d..d8bdcc371 100644 --- a/.travis.yml +++ b/.travis.yml @@ -8,7 +8,7 @@ language: python python: - - "2.7" + - "3.8" env: global: @@ -28,11 +28,6 @@ before_install: - sudo apt-get install -y pandoc install: - # - # install pyside - from https://stackoverflow.com/questions/24489588 - - sudo apt-get install libqt4-dev - - pip install PySide --no-index --find-links https://parkin.github.io/python-wheelhouse/; - - python ~/virtualenv/python${TRAVIS_PYTHON_VERSION}/bin/pyside_postinstall.py -install # # jekyll dependencies - bundle install --gemfile=./tk-doc-generator/Gemfile --deployment diff --git a/README.md b/README.md index 57651cfb5..8bd5a29d5 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ # [developer.shotgunsoftware.com](http://developer.shotgunsoftware.com/) -Welcome to the source repository for [developer.shotgunsoftware.com](http://developer.shotgunsoftware.com/). This repository holds the markdown source and configuration used to generate the Shotgun developer site. +Welcome to the source repository for [developer.shotgunsoftware.com](http://developer.shotgunsoftware.com/). This repository holds the markdown source and configuration used to generate the {% include product %} developer site. ## How does it work? -The Shotgun Developer site uses *continous integration*. What you see in the master branch of this repository is reflected on the developer website. You create github issues and pull requests in order to make changes to the Repository. +The {% include product %} Developer site uses *continous integration*. What you see in the master branch of this repository is reflected on the developer website. You create github issues and pull requests in order to make changes to the Repository. The site uses the [Toolkit Documentation Generation system](https://github.com/shotgunsoftware/tk-doc-generator) to convert markdown, sphinx and other content to a website, complete with search, table of contents etc. diff --git a/docs/en/guides/pipeline-integrations.md b/docs/en/guides/pipeline-integrations.md index e168c541a..2ddfb2a1b 100644 --- a/docs/en/guides/pipeline-integrations.md +++ b/docs/en/guides/pipeline-integrations.md @@ -7,6 +7,6 @@ lang: en # Pipeline Integrations -Shotgun's pipeline integrations bring Shotgun data to your artists. Customizable UIs within popular content creation software give artists out-of-the-box tools to view information about their tasks, read and add notes, and share files with teammates. Pipeline integrations are build on the Shotgun Toolkit platform, and developers can use the Toolkit API to extend functionality or create custom Toolkit apps. +{% include product %}'s pipeline integrations bring {% include product %} data to your artists. Customizable UIs within popular content creation software give artists out-of-the-box tools to view information about their tasks, read and add notes, and share files with teammates. Pipeline integrations are build on the {% include product %} Toolkit platform, and developers can use the Toolkit API to extend functionality or create custom Toolkit apps. -This section contains learning materials to help you get started as you administer a Shotgun pipeline. You'll find guides to configuring your pipeline and managing your production file system, a tutorial for building a basic vfx pipeline, and resources for writing your own pipeline tools. +This section contains learning materials to help you get started as you administer a {% include product %} pipeline. You'll find guides to configuring your pipeline and managing your production file system, a tutorial for building a basic vfx pipeline, and resources for writing your own pipeline tools. diff --git a/docs/en/guides/pipeline-integrations/administration.md b/docs/en/guides/pipeline-integrations/administration.md index bfe8794a4..518f1d59f 100644 --- a/docs/en/guides/pipeline-integrations/administration.md +++ b/docs/en/guides/pipeline-integrations/administration.md @@ -7,6 +7,6 @@ lang: en # Administration -Shotgun's pipeline integrations offer a vast set of customization options. Getting your studio's desired pipeline up and running can be a combination of configuration, running command line tools, and ensuring that the Shotgun tools work in your studio environment. +{% include product %}'s pipeline integrations offer a vast set of customization options. Getting your studio's desired pipeline up and running can be a combination of configuration, running command line tools, and ensuring that the {% include product %} tools work in your studio environment. -This section contains information about administering your studio's Shotgun Toolkit pipeline. +This section contains information about administering your studio's {% include product %} Toolkit pipeline. diff --git a/docs/en/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md b/docs/en/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md index 9f161eb5e..1f0b4ce4e 100644 --- a/docs/en/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md +++ b/docs/en/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md @@ -21,19 +21,19 @@ lang: en ## Auto updates ### What parts auto update? -By default Shotgun Desktop will automatically check for updates, and install them to the local machine if it finds any. +By default {% include product %} Desktop will automatically check for updates, and install them to the local machine if it finds any. It checks for updates on two components: -- `tk-framework-desktopstartup` - A frame work which aids the launch of Shotgun Desktop. +- `tk-framework-desktopstartup` - A frame work which aids the launch of {% include product %} Desktop. - `tk-config-basic` - The default site config. -The configuration acts as a manifest for the versions of the apps, engines, frameworks, and core version that should be used by Shotgun Desktop. +The configuration acts as a manifest for the versions of the apps, engines, frameworks, and core version that should be used by {% include product %} Desktop. By updating the config, you are potentially updating any of these components as well. -Any updates that are found are downloaded and stored in the user's local cache, rather than modifying the original Shotgun Desktop installed files. +Any updates that are found are downloaded and stored in the user's local cache, rather than modifying the original {% include product %} Desktop installed files. -Shotgun Create as an application has it's own update mechanism separate from Shotgun Desktop which is not covered here. -However the integration features provided in Shotgun Create work in a similar way, and will also auto update `tk-config-basic` into the same user cache. +{% include product %} Create as an application has it's own update mechanism separate from {% include product %} Desktop which is not covered here. +However the integration features provided in {% include product %} Create work in a similar way, and will also auto update `tk-config-basic` into the same user cache. ### What doesn't auto update? @@ -41,40 +41,40 @@ However the integration features provided in Shotgun Create work in a similar wa - Any projects that aren't using the default site configuration (I.e. a project where the Toolkit advanced setup wizard has been run on it.), will not have their configuration auto updated. -- Resources such as Python and QT that come bundled with Shotgun Desktop, don't auto update. -We occasionally release new Shotgun Desktop installers when we need to update these parts. +- Resources such as Python and QT that come bundled with {% include product %} Desktop, don't auto update. +We occasionally release new {% include product %} Desktop installers when we need to update these parts. ## Running the integrations offline ### Initial setup If your studio has restricted internet access or no internet access then you will need to ensure that you have all the required parts cached locally. -You will still need one machine that can connect to the internet in order to download Shotgun Create or Shotgun Desktop. +You will still need one machine that can connect to the internet in order to download {% include product %} Create or {% include product %} Desktop. -Shotgun Desktop comes prepackaged with all the dependencies required to run the basic integrations. -Whilst Shotgun Create also comes bundled with the dependencies, it requires you to follow the steps mentioned in [managing updates](#managing-updates) as well. +{% include product %} Desktop comes prepackaged with all the dependencies required to run the basic integrations. +Whilst {% include product %} Create also comes bundled with the dependencies, it requires you to follow the steps mentioned in [managing updates](#managing-updates) as well. -When you start either of them up, it will automatically try to look for updates, but if it cannot connect to the Shotgun App Store, it will simply run the most recent version that exists locally. +When you start either of them up, it will automatically try to look for updates, but if it cannot connect to the {% include product %} App Store, it will simply run the most recent version that exists locally. -It is recommended that you follow the [managing updates](#managing-updates) steps bellow after installing Shotgun Desktop, as the components bundled with the installer may not be the latest. +It is recommended that you follow the [managing updates](#managing-updates) steps bellow after installing {% include product %} Desktop, as the components bundled with the installer may not be the latest. {% include info title="Note" content="Depending on your network setup, it can sometimes get stuck looking for updates online even though it won't be able to access them. In this situation you can set the environment variable `SHOTGUN_DISABLE_APPSTORE_ACCESS` to `\"1\"` to stop it from trying." %} -{% include info title="Note" content="You will still need to be able to connect to your Shotgun site. When we say offline we are talking about not being able to connect to our app store to download updates." %} +{% include info title="Note" content="You will still need to be able to connect to your shotgun site. When we say offline we are talking about not being able to connect to our app store to download updates." %} ### Managing updates To update the `tk-framework-desktopstartup` component, you will need to [download the latest version](https://github.com/shotgunsoftware/tk-framework-desktopstartup/releases), and set the environment variable -`SGTK_DESKTOP_STARTUP_LOCATION` to point to its location on disk, (This only applies to Shotgun Desktop.) +`SGTK_DESKTOP_STARTUP_LOCATION` to point to its location on disk, (This only applies to {% include product %} Desktop.) For the `tk-config-basic` component it's a bit more tricky, due to all its dependencies. -1. Run Shotgun Desktop or Shotgun Create on a workstation connected to the internet. When it starts up, the latest upgrades will be automatically downloaded. +1. Run {% include product %} Desktop or {% include product %} Create on a workstation connected to the internet. When it starts up, the latest upgrades will be automatically downloaded. (Ensure `SHOTGUN_DISABLE_APPSTORE_ACCESS` is not set on this machine.) 2. Copy the bundle cache to a shared location where all machines can access it. 3. Set the `SHOTGUN_BUNDLE_CACHE_FALLBACK_PATHS` environment variable on offline machines to point to this location. -4. When Shotgun Desktop or Shotgun Create starts up on offline machines, they will pick up the latest upgrades that are available in the bundle cache. +4. When {% include product %} Desktop or {% include product %} Create starts up on offline machines, they will pick up the latest upgrades that are available in the bundle cache. {% include info title="Warning" content="Depending on your network setup, it can sometimes get stuck looking for updates online even though it won't be able to access them. In this situation you can set the environment variable `SHOTGUN_DISABLE_APPSTORE_ACCESS` to `\"1\"` to stop it from trying." %} @@ -88,7 +88,7 @@ In this situation you can set the environment variable `SHOTGUN_DISABLE_APPSTORE Follow these steps to disable automatic updates for the integrations. 1. Determine the version you want to stay at. You can find the integration releases [here](https://support.shotgunsoftware.com/hc/en-us/sections/115000020494-Integrations). -2. In Shotgun, create a Pipeline Configuration entity either on a project or on a global page, with the following fields populated (In this example, we are locking down the config to use v1.0.36 of the integrations): +2. In {% include product %}, create a Pipeline Configuration entity either on a project or on a global page, with the following fields populated (In this example, we are locking down the config to use v1.0.36 of the integrations): 1. Name: `Primary` 2. Project: Leave empty if you want updates disabled for all projects, or pick a specific project if you only want to lock down a single project. @@ -96,23 +96,23 @@ Follow these steps to disable automatic updates for the integrations. 4. Descriptor: `sgtk:descriptor:app_store?name=tk-config-basic&version=v1.0.36` ![Pipeline Configuration entity with a setup for a project with disabled updates.](images/offline-and-disabled-auto-updates/freeze-all-projects.jpg) -3. Start Shotgun Desktop, and if you left the project field empty then Shotgun Desktop will have switched over to using this version if it wasn't already doing so. +3. Start {% include product %} Desktop, and if you left the project field empty then {% include product %} Desktop will have switched over to using this version if it wasn't already doing so. - ![Shotgun Desktop About](images/offline-and-disabled-auto-updates/shotgun-desktop-about.png) + ![{% include product %} Desktop About](images/offline-and-disabled-auto-updates/shotgun-desktop-about.png) - If you set a project, then only that project will be affected and you won't see a change in the Shotgun Desktop about window. + If you set a project, then only that project will be affected and you won't see a change in the {% include product %} Desktop about window. 4. [Optional] To lock the version of `tk-framework-desktopstartup` you will need to [download the latest version](https://github.com/shotgunsoftware/tk-framework-desktopstartup/releases), and set the environment variable -`SGTK_DESKTOP_STARTUP_LOCATION` to point to its location on disk, (This only applies to Shotgun Desktop.) +`SGTK_DESKTOP_STARTUP_LOCATION` to point to its location on disk, (This only applies to {% include product %} Desktop.) It's The majority for the functionality is controlled by the config which can be locked down with the previous steps, however as mentioned in the "what parts auto update?" section, the - component is also updated and that is handled separately from the config. This also only applies to Shotgun Desktop. + component is also updated and that is handled separately from the config. This also only applies to {% include product %} Desktop. #### Good to know -- You don't need to download the release of the configuration manually, Shotgun Desktop will handle this when it launches or you enter the project. +- You don't need to download the release of the configuration manually, {% include product %} Desktop will handle this when it launches or you enter the project. - `basic.*` means that all plugins in the basic configuration will pick up this override. If, for example, you wanted to freeze the Nuke and Maya integrations only, you could specify `basic.maya`, `basic.nuke`. - To test, you can create a duplicate of this Pipeline Configuration entity, and add your username to the `User Restrictions` field. This will restrict the entity such that it's only available to you and won't impact other users. You can then launch Maya or some other software from this duplicate configuration and confirm that it’s running the expected integrations versions. -- Leaving the project field blank is what we call a site configuration. Shotgun Desktop uses the site configuration, as it operates outside of projects. When you select a project in Shotgun Desktop it then loads the project configuration as well. +- Leaving the project field blank is what we call a site configuration. {% include product %} Desktop uses the site configuration, as it operates outside of projects. When you select a project in {% include product %} Desktop it then loads the project configuration as well. - The Flame integration is namespaced `basic.flame`, and so is implied to be part of `basic.*`. However, the Flame integration isn't actually included in the basic config. So, if you are using Flame for a project and implement this override, the Flame integration will stop working. @@ -140,10 +140,10 @@ You can When it comes to updating your configuration, you may wish to test out the newer version before rolling it out to all your users. -1. Duplicate the Pipeline Configuration entity in Shotgun by right-clicking on it and selecting **"Duplicate Selected"**. +1. Duplicate the Pipeline Configuration entity in {% include product %} by right-clicking on it and selecting **"Duplicate Selected"**. 2. Name the cloned config “update test”, and assign yourself to the User Restrictions field. 3. You will now begin to use this Pipeline Configuration. 4. Change the descriptor to point to the version you wish to test. 4. You can invite any users you want to partake in testing by adding them to the `User Restrictions` field. 5. Once you are happy with testing, simply update the main Pipeline Configuration to use that version. -6. Once users restart Shotgun Desktop and relaunch any currently open software with the Shotgun integration running, the update will be picked up. +6. Once users restart {% include product %} Desktop and relaunch any currently open software with the {% include product %} integration running, the update will be picked up. diff --git a/docs/en/guides/pipeline-integrations/development.md b/docs/en/guides/pipeline-integrations/development.md index e5d28f21e..7784fc3ea 100644 --- a/docs/en/guides/pipeline-integrations/development.md +++ b/docs/en/guides/pipeline-integrations/development.md @@ -10,7 +10,7 @@ lang: en ## What is Toolkit? Toolkit is the platform that underpins our pipeline integrations. -For example, If you are using the Shotgun Panel app in Maya or launching the Publish app from Shotgun Create, you are using tools built upon the Toolkit platform. +For example, If you are using the {% include product %} Panel app in Maya or launching the Publish app from {% include product %} Create, you are using tools built upon the Toolkit platform. ## How can I develop with Toolkit? @@ -22,13 +22,13 @@ There are a number of different ways in which you can develop with Toolkit. To do any of these things it's important to understand how to work with the Toolkit API. -Shotgun as a whole has three main API's -- [Shotgun Python API](https://developer.shotgunsoftware.com/python-api) -- [Shotgun REST API](https://developer.shotgunsoftware.com/rest-api/) -- [Shotgun Toolkit API](https://developer.shotgunsoftware.com/tk-core) +{% include product %} as a whole has three main API's +- [{% include product %} Python API](https://developer.shotgunsoftware.com/python-api) +- [{% include product %} REST API](https://developer.shotgunsoftware.com/rest-api/) +- [{% include product %} Toolkit API](https://developer.shotgunsoftware.com/tk-core) -The Toolkit API is a Python API, designed to be used alongside the Shotgun Python API or REST API, and is not a replacement for them. -Although the Toolkit API does have some wrapper methods, in general whenever you need to access data from your Shotgun site you will use the Shotgun Python or REST APIs instead. +The Toolkit API is a Python API, designed to be used alongside the {% include product %} Python API or REST API, and is not a replacement for them. +Although the Toolkit API does have some wrapper methods, in general whenever you need to access data from your {% include product %} site you will use the {% include product %} Python or REST APIs instead. The Toolkit API instead focuses on the integrations and management of file paths. Some Toolkit apps and frameworks also [have their own APIs](../../reference/pipeline-integrations.md). diff --git a/docs/en/guides/pipeline-integrations/development/sgtk-developer-app.md b/docs/en/guides/pipeline-integrations/development/sgtk-developer-app.md index e570e88f5..ce401908b 100644 --- a/docs/en/guides/pipeline-integrations/development/sgtk-developer-app.md +++ b/docs/en/guides/pipeline-integrations/development/sgtk-developer-app.md @@ -10,7 +10,7 @@ lang: en ## Introduction This guide outlines what a Toolkit app is, covers how to create one, and explains some basics around app development. -Shotgun Pipeline Toolkit is not only a collection of apps and engines maintained by Shotgun Software, it is also a development platform that makes it easy to quickly build custom pipeline tools! +{% include product %} Pipeline Toolkit is not only a collection of apps and engines maintained by {% include product %} Software, it is also a development platform that makes it easy to quickly build custom pipeline tools! - [What is a Toolkit app?](#what-is-a-toolkit-app) - [Creating your own app](#creating-your-own-app) @@ -35,8 +35,8 @@ Additional info: A Toolkit app can be defined as follows: -- A tool that is usually run by an end-user, using the Shotgun integrations. -- Apps usually have a graphical user interface with which the user can guide the app's operations, but they don't have to. An app can also be a command registered with the integrations, triggered by the user from the Shotgun menu in the host software. +- A tool that is usually run by an end-user, using the {% include product %} integrations. +- Apps usually have a graphical user interface with which the user can guide the app's operations, but they don't have to. An app can also be a command registered with the integrations, triggered by the user from the {% include product %} menu in the host software. - They can have an API/public methods in which other processes or apps could interact. - They can be multi-platform, and software agnostic. - They can be set up to be configured differently per [environment](https://developer.shotgunsoftware.com/487a9f2c/?title=Environment+Configuration+Reference#what-is-an-environment). @@ -47,7 +47,7 @@ Toolkit apps are initialized by Toolkit engines. [Engines](https://developer.sho This means the app only needs to focus on providing the functionality to fulfill its purpose and doesn't need to, for example, handle window parenting, keeping track of the user's context, or providing a shortcut for launching itself. ## Creating your own app. -All apps and engines maintained and released by Shotgun Software are open source and you can find them in [GitHub](https://github.com/shotgunsoftware). +All apps and engines maintained and released by {% include product %} Software are open source and you can find them in [GitHub](https://github.com/shotgunsoftware). This section goes through how to create a new app using our starter template. We assume that you are familiar with GitHub and git workflows, but please note that you can do Toolkit development even if you are not using git as your source control solution. @@ -70,7 +70,7 @@ Either way, the goal is to have a local copy of the starter app code so you can ## Part 3: Adding the app to your config We recommend reading the "[Adding an app](../getting-started/installing_app.md)" guide, as it explains in more detail how to add an app to your configuration. -When adding the app to your config, you need to consider where your app will be used, i.e. perhaps only in Nuke or in multiple different software, or standalone from Shotgun Desktop. +When adding the app to your config, you need to consider where your app will be used, i.e. perhaps only in Nuke or in multiple different software, or standalone from {% include product %} Desktop. You also need to think about the context that your app will depend on. For example, can your app only run when you know the task the user is working on, or can it run with just the project known? Knowing this will dictate which environment YAMLs and engines you need to add your app settings to. @@ -141,7 +141,7 @@ You can read more on configuration settings [in the reference documentation](htt If you know that you will be using frameworks, you can add them to the manifest file. -For example, if you plan to use the Qt Widgets and Shotgun Utils frameworks for your app, add the following to the `info.yml`: +For example, if you plan to use the Qt Widgets and {% include product %} Utils frameworks for your app, add the following to the `info.yml`: ```python # the frameworks required to run this app @@ -167,13 +167,13 @@ When the app is updated using `tank updates`, any configured frameworks not meet For more information about frameworks and how they can be useful, check out the following links: - [The Qt Widgets Framework](https://developer.shotgunsoftware.com/tk-framework-qtwidgets/) -- [The Shotgun utils Framework](https://developer.shotgunsoftware.com/tk-framework-shotgunutils/) +- [The {% include product %} utils Framework](https://developer.shotgunsoftware.com/tk-framework-shotgunutils/) ### Reloading your changes If you are testing your app within software such as Maya, then as soon as you have one or more dev items in your configuration, -Toolkit will automatically add a **Reload and Restart** option to the Shotgun menu. -![Shotgun menu Reload and Restart option](./images/reload-restart.png) +Toolkit will automatically add a **Reload and Restart** option to the {% include product %} menu. +![{% include product %} menu Reload and Restart option](./images/reload-restart.png) Clicking this will reload your configuration and code and then restart your engine. This means that you can iterate quickly: start Maya once, and then each time you make code or configuration changes that you want to try out, simply hit the **Reload and Restart** button and your changes will be pulled in. @@ -181,10 +181,10 @@ This means that you can iterate quickly: start Maya once, and then each time you {% include info title="Note" content="If you have any UIs active on screen, these will not automatically update, but you have to go in and re-launch the UIs from the menu." %} ## Part 5: Testing -When you want to test your code, you can easily invite other users to your dev sandbox by adding them to the `User Restrictions` field on the `PipelineConfiguration` entity in Shotgun. -As soon as you have added a user, they will see new entries on their menus inside of Shotgun Create and the browser actions, as well as an option to pick the configuration inside of Shotgun Desktop. +When you want to test your code, you can easily invite other users to your dev sandbox by adding them to the `User Restrictions` field on the `PipelineConfiguration` entity in {% include product %}. +As soon as you have added a user, they will see new entries on their menus inside of {% include product %} Create and the browser actions, as well as an option to pick the configuration inside of {% include product %} Desktop. -![Dev configuration selectable in Shotgun Desktop](./images/dev-configuration.png) +![Dev configuration selectable in {% include product %} Desktop](./images/dev-configuration.png) {% include info title="Note" content="Make sure they have access to see your app code as well, otherwise the app will not load." %} @@ -193,7 +193,7 @@ As soon as you have added a user, they will see new entries on their menus insid In [part three](#part-3---adding-the-app-to-your-config) you set your configuration to point to your app using a dev descriptor. For released software, you will want to ensure that your app can be accessed by all users and that things are versioned so that they can be upgraded safely and easily. -All apps provided by Shotgun use the Toolkit app store to track updates and releases, and they will have a location tag that looks something like this: +All apps provided by {% include product %} use the Toolkit app store to track updates and releases, and they will have a location tag that looks something like this: ```yaml location: @@ -207,7 +207,7 @@ Whenever the updates command is run and a new version is available, Toolkit will There are a few different options for sourcing your app releases. - [Git](https://developer.shotgunsoftware.com/tk-core/descriptor.html#tracking-against-tags-in-git) and [GitHub](https://developer.shotgunsoftware.com/tk-core/descriptor.html#tracking-against-releases-on-github) -- [Shotgun Uploads](https://developer.shotgunsoftware.com/tk-core/descriptor.html#pointing-at-a-file-attachment-in-shotgun) +- [{% include product %} Uploads](https://developer.shotgunsoftware.com/tk-core/descriptor.html#pointing-at-a-file-attachment-in-shotgun) - [Local paths](https://developer.shotgunsoftware.com/tk-core/descriptor.html#pointing-to-a-path-on-disk) In your production config, you add your app and switch to using the descriptor that suits your needs. @@ -232,7 +232,7 @@ The workflow is now identical to the one which happens with official app store a {% include warning title="Caution" content="The git descriptor works well with [centralized configs](https://developer.shotgunsoftware.com/tk-core/initializing.html#centralized-configurations), where the caching of apps is usually run by an admin and is stored to a central location where all users can access it. However, if you are using a [distributed config](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations), then it may not be as suitable. Your app will be downloaded per user, which means each user will need to have git installed and setup to authenticate with your repo and access the code." %} ## Modifying an existing app -Rather than starting from an empty starter template, it is sometimes necessary to add a minor feature to an existing app, for example, one of Shotgun Software's standard apps. +Rather than starting from an empty starter template, it is sometimes necessary to add a minor feature to an existing app, for example, one of {% include product %} Software's standard apps. When you work with a modified version of an app, you typically want to 'track' against the source app and make sure to regularly pull in changes and bug fixes. When you do this type of development, you pick up the parent code, then apply some of your changes, then release this to your pipeline. diff --git a/docs/en/guides/pipeline-integrations/development/sgtk-developer-bootstrapping.md b/docs/en/guides/pipeline-integrations/development/sgtk-developer-bootstrapping.md index 4c7f38b7a..d194fb83c 100644 --- a/docs/en/guides/pipeline-integrations/development/sgtk-developer-bootstrapping.md +++ b/docs/en/guides/pipeline-integrations/development/sgtk-developer-bootstrapping.md @@ -80,8 +80,8 @@ sgtk.LogManager().global_debug = True ## Part 3: Authentication -When running a script that uses the Toolkit API outside of an environment where Shotgun Toolkit has already been started, you will always need to authenticate. -So before you can perform the bootstrapping, you need to authenticate the Toolkit API with your Shotgun site. +When running a script that uses the Toolkit API outside of an environment where {% include product %} Toolkit has already been started, you will always need to authenticate. +So before you can perform the bootstrapping, you need to authenticate the Toolkit API with your {% include product %} site. You can authenticate with user credentials or with script credentials. @@ -89,7 +89,7 @@ You can authenticate with user credentials or with script credentials. then user authentication is the best way to go, (This is how all our integrations work by default). - If you're writing a script to automate something and a user is not present to authenticate then you should use script credentials. -Authentication is handled via the [`ShotgunAuthenticator`](https://developer.shotgunsoftware.com/tk-core/authentication.html?highlight=shotgunauthenticator#sgtk.authentication.ShotgunAuthenticator) class. +Authentication is handled via the [`{% include product %}Authenticator`](https://developer.shotgunsoftware.com/tk-core/authentication.html?highlight=shotgunauthenticator#sgtk.authentication.ShotgunAuthenticator) class. Here is an example of both user and script authentication. ### User Authentication @@ -145,7 +145,7 @@ The bootstrapping process at a high level essentially performs the following ste 1. Retrieves or locates the Toolkit configuration folder. 2. Ensures that the configuration dependencies such as the apps and engines are present in the [bundle cache](../../../quick-answers/administering/where-is-my-cache.md#bundle-cache). -If they are not present, and they are using cloud-based descriptors such as [`app_store`](https://developer.shotgunsoftware.com/tk-core/descriptor.html#the-shotgun-app-store), or [`shotgun`](https://developer.shotgunsoftware.com/tk-core/descriptor.html#pointing-at-a-file-attachment-in-shotgun) then it will download them to the bundle cache. +If they are not present, and they are using cloud-based descriptors such as [`app_store`](https://developer.shotgunsoftware.com/tk-core/descriptor.html#the-shotgun-app-store), or [`{% include product %}`](https://developer.shotgunsoftware.com/tk-core/descriptor.html#pointing-at-a-file-attachment-in-shotgun) then it will download them to the bundle cache. 3. Swaps out the current loaded sgtk core for the one appropriate to the config. 4. Initializes the engine, apps, and frameworks. @@ -185,7 +185,7 @@ For example, if you provide a `Project` entity, the engine will start up in a pr Likewise, you could provide a `Task` entity (where the task is linked to an `Asset`), and it will start up using the `asset_step.yml` environment. This is based on the default configuration behavior, [the environment that is chosen](https://developer.shotgunsoftware.com/487a9f2c/?title=Environment+Configuration+Reference#how-toolkit-determines-the-current-environment) is controlled via the core hook, [`pick_environment.py`](https://github.com/shotgunsoftware/tk-config-default2/blob/v1.2.11/core/hooks/pick_environment.py), and so could be changed to pick a different environment based on the context or other parameters. -You need to provide the entity in the format of a Shotgun entity dictionary which must contain at least the type and id: +You need to provide the entity in the format of a {% include product %} entity dictionary which must contain at least the type and id: ```python task = {"type": "Task", "id": 17264} @@ -265,7 +265,7 @@ engine = mgr.bootstrap_engine("tk-shell", entity=project) Now that you have an engine instance, you're ready to start using the Toolkit API. -Before covering how to launch the app, it's worth pointing out you can get hold of the [current context](https://developer.shotgunsoftware.com/tk-core/platform.html#sgtk.platform.Engine.context), [Sgtk instance](https://developer.shotgunsoftware.com/tk-core/platform.html#sgtk.platform.Engine.sgtk), and [Shotgun API instance](https://developer.shotgunsoftware.com/tk-core/platform.html#sgtk.platform.Engine.shotgun) via the engine. +Before covering how to launch the app, it's worth pointing out you can get hold of the [current context](https://developer.shotgunsoftware.com/tk-core/platform.html#sgtk.platform.Engine.context), [Sgtk instance](https://developer.shotgunsoftware.com/tk-core/platform.html#sgtk.platform.Engine.sgtk), and [{% include product %} API instance](https://developer.shotgunsoftware.com/tk-core/platform.html#sgtk.platform.Engine.shotgun) via the engine. ```python engine.context diff --git a/docs/en/guides/pipeline-integrations/development/sgtk-developer-engine.md b/docs/en/guides/pipeline-integrations/development/sgtk-developer-engine.md index adbec7a6c..8e46b9a2c 100644 --- a/docs/en/guides/pipeline-integrations/development/sgtk-developer-engine.md +++ b/docs/en/guides/pipeline-integrations/development/sgtk-developer-engine.md @@ -31,7 +31,7 @@ The engine is a collection of files, [similar in structure to an app](sgtk-devel Different engines then re-implement various aspects of this base class depending on their internal complexity. An engine typically handles or provides the following services: -- Menu management. At engine startup, once the apps have been loaded, the engine needs to create its Shotgun menu and add the various apps to this menu. +- Menu management. At engine startup, once the apps have been loaded, the engine needs to create its {% include product %} menu and add the various apps to this menu. - Logging methods are typically overridden to write to the software's log/console. - Methods for displaying UI dialogs and windows. These methods are usually overridden, if the way the engine handles Qt is different from the default base class behavior, to ensure seamless integration of windows launched by Toolkit apps and the underlying host software window management setup. - Provides a `commands` dictionary containing all the command objects registered by apps. This is typically accessed when menu entries are created. @@ -56,7 +56,7 @@ We may also be able to connect you to other users who are interested in or have If you can, open a channel of communication with a technical contact or developer of the software you are looking to integrate Toolkit into. This helps gain insight into what the possibilities and/or roadblocks are for getting something going. Once you establish a contact and talk through the basics of what you are trying to do, you can bring us into the conversation and set up a meeting with all of us to talk through some of the specifics of the engine. -Also, you can engage directly with the Toolkit community in the [Shotgun community forum](https://community.shotgunsoftware.com/c/pipeline). +Also, you can engage directly with the Toolkit community in the [{% include product %} community forum](https://community.shotgunsoftware.com/c/pipeline). We love to see new integrations, and are always eternally grateful for people's generous contributions to the Toolkit Community! @@ -70,7 +70,7 @@ This section outlines a couple of different complexity levels that we have notic ### Host software includes Qt, PyQt/PySide, and Python This is the best setup for Toolkit and implementing an engine on top of a host software that supports Qt, Python, and PySide is very straight forward. -The [Nuke engine](https://github.com/shotgunsoftware/tk-nuke) or the [Maya engine](https://github.com/shotgunsoftware/tk-maya) is a good example of this. Integration is merely a matter of hooking up some log file management and write code to set up the Shotgun menu. +The [Nuke engine](https://github.com/shotgunsoftware/tk-nuke) or the [Maya engine](https://github.com/shotgunsoftware/tk-maya) is a good example of this. Integration is merely a matter of hooking up some log file management and write code to set up the {% include product %} menu. ### Host software includes Qt and Python but not PySide/PyQt diff --git a/docs/en/guides/pipeline-integrations/development/sgtk-developer-framework.md b/docs/en/guides/pipeline-integrations/development/sgtk-developer-framework.md index 9401dcc7d..7b772e0c5 100644 --- a/docs/en/guides/pipeline-integrations/development/sgtk-developer-framework.md +++ b/docs/en/guides/pipeline-integrations/development/sgtk-developer-framework.md @@ -12,7 +12,7 @@ This document outlines some of the technical details relating to Toolkit framewo Table of Contents: - [What is a Toolkit framework?](#what-is-a-toolkit-framework) -- [Pre-made Shotgun frameworks](#pre-made-shotgun-frameworks) +- [Pre-made {% include product %} frameworks](#pre-made-shotgun-frameworks) - [Creating a Framework](#creating-a-framework) - [Using Frameworks from hooks](#using-frameworks-from-hooks) @@ -24,10 +24,10 @@ Instead, you would import a framework into your app or engine. It allows you to An example of a framework would be a library of reusable UI components, that might contain a playlist picker component. You could then import that framework in your app, and plug in the playlist picker component to your main app UI. -## Pre-made Shotgun frameworks +## Pre-made {% include product %} frameworks -Shotgun supplies some premade [frameworks](https://support.shotgunsoftware.com/hc/en-us/articles/219039798-Integrations-Apps-and-Engines#frameworks) that you may find useful when creating your own apps. -The [Qt Widgets](https://developer.shotgunsoftware.com/tk-framework-qtwidgets/) and [Shotgun Utils](https://developer.shotgunsoftware.com/tk-framework-shotgunutils/) frameworks are especially useful in app development. +{% include product %} supplies some premade [frameworks](https://support.shotgunsoftware.com/hc/en-us/articles/219039798-Integrations-Apps-and-Engines#frameworks) that you may find useful when creating your own apps. +The [Qt Widgets](https://developer.shotgunsoftware.com/tk-framework-qtwidgets/) and [{% include product %} Utils](https://developer.shotgunsoftware.com/tk-framework-shotgunutils/) frameworks are especially useful in app development. ## Creating a Framework diff --git a/docs/en/guides/pipeline-integrations/development/sgtk-developer-generating-path-and-publish.md b/docs/en/guides/pipeline-integrations/development/sgtk-developer-generating-path-and-publish.md index 35895fac2..c02d4cfcc 100644 --- a/docs/en/guides/pipeline-integrations/development/sgtk-developer-generating-path-and-publish.md +++ b/docs/en/guides/pipeline-integrations/development/sgtk-developer-generating-path-and-publish.md @@ -7,7 +7,7 @@ lang: en # Generating a path and publishing it -This guide covers getting started with the Shotgun Toolkit Python API, which is what our pipeline integrations are built with. +This guide covers getting started with the {% include product %} Toolkit Python API, which is what our pipeline integrations are built with. The purpose of this guide is to walk through a basic example of how you can use the API, and by the end, you will be able to import the Toolkit API and generate a path and publish it. @@ -36,16 +36,16 @@ To use the API on a project's configuration, you must import the `sgtk` package {% include info title="Note" content="You may sometimes come across references to a `tank` package. This is the legacy name for the same thing. While both work `sgtk` is the correct name to use going forward." %} To import the API you need to make sure that the path to the [core's python folder](https://github.com/shotgunsoftware/tk-core/tree/v0.18.167/python) exists in the [`sys.path`](https://docs.python.org/3/library/sys.html#sys.path). -However, for this example, we recommend that you run this code in the Shotgun Desktop's Python console. +However, for this example, we recommend that you run this code in the {% include product %} Desktop's Python console. This will mean that the correct `sgtk` package path is already added to your `sys.path`. -Equally, you don't need to add the path if you are running this code within software where the Shotgun integration is already running. +Equally, you don't need to add the path if you are running this code within software where the {% include product %} integration is already running. -When running your code in an environment where Shotgun is already started you can import the API by simply writing: +When running your code in an environment where {% include product %} is already started you can import the API by simply writing: ```python import sgtk ``` -If you want to use the API outside of a Shotgun integration, for example, if you're testing it in your favorite IDE, then you will need to set the path to the API first: +If you want to use the API outside of a {% include product %} integration, for example, if you're testing it in your favorite IDE, then you will need to set the path to the API first: ```python import sys @@ -65,7 +65,7 @@ Once you create an instance of `Sgtk`, you will be able to do things like get a As the API documentation states, you don't create an instance of `Sgtk` directly. Here are some options for getting an `Sgtk` instance. -1. You can get an `Sgtk` instance from the current engine, if you are running the Python code within an environment where the Shotgun integrations are already running, (such as the Maya Python console, if Maya was launched from Shotgun.) +1. You can get an `Sgtk` instance from the current engine, if you are running the Python code within an environment where the {% include product %} integrations are already running, (such as the Maya Python console, if Maya was launched from {% include product %}.) The `Engine.sgtk` property holds the engine's `Sgtk` instance. So for example, in Maya, you could run the following: @@ -92,7 +92,7 @@ As the API documentation states, you don't create an instance of `Sgtk` directly Throughout this guide we will assume you are running this code in an environment where an engine has already been started, so we'll use option 1. Also you will store the `Sgtk` class instance in a variable called `tk`. -If you're using the Shotgun Python Console then the `tk` variable is already pre-defined as a global variable. +If you're using the {% include product %} Python Console then the `tk` variable is already pre-defined as a global variable. You now have an `Sgtk` instance and you're ready to start using the API. Your publish script should now look like this: @@ -332,15 +332,15 @@ The next step is to dynamically work out the next version number rather than har There two methods you could use here. -1. Since in this particular example you are resolving a publish file, you could use the [Shotgun API](https://developer.shotgunsoftware.com/python-api/) to query for the next available version number on `PublishedFile` entities. +1. Since in this particular example you are resolving a publish file, you could use the [{% include product %} API](https://developer.shotgunsoftware.com/python-api/) to query for the next available version number on `PublishedFile` entities. 2. You can scan the files on disk and work out what versions already exist, and extract the next version number. -This is helpful if the files you're working with aren't tracked in Shotgun (such as work files). +This is helpful if the files you're working with aren't tracked in {% include product %} (such as work files). While the first option would probably be most suitable for the example in this guide, both approaches have their uses so we'll cover them both. -### Querying Shotgun for the next version number. +### Querying {% include product %} for the next version number. -Using the Shotgun API and the [`summarize()` method](https://developer.shotgunsoftware.com/python-api/reference.html#shotgun_api3.shotgun.Shotgun.summarize) you can get the highest version number amongst the `PublishedFile` entities, that share the same name and task, and then add 1. +Using the {% include product %} API and the [`summarize()` method](https://developer.shotgunsoftware.com/python-api/reference.html#shotgun_api3.shotgun.Shotgun.summarize) you can get the highest version number amongst the `PublishedFile` entities, that share the same name and task, and then add 1. ```python r = sg.summarize(entity_type="PublishedFile", @@ -397,7 +397,7 @@ You can chose to use either option, but the guide will use the code from option Now that you have a path you're ready to publish it. To do this you can use the utility method [`sgtk.util.register_publish()`](https://developer.shotgunsoftware.com/tk-core/utils.html?#sgtk.util.register_publish). -It is possible to use the Shotgun API's [`Shotgun.create()`](https://developer.shotgunsoftware.com/python-api/reference.html#shotgun_api3.shotgun.Shotgun.create) method to create a `PublishedFile` entity as well, but we strongly recommend using the Toolkit API for this as it will ensure all the required fields are provided and filled in correctly. +It is possible to use the {% include product %} API's [`{% include product %}.create()`](https://developer.shotgunsoftware.com/python-api/reference.html#shotgun_api3.shotgun.Shotgun.create) method to create a `PublishedFile` entity as well, but we strongly recommend using the Toolkit API for this as it will ensure all the required fields are provided and filled in correctly. ```python # So as to match the Publish app's default behavior, we are adding the extension to the end of the publish name. diff --git a/docs/en/guides/pipeline-integrations/getting-started/advanced_config.md b/docs/en/guides/pipeline-integrations/getting-started/advanced_config.md index 5f8db1bac..785188b4c 100644 --- a/docs/en/guides/pipeline-integrations/getting-started/advanced_config.md +++ b/docs/en/guides/pipeline-integrations/getting-started/advanced_config.md @@ -11,35 +11,35 @@ After completing this guide, you will have the knowledge fundamental to adding y ## About the guide -This guide describes how to use the **Advanced Project Setup Wizard** in Shotgun Desktop to create a configuration for a digital content creation pipeline. You will quickly become acquainted with the configuration tools, learn how to use the Wizard, and be presented with opportunities to learn more. Using the Wizard creates a pipeline configuration for your project and prepares it to be edited and extended to support each step in the pipeline. The configuration controls aspects of the UI, Shotgun Apps, and various tools necessary to support a production pipeline. Using the Wizard is just one way to extend a configuration. Along with adding specific settings for each step in a pipeline, it will add integrations with software applications. In this guide, we'll be basing our project's configuration on Toolkit's Default Configuration. +This guide describes how to use the **Advanced Project Setup Wizard** in {% include product %} Desktop to create a configuration for a digital content creation pipeline. You will quickly become acquainted with the configuration tools, learn how to use the Wizard, and be presented with opportunities to learn more. Using the Wizard creates a pipeline configuration for your project and prepares it to be edited and extended to support each step in the pipeline. The configuration controls aspects of the UI, {% include product %} Apps, and various tools necessary to support a production pipeline. Using the Wizard is just one way to extend a configuration. Along with adding specific settings for each step in a pipeline, it will add integrations with software applications. In this guide, we'll be basing our project's configuration on Toolkit's Default Configuration. This guide assumes the user: 1. Has never used the Advanced Project Setup Wizard -2. Has some basic knowledge of how to use Shotgun -3. Is new to Shotgun Toolkit +2. Has some basic knowledge of how to use {% include product %} +3. Is new to {% include product %} Toolkit ### Using this document To use this guide and create a customizable configuration for your project, the following is required: -1. An active Shotgun site. You can [register for Shotgun here](https://www.shotgunsoftware.com/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management) and get a 30-day trial to begin exploring. -2. Shotgun Desktop. If Desktop is not installed, you can [begin by following this link.]( https://support.shotgunsoftware.com/hc/en-us/articles/115000068574-Integrations-user-guide#Installation%20of%20Desktop) +1. An active {% include product %} site. You can [register for {% include product %} here](https://www.shotgunsoftware.com/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management) and get a 30-day trial to begin exploring. +2. {% include product %} Desktop. If Desktop is not installed, you can [begin by following this link.]( https://support.shotgunsoftware.com/hc/en-us/articles/115000068574-Integrations-user-guide#Installation%20of%20Desktop) 3. Access to a filesystem where you can store project files and a pipeline configuration. On the filesystem, create a folder called `Shotgun`, with two folders, `projects` and `configs`, within it. ## About the Advanced Project Setup Wizard -The Advanced Project Setup Wizard in Shotgun Desktop generates a pipeline configuration based on the Default Configuration. The Default Configuration provides a solid base to build on, complete with customizable settings, apps, and UI elements that support the pipeline process. It creates a configuration you can edit and extend to meet your project’s pipeline needs. +The Advanced Project Setup Wizard in {% include product %} Desktop generates a pipeline configuration based on the Default Configuration. The Default Configuration provides a solid base to build on, complete with customizable settings, apps, and UI elements that support the pipeline process. It creates a configuration you can edit and extend to meet your project’s pipeline needs. The Default Configuration includes: * A basic filesystem schema and templates that determine where files live on disk -* All of the supported [software integrations](https://support.shotgunsoftware.com/hc/en-us/articles/219039798-Integrations-Apps-and-Engines) allowing interaction with Shotgun and pipeline functions from directly inside the user’s software applications. +* All of the supported [software integrations](https://support.shotgunsoftware.com/hc/en-us/articles/219039798-Integrations-Apps-and-Engines) allowing interaction with {% include product %} and pipeline functions from directly inside the user’s software applications. -Customizations are only limited by imagination, cleverness, and programming knowledge or the ability to borrow from what others in the Shotgun community have created. +Customizations are only limited by imagination, cleverness, and programming knowledge or the ability to borrow from what others in the {% include product %} community have created. ### Creating the configuration -A configuration is required for every project. The first time a project is accessed through Shotgun Desktop, a Basic Configuration is downloaded and configured. This Basic Configuration automatically detects the supported content creation software a user has on their system and associates the configuration with the project. Settings in the pipeline configuration govern the integrations within the supported software applications. The [Panel]( https://support.shotgunsoftware.com/hc/en-us/articles/219033098-Shotgun-Panel) app displays project information from Shotgun and allows artists to reply to notes and view Versions without leaving their work session. The [Publisher](https://support.shotgunsoftware.com/hc/en-us/articles/219032998-Publishing-your-work) app allows artists to make their work available for others on their team, and through the [Loader](https://support.shotgunsoftware.com/hc/en-us/articles/219033078-Load-Published-Files-) app, artists can load their teammates' published files. The Basic Configuration does not include file system management setup or the development of templates for specifying how files and directories are named on disk. It also doesn’t have the plethora of Apps that are added when a Default Configuration is configured. It is a simple configuration that allows Toolkit to run without any manual editing of configuration files. The Wizard replaces the Basic Configuration with a Default Configuration. It provides more apps and software integrations to support you on your journey. While the Basic Configuration can be edited as well, it's not until you have an advanced setup that your project will be set up for customization. +A configuration is required for every project. The first time a project is accessed through {% include product %} Desktop, a Basic Configuration is downloaded and configured. This Basic Configuration automatically detects the supported content creation software a user has on their system and associates the configuration with the project. Settings in the pipeline configuration govern the integrations within the supported software applications. The [Panel]( https://support.shotgunsoftware.com/hc/en-us/articles/219033098-Shotgun-Panel) app displays project information from {% include product %} and allows artists to reply to notes and view Versions without leaving their work session. The [Publisher](https://support.shotgunsoftware.com/hc/en-us/articles/219032998-Publishing-your-work) app allows artists to make their work available for others on their team, and through the [Loader](https://support.shotgunsoftware.com/hc/en-us/articles/219033078-Load-Published-Files-) app, artists can load their teammates' published files. The Basic Configuration does not include file system management setup or the development of templates for specifying how files and directories are named on disk. It also doesn’t have the plethora of Apps that are added when a Default Configuration is configured. It is a simple configuration that allows Toolkit to run without any manual editing of configuration files. The Wizard replaces the Basic Configuration with a Default Configuration. It provides more apps and software integrations to support you on your journey. While the Basic Configuration can be edited as well, it's not until you have an advanced setup that your project will be set up for customization. ### Differences between the Basic and Default Configurations @@ -51,19 +51,19 @@ A configuration is required for every project. The first time a project is acces | Updates | Automatically updated | Manually updated | | File System Support | No support for filesystem schema | Includes tools to support folder structure and file naming standards | | Software Integrations | 3ds Max, Houdini, Maya, Nuke, Photoshop, Flame | Basic + Hiero, Motionbulder, Mari | -| Toolkit Apps | Shotgun Panel, Publisher, Loader | Basic + Workfiles, Snap Shot, Scene breakdown, Nuke write node, Houdini Mantra node, and more | +| Toolkit Apps | {% include product %} Panel, Publisher, Loader | Basic + Workfiles, Snap Shot, Scene breakdown, Nuke write node, Houdini Mantra node, and more | -In this guide, you will use the Wizard in Shotgun Desktop to generate a pipeline configuration for your project based on the Default Configuration. Generating this configuration sets you up to make the customizations necessary to support a proprietary production pipeline. +In this guide, you will use the Wizard in {% include product %} Desktop to generate a pipeline configuration for your project based on the Default Configuration. Generating this configuration sets you up to make the customizations necessary to support a proprietary production pipeline. ## Begin Exercise ### Prepare to use a Default Configuration -**Step 1:** Create a new project in Shotgun called "the_other_side.” +**Step 1:** Create a new project in {% include product %} called "the_other_side.” ![New project](./images/advanced_config/2_new_project.png) -**Step 2:** Launch the Shotgun Desktop app and log in using the username and password from your Shotgun site. +**Step 2:** Launch the {% include product %} Desktop app and log in using the username and password from your {% include product %} site. ![Login](./images/advanced_config/3_login.png) @@ -77,21 +77,21 @@ In this guide, you will use the Wizard in Shotgun Desktop to generate a pipeline ### Accessing the Default Configuration -A Basic Configuration was downloaded and configured when the project was accessed. The Publish app and supported software packages were detected and automatically added to the **Apps** pane in Shotgun Desktop. +A Basic Configuration was downloaded and configured when the project was accessed. The Publish app and supported software packages were detected and automatically added to the **Apps** pane in {% include product %} Desktop. **Step 4:** Once the project is loaded, select your profile **avatar** at the bottom right of the screen. In the popup menu, select **Advanced project setup…** to initiate the Wizard. ![Advanced project setup](./images/advanced_config/6_advanced_project_setup.png) -A dialog box will be displayed with four options and Shotgun Default selected. At this point, you can choose to base your project's pipeline configuration on the configuration of an existing project, on a configuration in a git repository, or on a path on disk. +A dialog box will be displayed with four options and {% include product %} Default selected. At this point, you can choose to base your project's pipeline configuration on the configuration of an existing project, on a configuration in a git repository, or on a path on disk. -For this exercise, we'll choose **Shotgun Default**. This option will create a pipeline configuration for your project that's based on Shotgun's Default Configuration. +For this exercise, we'll choose **{% include product %} Default**. This option will create a pipeline configuration for your project that's based on {% include product %}'s Default Configuration. ![Select config](./images/advanced_config/7_select_config.png) **Step 5:** Select **Continue**. -A dialog box will be displayed with two options and **Default** selected. At this point there’s an option to select a Legacy Default Configuration setup. This configuration setup is from an older version of Shotgun for studios who still use that version. We will use the Default for this exercise. +A dialog box will be displayed with two options and **Default** selected. At this point there’s an option to select a Legacy Default Configuration setup. This configuration setup is from an older version of {% include product %} for studios who still use that version. We will use the Default for this exercise. ![Select config](./images/advanced_config/8_select_config.png) @@ -107,13 +107,13 @@ A dialog box will appear displaying a drop-down menu next to the word `Storage:` ![Define storage](./images/advanced_config/10_define_storage2.png) -Shotgun Toolkit supports three operating systems: Linux, Mac, and Windows. +{% include product %} Toolkit supports three operating systems: Linux, Mac, and Windows. **Step 8:** Select the field next to the operating system utilized for storing project data. Select the folder icon and navigate to the project folder created on the filesystem prior to this exercise. ![Storage root folder](./images/advanced_config/11_storage_root_folder.png) -This setup allows Shotgun to have access to only the folder you identify for storing production data. When preparing for this exercise you added a `projects/` directory within your Shotgun root directory. The `projects/` directory is where Toolkit will store any local project related information. +This setup allows {% include product %} to have access to only the folder you identify for storing production data. When preparing for this exercise you added a `projects/` directory within your {% include product %} root directory. The `projects/` directory is where Toolkit will store any local project related information. ![Define storage](./images/advanced_config/12_define_Storage3.png) @@ -131,7 +131,7 @@ A dialog box is displayed with the name of the project populating the text field ![Project folder](./images/advanced_config/14_project_folder_name.png) -Toolkit can work in either a Distributed Setup, where the pipeline configuration is uploaded to Shotgun and cached locally for each user, or a Centralized Setup, where users access a single configuration in a shared location on disk. For this exercise we will use a Centralized Setup. You can [learn more about Distributed Setups here](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations). +Toolkit can work in either a Distributed Setup, where the pipeline configuration is uploaded to {% include product %} and cached locally for each user, or a Centralized Setup, where users access a single configuration in a shared location on disk. For this exercise we will use a Centralized Setup. You can [learn more about Distributed Setups here](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations). The final step generates the appropriate folders, files, and data necessary to create the configuration specific to a project. @@ -145,7 +145,7 @@ The final step generates the appropriate folders, files, and data necessary to c ![Setup complete](./images/advanced_config/17_project_setup_complete.png) -**TIP:** Pin the app to the menu bar to allow quick access to Shotgun Desktop: select your **avatar** and select **Pin to Menu**. +**TIP:** Pin the app to the menu bar to allow quick access to {% include product %} Desktop: select your **avatar** and select **Pin to Menu**. You’re done; the project setup is complete. You now have a Toolkit pipeline configuration for your project in the location you specified, based on the Default Configuration, and you’re ready to start customizing. @@ -157,7 +157,7 @@ And now the real fun begins, learning all the things you can do with the Configu ## Advanced topics -Shotgun Toolkit provides many convenient ways to edit, clone, or take over a configuration. Extending existing configurations will save time and allow you access to all of the cool stuff that others within your network have created. You can take advantage of the vast Shotgun [community](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups#!forum/shotgun-dev) that may have the exact configuration you need. The Shotgun community is a sharing community, so be kind, say thank you, and recognize the person who created the configuration that helped you get the job done. Oh, and don’t forget to give back, it’s how we help our fellow Shotgun gurus and what makes it so special to be a part of this community! +{% include product %} Toolkit provides many convenient ways to edit, clone, or take over a configuration. Extending existing configurations will save time and allow you access to all of the cool stuff that others within your network have created. You can take advantage of the vast {% include product %} [community](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups#!forum/shotgun-dev) that may have the exact configuration you need. The {% include product %} community is a sharing community, so be kind, say thank you, and recognize the person who created the configuration that helped you get the job done. Oh, and don’t forget to give back, it’s how we help our fellow {% include product %} gurus and what makes it so special to be a part of this community! Below are some ways you can have fun with configurations. @@ -167,7 +167,7 @@ From inside any project configuration, the `tank` command lets you run administr ### Editing a configuration that's in production -There will be times when you want to modify a configuration that is currently in production, but you won't want to edit it while artists are using it. With just a few commands, Shotgun provides a way to copy an existing configuration where you can test your modifications safely before pushing them into production. This process replaces the production configuration with the new one and automatically backs up the old one. +There will be times when you want to modify a configuration that is currently in production, but you won't want to edit it while artists are using it. With just a few commands, {% include product %} provides a way to copy an existing configuration where you can test your modifications safely before pushing them into production. This process replaces the production configuration with the new one and automatically backs up the old one. The reasons you would want work on a copy of a configuration are: @@ -180,7 +180,7 @@ To learn about cloning your configuration, as well as other basics of configurat ### Cloud distribution of pipeline configurations -This guide walks through creating a **centralized configuration**: a single copy of a pipeline configuration that is located in a shared network location and accessed by all users. But, if your workforce is distributed across locations and networks, it may not be feasible to share a single copy of a pipeline configuration. Toolkit allows for this scenario by providing a **distributed configuration** option where a pipeline configuration is uploaded to Shotgun and each time a user accesses a project the configuration is downloaded and cached locally. You can learn more about distributed configurations in our [Core API developer documentation](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations). +This guide walks through creating a **centralized configuration**: a single copy of a pipeline configuration that is located in a shared network location and accessed by all users. But, if your workforce is distributed across locations and networks, it may not be feasible to share a single copy of a pipeline configuration. Toolkit allows for this scenario by providing a **distributed configuration** option where a pipeline configuration is uploaded to {% include product %} and each time a user accesses a project the configuration is downloaded and cached locally. You can learn more about distributed configurations in our [Core API developer documentation](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations). ### Working with more than one root folder diff --git a/docs/en/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md b/docs/en/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md index ed2a75e56..0f3fd9fb2 100644 --- a/docs/en/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md +++ b/docs/en/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md @@ -11,9 +11,9 @@ In this guide, you will learn how to modify your Toolkit pipeline configuration ## About the guide -One of the hardest things about managing a pipeline is keeping track of the myriad files that will be created. Your Toolkit pipeline automates filesystem management: by creating folders based on data in Shotgun and a configured folder structure, and automatically writing files to the right place and with standardized naming, artists can focus on content creation. Your pipeline configuration comes with a default set of folder and file naming conventions, but productions often customize them. This guide will provide the knowledge necessary to make those customizations. +One of the hardest things about managing a pipeline is keeping track of the myriad files that will be created. Your Toolkit pipeline automates filesystem management: by creating folders based on data in {% include product %} and a configured folder structure, and automatically writing files to the right place and with standardized naming, artists can focus on content creation. Your pipeline configuration comes with a default set of folder and file naming conventions, but productions often customize them. This guide will provide the knowledge necessary to make those customizations. -In the Default Configuration, assets are managed in a folder structure like `asset_type/asset/pipeline_step`. In this guide, we’ll be using a custom entity called “Set” to organize them further by the production set on which each asset is used. We will first set up the custom entity in Shotgun, then use it to manage the assets created for any given set, so that the folder structure looks like `set/asset_type/asset/pipeline_step`. +In the Default Configuration, assets are managed in a folder structure like `asset_type/asset/pipeline_step`. In this guide, we’ll be using a custom entity called “Set” to organize them further by the production set on which each asset is used. We will first set up the custom entity in {% include product %}, then use it to manage the assets created for any given set, so that the folder structure looks like `set/asset_type/asset/pipeline_step`. We can demonstrate the idea behind organizing assets by set with an example: say you have a project where some scenes take place in a garage, while others take place in a dining room. With our setup, files for assets like “wrench”, “oilcan”, or “workbench” would be organized in a “garage” folder, while “plate”, “winebottle”, or “tablecloth” would be organized in a “dining_room” folder. In our example, we'll be ensuring that a juicy "filet" asset is properly placed in the dining room. @@ -21,7 +21,7 @@ As part of our example, we’ll also edit the filenaming templates for the proje ### There are three parts to this guide -* Creating a **custom entity** in Shotgun called “Set”, which you will use to associate with the dining room elements the artists are creating. +* Creating a **custom entity** in {% include product %} called “Set”, which you will use to associate with the dining room elements the artists are creating. * Editing the folder **schema**, enabling Toolkit to include a dynamically named folder based on the current set in the folder structure. * Editing the **template** used for naming asset work files, enabling Toolkit to include the name of the associated set in the file name. @@ -29,9 +29,9 @@ As part of our example, we’ll also edit the filenaming templates for the proje To use this guide, the following is required: -1. An active [Shotgun](https://www.shotgunsoftware.com/signup/) site. You should have a project with at least one Asset created. The asset should have a Model task. -2. A basic understanding of how a Shotgun site is used to manage assets -3. [Shotgun Desktop](https://support.shotgunsoftware.com/hc/en-us/articles/115000068574-Integrations-user-guide#Installation%20of%20Desktop) installed on your system. +1. An active [{% include product %}](https://www.shotgunsoftware.com/signup/) site. You should have a project with at least one Asset created. The asset should have a Model task. +2. A basic understanding of how a {% include product %} site is used to manage assets +3. [{% include product %} Desktop](https://support.shotgunsoftware.com/hc/en-us/articles/115000068574-Integrations-user-guide#Installation%20of%20Desktop) installed on your system. 4. A cloned pipeline configuration for the identified project, or complete the [Getting started with configurations](./advanced_config.md) guide and clone the configuration created in that exercise. 5. Basic familiarity with YAML. 6. Read and write permissions set appropriately for the filesystem where the Pipeline Configuration is stored. @@ -42,11 +42,11 @@ To use this guide, the following is required: ### About file schemas and templates -The schema and templates in the Toolkit pipeline configuration allow you to take advantage of your Shotgun data for managing production files on disk. The schema in the Default Configuration includes entities like **Shot**, **Sequence**, **Asset**, **Asset Type**, etc. Other entities like **Level**, **Episode**, **Season**, or in our case, custom entities like **Set** can be added. +The schema and templates in the Toolkit pipeline configuration allow you to take advantage of your {% include product %} data for managing production files on disk. The schema in the Default Configuration includes entities like **Shot**, **Sequence**, **Asset**, **Asset Type**, etc. Other entities like **Level**, **Episode**, **Season**, or in our case, custom entities like **Set** can be added. The Toolkit platform allows you to build your folder structure dynamically by using a **schema**, a miniature version of a production folder structure that will be used as a template when building out your actual production filesystem. The schema is an explicit guide for the dynamic creation of folders, and uses YAML files to define the rules for dynamically created folders. The Default Configuration includes a pre-configured schema that supports folder creation for both asset and shot pipelines. You will be modifying the portion of the schema that supports creating the asset folder structure, `/assets///`, to add support for the new **Set** entity you’re creating. -**Templates** allow you to dynamically name and save files as they’re created using Shotgun data and information from the schema structure. The Default Configuration provides a set of starter templates that you can edit to meet the needs of your pipeline. +**Templates** allow you to dynamically name and save files as they’re created using {% include product %} data and information from the schema structure. The Default Configuration provides a set of starter templates that you can edit to meet the needs of your pipeline. {% include info title="Note" content="The Basic setup for Shotgun integrations doesn’t include filesystem management. In order to configure filesystem management for your project, your project will need an Advanced setup. The first guide, [Getting started with configurations](./advanced_config.md) goes through the Advanced setup process" %} @@ -56,11 +56,11 @@ Customizing your schema and templates will allow you to dynamically manage the f ### Enabling a custom entity -**Step 1:** Open your Shotgun site in the browser. Click on your avatar and go to ADMIN > Site Preferences. In the resulting page, expand the **Entities** section. +**Step 1:** Open your {% include product %} site in the browser. Click on your avatar and go to ADMIN > Site Preferences. In the resulting page, expand the **Entities** section. ![Python app](./images/dynamic_filesystem_configuration/1_site_preferences.png) -Displayed is a list of entity types that are available in Shotgun. At the top of the list in the image below are some entity types that are configured for the current Shotgun site. Underneath these entity types are several **Custom Entities** that are not configured or enabled. +Displayed is a list of entity types that are available in {% include product %}. At the top of the list in the image below are some entity types that are configured for the current {% include product %} site. Underneath these entity types are several **Custom Entities** that are not configured or enabled. ### Choose one of the custom entity types, configure it, and enable it. @@ -70,7 +70,7 @@ Displayed is a list of entity types that are available in Shotgun. At the top of ![Python app](./images/dynamic_filesystem_configuration/4_enable_entity.png) -Doing this makes that custom entity active in Shotgun and gives it the display name *Set*. Essentially you are creating an alias for the custom entity because the system name of the entity remains `CustomEntity01`. In this example, we're using `CustomEntity01`; you might use a different custom entity. +Doing this makes that custom entity active in {% include product %} and gives it the display name *Set*. Essentially you are creating an alias for the custom entity because the system name of the entity remains `CustomEntity01`. In this example, we're using `CustomEntity01`; you might use a different custom entity. {% include info title="Note" content="Remember the system name of the custom entity you chose." %} @@ -98,7 +98,7 @@ In **New Field Name**, type “Set”. In the **GENERAL** menu under **Field Typ For this guide, apply it to **Only the current project** and select **Create Field**. -Shotgun will configure the new field. +{% include product %} will configure the new field. ![Python app](./images/dynamic_filesystem_configuration/8_only_current_project.png) @@ -124,7 +124,7 @@ Adding **Dining Room** in the Set field of an asset creates an [association](htt ### Setting up the schema -You’ve now enabled a Set custom entity, created a Set entity called “Dining Room”, and linked an Asset entity to the Dining Room set. You’ve got all the pieces in place in your Shotgun site to now modify your folder structure. When an artist starts working on a task, Toolkit uses the associated Shotgun data to determine what folders to create in the filesystem. New folders are created and named automatically based on the pipeline configuration’s schema. +You’ve now enabled a Set custom entity, created a Set entity called “Dining Room”, and linked an Asset entity to the Dining Room set. You’ve got all the pieces in place in your {% include product %} site to now modify your folder structure. When an artist starts working on a task, Toolkit uses the associated {% include product %} data to determine what folders to create in the filesystem. New folders are created and named automatically based on the pipeline configuration’s schema. Now it’s time to define the folder structure you want Toolkit to dynamically generate as artists step through the production pipeline. This is done by editing the schema. @@ -150,7 +150,7 @@ To achieve this, you would set up the schema like this: `/assets////` -The Set entity is represented as `CustomEntity01`. While we gave CustomEntity01 the *display name* of Set in Shotgun, in our configuration, we’ll always refer to it by its system name, `CustomEntity01`. +The Set entity is represented as `CustomEntity01`. While we gave CustomEntity01 the *display name* of Set in {% include product %}, in our configuration, we’ll always refer to it by its system name, `CustomEntity01`. ### How the schema uses YAML files @@ -158,7 +158,7 @@ A schema can contain static and dynamic folders. If you have a static folder in ### Create the new folder and YAML file for the Set entity -The schema has a `project` folder that contains folders relative to the different entities Shotgun tracks. You are adding the new asset entity, CustomEntity01, to enable Shotgun to track the items in a Set. These items are assets, so you will edit the folders and YAML files under assets. +The schema has a `project` folder that contains folders relative to the different entities {% include product %} tracks. You are adding the new asset entity, CustomEntity01, to enable {% include product %} to track the items in a Set. These items are assets, so you will edit the folders and YAML files under assets. Again, our goal is to go from an `asset_type/asset/step` folder structure to `set/asset_type/asset/step`. So, we’ll want to add a folder to represent set in our schema, with a corresponding YAML file. Since we need to use the system name for custom entities, we’ll be creating the `CustomEntity01/` folder and `CustomEntity01.yml`. @@ -180,7 +180,7 @@ filters: - { "path": "project", "relation": "is", "values": [ "$project" ] } ``` -The YAML file will give the instructions to Toolkit for what to name the `CustomEntity01` folder. In this case, we’re making a folder of type `shotgun_entity`, which means that it corresponds to a Shotgun query. The `entity_type` field tells us to query the `CustomEntity01` entity in Shotgun, and the `name` field tells us which *field* on the entity to query – in this case we’re getting the `code` field from `CustomEntity01`. +The YAML file will give the instructions to Toolkit for what to name the `CustomEntity01` folder. In this case, we’re making a folder of type `{% include product %}_entity`, which means that it corresponds to a {% include product %} query. The `entity_type` field tells us to query the `CustomEntity01` entity in {% include product %}, and the `name` field tells us which *field* on the entity to query – in this case we’re getting the `code` field from `CustomEntity01`. The `filters` field limits the cases in which this dynamic folder should be created. @@ -225,10 +225,10 @@ You’ve now successfully modified your schema to organize assets by a Set custo Folders are created at a few points in Toolkit pipeline workflows: -* **Application launchers**: Every time a user launches a DCC for a task, Toolkit will create the directories for that task if they’re not already there. Since launching a DCC tends to be the first thing someone does with Toolkit, this is the usual way directories get created. This can happen via the right-click menus in Shotgun, or from Shotgun Desktop or Create apps. -* **Shotgun menu**: The most direct way to create folders for a task is to right-click on it in Shotgun and choose the “Create Folders” menu item. -* **Toolkit API**: You can trigger the directory creation logic directly through the Toolkit API. This can be used to plug Toolkit into a custom launcher, or for something like an event trigger for a workflow where you want to automatically create the directories for a Shot as it is created in Shotgun. -* **tank command**: Analogous to the menu item in Shotgun, the `tank folders` terminal command will also create folders for a task. +* **Application launchers**: Every time a user launches a DCC for a task, Toolkit will create the directories for that task if they’re not already there. Since launching a DCC tends to be the first thing someone does with Toolkit, this is the usual way directories get created. This can happen via the right-click menus in {% include product %}, or from {% include product %} Desktop or Create apps. +* **{% include product %} menu**: The most direct way to create folders for a task is to right-click on it in {% include product %} and choose the “Create Folders” menu item. +* **Toolkit API**: You can trigger the directory creation logic directly through the Toolkit API. This can be used to plug Toolkit into a custom launcher, or for something like an event trigger for a workflow where you want to automatically create the directories for a Shot as it is created in {% include product %}. +* **tank command**: Analogous to the menu item in {% include product %}, the `tank folders` terminal command will also create folders for a task. We’ll test with the `tank` command. @@ -274,7 +274,7 @@ Now that we’ve set up our folder structure, the next step is to edit the *temp ### How Toolkit apps use templates -You first created a way to associate an asset with a set in Shotgun by enabling CustomEntity01 to represent sets, then adding a link field to the Asset entity to represent the link between an asset and a set. After establishing the relationship between assets and sets, you set up your folder schema to use that association to place all asset *folders* within a folder for their associated set. Now you’re going to create a way to dynamically name *files* and allow Toolkit Apps to manage the files automatically. +You first created a way to associate an asset with a set in {% include product %} by enabling CustomEntity01 to represent sets, then adding a link field to the Asset entity to represent the link between an asset and a set. After establishing the relationship between assets and sets, you set up your folder schema to use that association to place all asset *folders* within a folder for their associated set. Now you’re going to create a way to dynamically name *files* and allow Toolkit Apps to manage the files automatically. As artists start working on tasks in a project, the necessary folder structure is generated. Then, when they initiate the Workfiles app’s **File Save** action, the file is named automatically. A template accessed through Toolkit’s Workfiles app is used to name that file. Render apps like Nuke Write node and Houdini Mantra node use templates to name and save rendered files, as does the Publisher app for published files. @@ -357,17 +357,17 @@ You’ve now modified `templates.yml` to reflect the new set folder in your prod ### Test it -**Step 18:** Launch Maya from Shotgun Desktop. +**Step 18:** Launch Maya from {% include product %} Desktop. ![Python app](images/dynamic_filesystem_configuration/23_test_file_creation.png) -In Maya, go to **Shotgun > File Open**, and in the resulting dialog, select a task on an asset for which you’ve specified a Set in Shotgun. +In Maya, go to **{% include product %} > File Open**, and in the resulting dialog, select a task on an asset for which you’ve specified a Set in {% include product %}. ![Python app](images/dynamic_filesystem_configuration/24_test_new_file.png) Select **+New File**. -You can create a simple 3D object or just save the file using the **Shotgun > Save File**. +You can create a simple 3D object or just save the file using the **{% include product %} > Save File**. ![Python app](images/dynamic_filesystem_configuration/file_save.png) @@ -375,17 +375,17 @@ Success! Notice the **File Save** dialog box is displaying **Preview: Dining-Room_scene.v001.ma** using the new settings in the template. -The **Work Area**: is displaying **.../Shotgun/projects/the_other_side/assets/Dining-Room/Prop/Filet/model/work/maya** as the path for where Workfiles is saving the file. +The **Work Area**: is displaying **.../{% include product %}/projects/the_other_side/assets/Dining-Room/Prop/Filet/model/work/maya** as the path for where Workfiles is saving the file. ## Advanced topics ### Extending the example -In this example, we modified a single template, but there’s plenty more you can do with your filesystem configuration. In a real world example, you’d likely change *all* asset-related files to have the same file naming conventions. You can make modifications based on other entities (Season, Episode, Level, etc.), create user folders, name your folders based on Shotgun data manipulated with regular expressions, and much more. You can learn about all of Toolkit’s folder and schema options in the [Filesystem Configuration Reference](https://support.shotgunsoftware.com/hc/en-us/articles/219039868). +In this example, we modified a single template, but there’s plenty more you can do with your filesystem configuration. In a real world example, you’d likely change *all* asset-related files to have the same file naming conventions. You can make modifications based on other entities (Season, Episode, Level, etc.), create user folders, name your folders based on {% include product %} data manipulated with regular expressions, and much more. You can learn about all of Toolkit’s folder and schema options in the [Filesystem Configuration Reference](https://support.shotgunsoftware.com/hc/en-us/articles/219039868). ### The Path Cache -At folder creation time, a mapping is created between a folder on disk and a Shotgun entity. These mappings are stored as FilesystemLocation entities in Shotgun, and cached in an SQLite database on user machines. To learn more about how the path cache works and how to work with it, see [this document](../../../quick-answers/administering/what-is-path-cache.md). +At folder creation time, a mapping is created between a folder on disk and a {% include product %} entity. These mappings are stored as FilesystemLocation entities in {% include product %}, and cached in an SQLite database on user machines. To learn more about how the path cache works and how to work with it, see [this document](../../../quick-answers/administering/what-is-path-cache.md). ### Additional Resources diff --git a/docs/en/guides/pipeline-integrations/getting-started/editing_app_setting.md b/docs/en/guides/pipeline-integrations/getting-started/editing_app_setting.md index dcc3ac101..4e3a61a63 100644 --- a/docs/en/guides/pipeline-integrations/getting-started/editing_app_setting.md +++ b/docs/en/guides/pipeline-integrations/getting-started/editing_app_setting.md @@ -16,38 +16,38 @@ After completing this guide, you will have the knowledge fundamental to: This guide describes how to edit settings within an existing Pipeline Configuration to meet the needs of a project pipeline. The first guide, **[Getting started with configurations](./advanced_config.md)**, described how to prepare a pipeline configuration for editing. If you aren’t familiar with how to create an editable configuration for your project, complete **Getting started with configurations** before proceeding. -Through extending the Default Configuration, Shotgun Toolkit allows for customizing tasks within pipeline workflows. An example of a customization might be as simple as enabling or disabling a button in a Toolkit app within one or more software packages, changing the way users interact with Toolkit's features. Toolkit allows proprietary configurations that enable you to work smarter and faster by: creating custom workflows, automating repetitive and mundane tasks, modifying hooks, and even adding custom tools built on the Toolkit platform. Unfortunately, it’s only accessible through Shotgun software integrations, and not yet released for everyday tasks like washing your clothes. +Through extending the Default Configuration, {% include product %} Toolkit allows for customizing tasks within pipeline workflows. An example of a customization might be as simple as enabling or disabling a button in a Toolkit app within one or more software packages, changing the way users interact with Toolkit's features. Toolkit allows proprietary configurations that enable you to work smarter and faster by: creating custom workflows, automating repetitive and mundane tasks, modifying hooks, and even adding custom tools built on the Toolkit platform. Unfortunately, it’s only accessible through {% include product %} software integrations, and not yet released for everyday tasks like washing your clothes. -The exercises in this guide will teach you how to find what configuration settings control actions within the Shotgun software integrations, where the settings live, and how to edit them. Specifically, we will edit a setting in the Workfiles app that manages the behavior of the **+New Task** button, preventing artists from creating a new task when working on a project inside Maya. +The exercises in this guide will teach you how to find what configuration settings control actions within the {% include product %} software integrations, where the settings live, and how to edit them. Specifically, we will edit a setting in the Workfiles app that manages the behavior of the **+New Task** button, preventing artists from creating a new task when working on a project inside Maya. ## Using this document To use this guide and perform an edit on a pipeline configuration, the following is required: -1. An active [Shotgun](https://www.shotgunsoftware.com/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management) site. +1. An active [{% include product %}](https://www.shotgunsoftware.com/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management) site. 2. A project with at least one asset. You can add an asset to the_other_side project you created in the first guide. You can review how to create an asset for a project in the [Getting started with configurations](./advanced_config.md) guide. 3. A pipeline configuration for the identified project, or complete the [Getting started with configurations](./advanced_config.md) guide and use the configuration created in that exercise. 4. Read and write permissions set appropriately for the filesystem where the Pipeline Configuration is stored. -5. Shotgun Desktop installed on your system. +5. {% include product %} Desktop installed on your system. 6. An active subscription for Maya. Get a 30 day trial of Maya [here](https://www.autodesk.com/products/maya/free-trial-dts?adobe_mc_ref=https%3A%2F%2Fwww.google.com%2F&adobe_mc_sdid=SDID%3D577C0A84DDF5D35D-50E96EA2052056FE%7CMCORGID%3D6DC7655351E5696B0A490D44%2540AdobeOrg%7CTS%3D1543444689) {% include info title="Note" content="This guide is based on the `tk-config-default2` pipeline configuration. If your config was modified, the location of files, folders, and blocks of YAML settings may vary from what is described here." %} ## About the Workfiles app -The Workfiles app governs file management in a Shotgun software integration and controls access to functionality for browsing, opening, and saving work files. The **+New Task** button is an action of the Workfiles app that allows a user to add a task without having to go to Shotgun to do so. The configuration is broken down into per-environment files. This allows you to manage functionality relative to different stages in the pipeline, controlling when a user can create, name and save files, execute tasks, or perform certain functions. This is relevant for all the functions in the Workfiles app and it also applies to modifying settings for any app or engine. Find more details in the [Advanced Topics](#advanced-topics) at the end of this document. +The Workfiles app governs file management in a {% include product %} software integration and controls access to functionality for browsing, opening, and saving work files. The **+New Task** button is an action of the Workfiles app that allows a user to add a task without having to go to {% include product %} to do so. The configuration is broken down into per-environment files. This allows you to manage functionality relative to different stages in the pipeline, controlling when a user can create, name and save files, execute tasks, or perform certain functions. This is relevant for all the functions in the Workfiles app and it also applies to modifying settings for any app or engine. Find more details in the [Advanced Topics](#advanced-topics) at the end of this document. ## Getting familiar with the configuration files -Use the Pipeline Configuration List in Shotgun to locate where the pipeline configuration is stored for the project you’re working with. If you know where it’s stored, you can skip to Step 5. +Use the Pipeline Configuration List in {% include product %} to locate where the pipeline configuration is stored for the project you’re working with. If you know where it’s stored, you can skip to Step 5. ## Finding the pipeline configuration -**Step 1:** Open the **Shotgun site** that manages the project you will be using for this exercise. +**Step 1:** Open the **{% include product %} site** that manages the project you will be using for this exercise. -**Step 2:** Access the project from the **Shotgun site** by selecting it from the **Projects page**. +**Step 2:** Access the project from the **{% include product %} site** by selecting it from the **Projects page**. -![Shotgun project](./images/editing_app_setting/1_shotgun_project.png) +![{% include product %} project](./images/editing_app_setting/1_shotgun_project.png) **Step 3:** Select the **avatar** in the upper right to display the **ADMIN** menu and scroll down to select **Default Layouts > Pipeline Configuration > Pipeline Configuration List**. @@ -75,23 +75,23 @@ Toolkit uses YAML files to configure functionality. YAML was chosen as the langu ## Editing the configuration file -Shotgun Toolkit allows alterations to the apps that are integrated within various software packages. One of the functions of the Workfiles app is the **+New Task** button, which allows a user to add a new task in the **File Open** dialog box. By default, this function is enabled for every user at every phase of a project. But a studio might want to restrict this functionality – say, if they have a specific naming convention, or want to limit task creation to a project's production management team. In this case, they would disable the **+New Task** button for all the points in a pipeline where artists will be working in Maya. +{% include product %} Toolkit allows alterations to the apps that are integrated within various software packages. One of the functions of the Workfiles app is the **+New Task** button, which allows a user to add a new task in the **File Open** dialog box. By default, this function is enabled for every user at every phase of a project. But a studio might want to restrict this functionality – say, if they have a specific naming convention, or want to limit task creation to a project's production management team. In this case, they would disable the **+New Task** button for all the points in a pipeline where artists will be working in Maya. ## Disabling the +New Task button for projects in Maya -**Step 7:** Open **Shotgun Desktop**. +**Step 7:** Open **{% include product %} Desktop**. **Step 8:** Select the project whose configuration you are going to edit. ![Load project](./images/editing_app_setting/6_load_project.png) -**Step 9:** Launch Maya from Shotgun Desktop. +**Step 9:** Launch Maya from {% include product %} Desktop. ![Load project](./images/editing_app_setting/7_view_project.png) -Wait for the **Shotgun** menu to fully load. If you have a slow internet connection, this would be the time to run the configuration that makes you that perfect shot of espresso with just the right amount of crema. +Wait for the **{% include product %}** menu to fully load. If you have a slow internet connection, this would be the time to run the configuration that makes you that perfect shot of espresso with just the right amount of crema. -Once Maya and Shotgun are fully loaded, the **File Open** dialog box will open automatically. When you launch Maya from Shotgun Desktop, you will enter Maya in the **project** environment; the configuration of your Toolkit workflows will be driven by the file `config/env/project.yml`. The environments that are identified in the Default Configuration are `project`, `sequence`, `shot`, `shot_step`, `asset`, `asset_step`. +Once Maya and {% include product %} are fully loaded, the **File Open** dialog box will open automatically. When you launch Maya from {% include product %} Desktop, you will enter Maya in the **project** environment; the configuration of your Toolkit workflows will be driven by the file `config/env/project.yml`. The environments that are identified in the Default Configuration are `project`, `sequence`, `shot`, `shot_step`, `asset`, `asset_step`. **Step 10:** Select the **Assets** tab in the left pane of the **File Open** dialog box. Select any asset inside the folder displayed in the search results. @@ -101,11 +101,11 @@ The **+New Task** button is enabled. ## Find what setting controls the +New Task button -Toolkit pipeline configurations are used to customize environments to meet your pipeline's needs. A pipeline configuration can override default Shotgun integration settings, varying as much or as little as necessary to meet the needs of a project’s pipeline. This structure allows configurations to be lightweight, adding only the settings that are different from the default values in the Shotgun core code. In this exercise, we want to turn off the Workfiles app's **+New Task** button, but before we can do so, we need to figure out which configuration setting controls it. +Toolkit pipeline configurations are used to customize environments to meet your pipeline's needs. A pipeline configuration can override default {% include product %} integration settings, varying as much or as little as necessary to meet the needs of a project’s pipeline. This structure allows configurations to be lightweight, adding only the settings that are different from the default values in the {% include product %} core code. In this exercise, we want to turn off the Workfiles app's **+New Task** button, but before we can do so, we need to figure out which configuration setting controls it. **Step 11:** Select the **>** at the top right of the **File Open** window next to **Project (name of project)**. -This reference box shows details about the configuration settings that control the functions of the **File Open** window. Some apps in Toolkit have a reference box to show what settings are used for the app and what the default settings are. Notice the **Location:**: identifier is **tk-multi-workfiles2**. This is the identifier for the bundle of code that creates the Workfiles app. When searching a pipeline configuration this name will identify where the settings live for the app. There’s an [Apps and Engines page](https://support.shotgunsoftware.com/hc/en-us/articles/219039798-Integrations-Apps-and-Engines) that lists all the configuration settings, apps, and engines for what’s available in a Shotgun Integration. +This reference box shows details about the configuration settings that control the functions of the **File Open** window. Some apps in Toolkit have a reference box to show what settings are used for the app and what the default settings are. Notice the **Location:**: identifier is **tk-multi-workfiles2**. This is the identifier for the bundle of code that creates the Workfiles app. When searching a pipeline configuration this name will identify where the settings live for the app. There’s an [Apps and Engines page](https://support.shotgunsoftware.com/hc/en-us/articles/219039798-Integrations-Apps-and-Engines) that lists all the configuration settings, apps, and engines for what’s available in a {% include product %} Integration. ![Current_work_area](./images/editing_app_setting/9_current_work_area.png) @@ -135,13 +135,13 @@ A setting can be utilized in multiple places within a pipeline configuration. Wh **Step 12:** Bring the main Maya window forward. -**Step 13:** Find the **Shotgun** menu item in the upper right of the Maya window. +**Step 13:** Find the **{% include product %}** menu item in the upper right of the Maya window. -![Maya shotgun2](./images/editing_app_setting/12_Maya_Shotgun2.png) +![Maya {% include product %}2](./images/editing_app_setting/12_Maya_Shotgun2.png) -**TIP:** If the menu isn’t visible there will be **>>** to show that some menu items are hidden. Select the **>>** to display the Shotgun menu or you can widen the Maya window. +**TIP:** If the menu isn’t visible there will be **>>** to show that some menu items are hidden. Select the **>>** to display the {% include product %} menu or you can widen the Maya window. -**Step 14:** Select **Shotgun > Project the_other_side > Work Area Info…** on the top right of the menu. +**Step 14:** Select **{% include product %} > Project the_other_side > Work Area Info…** on the top right of the menu. ![Work area info](./images/editing_app_setting/13_work_area_info.png) @@ -149,7 +149,7 @@ The **Work Area Info** dialog box shows what’s under the hood and details abou **Step 15:** In the **Your Current Work Area** dialog box, select the **Environment** tab at the bottom. -The first item identifies the engine being used. The engine is what drives the ability to have the Shotgun tools integrated within a specific software application. It holds the logic specific to each software integration. The second item displayed in the window shows the path where the current project environment is located. +The first item identifies the engine being used. The engine is what drives the ability to have the {% include product %} tools integrated within a specific software application. It holds the logic specific to each software integration. The second item displayed in the window shows the path where the current project environment is located. ![Work area info environment](./images/editing_app_setting/14_shotgun_work_area_info_Environment.png) @@ -219,7 +219,7 @@ The `settings` and `project` reference indicate it’s a project’s settings. T This complete line tells us to look for the `settings.tk-maya.project` block in the included file to find the configuration settings for the Maya engine, `tk-maya`. -Shotgun Toolkit uses simple terms in the YAML files to indicate the names of the settings and what paths will lead you to them. You already know from looking in the Maya **File Open** reference box that the bundle of code which controls how the **+New Task** button performs, is identified by `tk-multi-workfiles2`. Toolkit bundles are referenced in the YAML files using these identifiers. ‘tk-multi-workfiles2’ is the identifier for the Workfiles app code bundle, and the **+New Task** button is a function of the Workfiles app. +{% include product %} Toolkit uses simple terms in the YAML files to indicate the names of the settings and what paths will lead you to them. You already know from looking in the Maya **File Open** reference box that the bundle of code which controls how the **+New Task** button performs, is identified by `tk-multi-workfiles2`. Toolkit bundles are referenced in the YAML files using these identifiers. ‘tk-multi-workfiles2’ is the identifier for the Workfiles app code bundle, and the **+New Task** button is a function of the Workfiles app. Looking for the Workfiles App settings in tk-maya.yml @@ -318,7 +318,7 @@ By selecting **+New File**, you began to work on a new asset and the `asset_step ## Discover what environment you are working in -**Step 26:** In the upper right of the Maya menu select **Shotgun**. +**Step 26:** In the upper right of the Maya menu select **{% include product %}**. ![Art asset env](./images/editing_app_setting/23_Art_Asset.png) @@ -334,7 +334,7 @@ Each environment will display the information necessary to determine where the s NOTE: Each environment is independent, a project has a dedicated configuration, and the software integrations only read settings for their specific software from the pipeline configuration when a project is loaded. -You've now edited your pipeline configuration, making a change to the settings for an app. And now the real fun begins: learning all the things you can do with Shotgun Toolkit environments. Here are some advanced topics to explore. +You've now edited your pipeline configuration, making a change to the settings for an app. And now the real fun begins: learning all the things you can do with {% include product %} Toolkit environments. Here are some advanced topics to explore. ## Advanced topics diff --git a/docs/en/guides/pipeline-integrations/getting-started/installing_app.md b/docs/en/guides/pipeline-integrations/getting-started/installing_app.md index 1eaccfb60..b90e8eb7d 100644 --- a/docs/en/guides/pipeline-integrations/getting-started/installing_app.md +++ b/docs/en/guides/pipeline-integrations/getting-started/installing_app.md @@ -16,9 +16,9 @@ By completing this guide, you will quickly become acquainted with the configurat ## About the guide -This guide will demonstrate how to add a Shotgun Toolkit app to an existing pipeline configuration. You will quickly become acquainted with the configuration management tools. +This guide will demonstrate how to add a {% include product %} Toolkit app to an existing pipeline configuration. You will quickly become acquainted with the configuration management tools. -The app we will be adding is the Shotgun Python Console app. Maya has its own Python console, but there are some features in the Toolkit app that don’t exist in the Maya console. +The app we will be adding is the {% include product %} Python Console app. Maya has its own Python console, but there are some features in the Toolkit app that don’t exist in the Maya console. This guide utilizes the pipeline configuration we created in the [Editing a Pipeline Configuration](./editing_app_setting.md) guide. If you haven’t completed this guide, you can use an existing pipeline configuration and add the app there. @@ -26,36 +26,36 @@ This guide utilizes the pipeline configuration we created in the [Editing a Pipe To use this guide and install a Toolkit app, the following is required: -1. An active [Shotgun](https://www.shotgunsoftware.com/signup/) site. +1. An active [{% include product %}](https://www.shotgunsoftware.com/signup/) site. 2. A pipeline configuration for the identified project, or complete the [Getting Started with Configurations guide](./advanced_config.md) and use the configuration created in that exercise. 3. Read and write permissions set appropriately for the filesystem where the pipeline configuration is stored. -4. Shotgun Desktop installed on your system. +4. {% include product %} Desktop installed on your system. 5. An active subscription for Maya. Get a 30 day trial of Maya [here](https://www.autodesk.com/products/maya/free-trial-dts). {% include info title="Note" content="This guide is based on the tk-config-default2 pipeline configuration. If your config was modified, the location of files, folders, and blocks of YAML settings may vary from what is described here." %} -## About Shotgun Toolkit apps +## About {% include product %} Toolkit apps ### How Toolkit apps work -Apps that are referenced in pipeline configurations can be sourced from various locations. The apps that are standard in the Default Configuration are sourced from the Shotgun App Store. The files in a pipeline configuration specify how Shotgun integrations access an app, kind of like asking Toolkit, “Can you look in your little black book for the address of the Python Console App?” The pipeline configuration files tell Toolkit where to find the bundles of code that are utilized for a specific app. +Apps that are referenced in pipeline configurations can be sourced from various locations. The apps that are standard in the Default Configuration are sourced from the {% include product %} App Store. The files in a pipeline configuration specify how {% include product %} integrations access an app, kind of like asking Toolkit, “Can you look in your little black book for the address of the Python Console App?” The pipeline configuration files tell Toolkit where to find the bundles of code that are utilized for a specific app. -The “addresses” for Toolkit Apps are listed in the `config/env/includes/app_locations.yml` file in the Default Configuration and specify how to find the code. These “addresses” are called [descriptors](https://developer.shotgunsoftware.com/tk-core/descriptor.html). The Shotgun integrations need to be told not only how to find the code bundles for the app, but also in what environment(s) to use the app. +The “addresses” for Toolkit Apps are listed in the `config/env/includes/app_locations.yml` file in the Default Configuration and specify how to find the code. These “addresses” are called [descriptors](https://developer.shotgunsoftware.com/tk-core/descriptor.html). The {% include product %} integrations need to be told not only how to find the code bundles for the app, but also in what environment(s) to use the app. -Below is a conceptual overview of how to install an app and how to tell a Shotgun integration where to use it. It outlines the steps for extending the configuration, asking Toolkit to look up a descriptor, and telling Shotgun where to use the app. These steps are detailed in this guide: +Below is a conceptual overview of how to install an app and how to tell a {% include product %} integration where to use it. It outlines the steps for extending the configuration, asking Toolkit to look up a descriptor, and telling {% include product %} where to use the app. These steps are detailed in this guide: 1. Determine the descriptor for the app you want to add. 2. Make a copy of the active pipeline configuration you want to add the app descriptor to. 3. See if the app’s descriptor exists in the configuration and if not, add it. 4. Format the YAML file correctly using spaces and not tabs for indents. 5. Determine in what environment(s) the app is to be used. -6. Within those environment(s), add the setting that will allow Shotgun to use the app. +6. Within those environment(s), add the setting that will allow {% include product %} to use the app. 7. Test the new configuration. 8. Push the extended configuration live. ### Find the location descriptor for the Python Console App -**Step 1:** Open the [Apps and Engines page](https://support.shotgunsoftware.com/hc/en-us/articles/219039798-Applications-that-Toolkit-Integrates-with#tk-maya) and find the information for the Shotgun Python Console under Maya. Select the title. +**Step 1:** Open the [Apps and Engines page](https://support.shotgunsoftware.com/hc/en-us/articles/219039798-Applications-that-Toolkit-Integrates-with#tk-maya) and find the information for the {% include product %} Python Console under Maya. Select the title. ![Python app](./images/installing_app/1_python_app.png) @@ -67,7 +67,7 @@ The **System Name** is the main identifier: `tk-multi-pythonconsole`. You will a ### Confirm that there’s no Python Console app in the Project environment in Maya -**Step 2:** Launch Maya and select the Shotgun Menu, **Shotgun > Project the_other_side** and you will see the list of apps that are available for that project in the Project environment. +**Step 2:** Launch Maya and select the {% include product %} Menu, **{% include product %} > Project the_other_side** and you will see the list of apps that are available for that project in the Project environment. ![List of apps](./images/installing_app/3_list_of_apps.png) @@ -81,11 +81,11 @@ Cloning a pipeline configuration automates the process of creating a copy, build ### Go to the Pipeline Configuration list. -**Step 3:** Open Shotgun and in the upper right, select the **Admin Menu (your avatar) > Default Layouts > Pipeline Configuration > Pipeline Configuration List**. +**Step 3:** Open {% include product %} and in the upper right, select the **Admin Menu (your avatar) > Default Layouts > Pipeline Configuration > Pipeline Configuration List**. ![Pipeline configuration list](./images/installing_app/4_REPLACE_pipeline_configuration_list.png) -This action displays a detailed list of all of your Shotgun site's pipeline configurations. +This action displays a detailed list of all of your {% include product %} site's pipeline configurations. **Step 4:** Once the Pipeline Configuration List is displayed, select the **+** sign on the far right of the column headers, and add the column **Projects**. @@ -109,7 +109,7 @@ This displays the paths to the configuration files. ![Name clone](./images/installing_app/9_name_clone.png) -Wait while Shotgun copies all of the files and folders in the configuration and creates a cache for the apps. Now would be an opportune time to use an app that makes you a light, fluffy, melt in your mouth croissant to go with that perfect shot of espresso. +Wait while {% include product %} copies all of the files and folders in the configuration and creates a cache for the apps. Now would be an opportune time to use an app that makes you a light, fluffy, melt in your mouth croissant to go with that perfect shot of espresso. ![Clone Complete](./images/installing_app/10_clone_complete.png) @@ -119,11 +119,11 @@ When completed, the Configuration List will be updated with information about th ## Associate the cloned configuration with the project -**Step 8:** Open Shotgun Desktop and select the project you created the cloned configuration for. Select the **down arrow** in the upper right to display the configurations associated with this project and select the **Primary Clone Config 2** that you just created. +**Step 8:** Open {% include product %} Desktop and select the project you created the cloned configuration for. Select the **down arrow** in the upper right to display the configurations associated with this project and select the **Primary Clone Config 2** that you just created. ![Select clone](./images/installing_app/11_select_clone.png) -Shotgun Desktop is now using the cloned config for this project. +{% include product %} Desktop is now using the cloned config for this project. ## Edit the Pipeline Configuration @@ -181,7 +181,7 @@ The `tk-maya: “@settings.tk-maya.project”` line using the `@settings` tells ### YAML files -The Shotgun Toolkit pipeline configuration uses simple terms in [YAML](https://yaml.org/spec/1.2/spec.html) files to identify the location of apps and engines, as well as their settings. +The {% include product %} Toolkit pipeline configuration uses simple terms in [YAML](https://yaml.org/spec/1.2/spec.html) files to identify the location of apps and engines, as well as their settings. For this specific block: @@ -190,11 +190,11 @@ For this specific block: * `tk-maya` is the identifier for Toolkit's engine for Maya * `@` is a Toolkit term used to denote that a setting value is coming from an included file -The YAML files are the windows into Shotgun’s integrations and make it easier to configure working environments that meet the needs of your pipeline. +The YAML files are the windows into {% include product %}’s integrations and make it easier to configure working environments that meet the needs of your pipeline. ### How the configuration references Toolkit bundles -The code for Shotgun’s integrations is organized into bundles for apps, engines, and frameworks. The bundles are referenced in Toolkit’s YAML files using identifiers like `tk-maya`, `tk-multi-pythonconsole`, etc. Each bundle's corresponding block of YAML contains settings that control how the identified bundle is accessed and utilized. +The code for {% include product %}’s integrations is organized into bundles for apps, engines, and frameworks. The bundles are referenced in Toolkit’s YAML files using identifiers like `tk-maya`, `tk-multi-pythonconsole`, etc. Each bundle's corresponding block of YAML contains settings that control how the identified bundle is accessed and utilized. ## Where to put settings for the Python Console @@ -232,7 +232,7 @@ settings.tk-maya.project: tk-multi-workfiles2: "@settings.tk-multi-workfiles2.launch_at_startup" ``` -You will notice the **Screening Room, Shotgun Panel, and Workfiles2** app’s location identifiers are listed in a different included file and accessed differently than the **About** app. To keep things tidy, these apps were split off to the included settings folder because they have additional settings. +You will notice the **Screening Room, {% include product %} Panel, and Workfiles2** app’s location identifiers are listed in a different included file and accessed differently than the **About** app. To keep things tidy, these apps were split off to the included settings folder because they have additional settings. {% include info title="Note" content="The python console app already exists in the Default Configuration, however if you are adding an app that has never been added to your configuration before or if you have changed the version of an app, and you are using a [centralized configuration](https://developer.shotgunsoftware.com/tk-core/initializing.html#centralized-configurations), then there is an additional step you need to take. Open your terminal and browse to where your cloned configuration is stored. From your cloned configuration’s root folder, run the following command:
@@ -248,7 +248,7 @@ This will scan your configuration for apps, engines and frameworks and ensure th ## View the changes in Maya -**Step 16:** Open Shotgun Desktop, select the project you were working with, and confirm you are using the cloned configuration. +**Step 16:** Open {% include product %} Desktop, select the project you were working with, and confirm you are using the cloned configuration. There will be a blue bar with the name of the clone that you created under the name of the project. @@ -256,7 +256,7 @@ There will be a blue bar with the name of the clone that you created under the n ![Maya cloned config](./images/installing_app/14_maya_cloned_config.png) -**Step 17:** Launch Maya from Desktop and select the menu **Shotgun > Project > …** +**Step 17:** Launch Maya from Desktop and select the menu **{% include product %} > Project > …** If: @@ -264,7 +264,7 @@ If: * The cloned configuration was extended correctly * You saved the extended files * You chose to associate the project with the cloned configuration -* You relaunched Maya from Shotgun Desktop +* You relaunched Maya from {% include product %} Desktop The Python Console app will be available in Maya. @@ -328,7 +328,7 @@ There will be a list of the available pipeline configurations that the cloned co ![ID column](./images/installing_app/17_id_column.png) -After you enter the ID, Shotgun will: +After you enter the ID, {% include product %} will: * Backup the Primary configuration * Copy the cloned configuration @@ -348,11 +348,11 @@ Push Complete! ## View the changes you made in the primary configuration -**Step 19:** In Shotgun Desktop, click on the arrow in the upper right and choose **Primary** in the **CONFIGURATION** list. +**Step 19:** In {% include product %} Desktop, click on the arrow in the upper right and choose **Primary** in the **CONFIGURATION** list. ![Change config maya](./images/installing_app/18_change_config_maya.png) -**Step 20:** Launch Maya from Desktop and look in the menu **Shotgun > Project > …** to find the Shotgun Python Console... +**Step 20:** Launch Maya from Desktop and look in the menu **{% include product %} > Project > …** to find the {% include product %} Python Console... ![App in Maya](./images/installing_app/19_app_in_maya.png) @@ -360,15 +360,15 @@ The Python Console app was added to the Project environment for the chosen proje ## Advanced topics -### The Shotgun developer community +### The {% include product %} developer community -One of the wonderful things about Toolkit is that anyone can create a Toolkit app. Apps can be kept proprietary, or they can be shared within the [Shotgun community](https://support.shotgunsoftware.com/hc/en-us/articles/219039828), adding to the Shotgun arsenal. If you’ve created a really stellar app you want share on the Shotgun community page, email us at [support@shotgunsoftware.com](mailto:support@shotgunsoftware.com). +One of the wonderful things about Toolkit is that anyone can create a Toolkit app. Apps can be kept proprietary, or they can be shared within the [{% include product %} community](https://support.shotgunsoftware.com/hc/en-us/articles/219039828), adding to the {% include product %} arsenal. If you’ve created a really stellar app you want share on the {% include product %} community page, email us at [support@shotgunsoftware.com](mailto:support@shotgunsoftware.com). -Standard Toolkit apps and apps created by the loving Shotgun community are actively discussed in the **[shotgun-dev Google group](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups#!forum/shotgun-dev)**. The knowledge and tool base continues to grow as the Shotgun community adds their contributions. +Standard Toolkit apps and apps created by the loving {% include product %} community are actively discussed in the **[{% include product %}-dev Google group](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups#!forum/shotgun-dev)**. The knowledge and tool base continues to grow as the {% include product %} community adds their contributions. ### Investigate how to extend a configuration -You may have noticed when we were selecting which configuration to use for the project, the Python Console App was available in the Shotgun Desktop dropdown. +You may have noticed when we were selecting which configuration to use for the project, the Python Console App was available in the {% include product %} Desktop dropdown. ![Desktop python console](./images/installing_app/20_desktop_python_console.png) diff --git a/docs/en/guides/pipeline-integrations/getting_started.md b/docs/en/guides/pipeline-integrations/getting_started.md index 254306759..d847cbd4b 100644 --- a/docs/en/guides/pipeline-integrations/getting_started.md +++ b/docs/en/guides/pipeline-integrations/getting_started.md @@ -7,4 +7,4 @@ lang: en # Getting Started -Shotgun Toolkit provides a set of highly customizable tools for creating studio pipelines where artists can access info from Shotgun and share their work with each other, without ever leaving their content creation software. These guides are designed to get you started with setting up your custom Toolkit pipeline via hands-on exercises: you'll use the Shotgun Desktop app to generate an editable configuration for your project, modify settings on existing apps, and even add Toolkit apps to different artist environments, getting you on the path to designing your custom pipeline. Each guide builds on the ones before it, but they include instructions for jumping in from anywhere. +{% include product %} Toolkit provides a set of highly customizable tools for creating studio pipelines where artists can access info from {% include product %} and share their work with each other, without ever leaving their content creation software. These guides are designed to get you started with setting up your custom Toolkit pipeline via hands-on exercises: you'll use the {% include product %} Desktop app to generate an editable configuration for your project, modify settings on existing apps, and even add Toolkit apps to different artist environments, getting you on the path to designing your custom pipeline. Each guide builds on the ones before it, but they include instructions for jumping in from anywhere. diff --git a/docs/en/guides/pipeline-integrations/workflows.md b/docs/en/guides/pipeline-integrations/workflows.md index 81145f34f..feebb0757 100644 --- a/docs/en/guides/pipeline-integrations/workflows.md +++ b/docs/en/guides/pipeline-integrations/workflows.md @@ -7,6 +7,6 @@ lang: en # Workflows -The customizations in Shotgun's pipeline integrations allow you to use the tools to create a variety of workflows: from feature animation to episodic workflows, from visual effects to games. +The customizations in {% include product %}'s pipeline integrations allow you to use the tools to create a variety of workflows: from feature animation to episodic workflows, from visual effects to games. This section contains resources for building specific workflows. diff --git a/docs/en/guides/pipeline-integrations/workflows/pipeline-tutorial.md b/docs/en/guides/pipeline-integrations/workflows/pipeline-tutorial.md index 0fae5ce01..732a97349 100644 --- a/docs/en/guides/pipeline-integrations/workflows/pipeline-tutorial.md +++ b/docs/en/guides/pipeline-integrations/workflows/pipeline-tutorial.md @@ -9,7 +9,7 @@ lang: en This tutorial covers building a simplified, yet typical, pipeline for animation or visual effects production. By following this tutorial you will build a pipeline that provides all of the pieces necessary to push Assets from modeling through look development, and then into and through a production scene. -Much of the workflows covered in this pipeline work out-of-the-box with Shotgun's built-in integrations. For the portions of the pipeline where studios are more often building custom solutions the tutorial will walk you through the process of customizing the artists workflow using the Toolkit platform. +Much of the workflows covered in this pipeline work out-of-the-box with {% include product %}'s built-in integrations. For the portions of the pipeline where studios are more often building custom solutions the tutorial will walk you through the process of customizing the artists workflow using the Toolkit platform. Here is a high level view of the pipeline you will build in this tutorial: @@ -23,21 +23,21 @@ For simplicity, the digital content creation (DCC) software used will be kept to ## Prerequisites -* **A working Shotgun Project** - This tutorial assumes you have experience using Shotgun for tracking and managing production data. +* **A working {% include product %} Project** - This tutorial assumes you have experience using {% include product %} for tracking and managing production data. -* **Understanding of Shotgun Integrations** - Shotgun ships with integrations that provide some simple production workflows without requiring any manual configuration. You should understand the features and scope of these workflows before diving into the manual configuration and customizations outlined in this tutorial. More information about Shotgun Integrations can be found [here](https://support.shotgunsoftware.com/hc/en-us/articles/115000068574). +* **Understanding of {% include product %} Integrations** - {% include product %} ships with integrations that provide some simple production workflows without requiring any manual configuration. You should understand the features and scope of these workflows before diving into the manual configuration and customizations outlined in this tutorial. More information about {% include product %} Integrations can be found [here](https://support.shotgunsoftware.com/hc/en-us/articles/115000068574). -* **Maya & Nuke Experience** - This tutorial is designed to build a simple pipeline using Maya and Nuke. You should have a basic understanding of these packages in order to customize the integrations provided by Shotgun. +* **Maya & Nuke Experience** - This tutorial is designed to build a simple pipeline using Maya and Nuke. You should have a basic understanding of these packages in order to customize the integrations provided by {% include product %}. -* **Working knowledge of Python** - The tutorial requires modifying the functionality of Shotgun integrations via "hooks" that are written in Python. +* **Working knowledge of Python** - The tutorial requires modifying the functionality of {% include product %} integrations via "hooks" that are written in Python. * **Familiarity with YAML** - Much of the configuration of the pipeline you will be building is handled by modifying YAML files. ## Additional Resources -* [Shotgun Support Site](https://support.shotgunsoftware.com) +* [{% include product %} Support Site](https://support.shotgunsoftware.com) -* [Shotgun Integrations](https://www.shotgunsoftware.com/integrations/) +* [{% include product %} Integrations](https://www.shotgunsoftware.com/integrations/) * [User Guide](https://support.shotgunsoftware.com/hc/en-us/articles/115000068574) @@ -47,7 +47,7 @@ For simplicity, the digital content creation (DCC) software used will be kept to # Project Creation & Setup -For this Tutorial, you will need to create a new project in Shotgun and configure it as if you were preparing for production to begin. This includes ensuring all of the necessary Shotgun entities are in place and linked up properly. For this tutorial, the Asset, Sequence, Shot, and Task entities are required and should be available by default in a new project. You will create: +For this Tutorial, you will need to create a new project in {% include product %} and configure it as if you were preparing for production to begin. This includes ensuring all of the necessary {% include product %} entities are in place and linked up properly. For this tutorial, the Asset, Sequence, Shot, and Task entities are required and should be available by default in a new project. You will create: * Two **Assets**: @@ -61,7 +61,7 @@ For this Tutorial, you will need to create a new project in Shotgun and configur * A **Task** per pipeline step -Here are some screenshots of what your configured project entities should look like in Shotgun: +Here are some screenshots of what your configured project entities should look like in {% include product %}: {% include figure src="./images/tutorial/image_1.png" caption="Teapot and Table Assets" %} @@ -71,25 +71,25 @@ Here are some screenshots of what your configured project entities should look l ## Software Launchers -Next, you'll need to ensure that Maya and Nuke are available to launch in Shotgun Desktop. In Desktop, make sure that each of these packages can be launched by clicking on their icon. Be sure that the proper version of each package is launched. +Next, you'll need to ensure that Maya and Nuke are available to launch in {% include product %} Desktop. In Desktop, make sure that each of these packages can be launched by clicking on their icon. Be sure that the proper version of each package is launched. -If either application does not show up in Desktop or the expected version does not launch, you may need to manually configure the launch in Shotgun via the Software entity. +If either application does not show up in Desktop or the expected version does not launch, you may need to manually configure the launch in {% include product %} via the Software entity. {% include figure src="./images/tutorial/image_4.png" caption="The default Software entities defined in Shotgun" %} -The Software entity is used to drive which DCC packages to use on your production. By default, the integrations will search for these packages in standard installation locations and make them launchable via Desktop. If you have more than one version installed or you have them installed in a non-standard location, it is possible you need to update the corresponding Software entity entry in Shotgun to curate the launch experience for your artists. +The Software entity is used to drive which DCC packages to use on your production. By default, the integrations will search for these packages in standard installation locations and make them launchable via Desktop. If you have more than one version installed or you have them installed in a non-standard location, it is possible you need to update the corresponding Software entity entry in {% include product %} to curate the launch experience for your artists. For complete details on the Software entity and how to properly configure it, please see the [Integrations Admin Guide](https://support.shotgunsoftware.com/hc/en-us/articles/115000067493-Integrations-Admin-Guide#Configuring%20software%20launches). Once you have your DCCs launching the way you expect, you can continue to the next section. # Configuration -The configuration (config) defines the artist workflow for your project. This includes specifying which Shotgun integrations to include within the DCCs your artists are launching, how your project's folder structure is defined, and the naming conventions for files and folders created as artists share data. +The configuration (config) defines the artist workflow for your project. This includes specifying which {% include product %} integrations to include within the DCCs your artists are launching, how your project's folder structure is defined, and the naming conventions for files and folders created as artists share data. -By default, all new projects are configured to use the basic [Shotgun Integrations](https://support.shotgunsoftware.com/hc/en-us/articles/115000068574) which provide a basic workflow for sharing files between artists using many off-the-shelf software packages. The following sections outline how to take over your project's pipeline configuration (config) and customize it for your studio. +By default, all new projects are configured to use the basic [{% include product %} Integrations](https://support.shotgunsoftware.com/hc/en-us/articles/115000068574) which provide a basic workflow for sharing files between artists using many off-the-shelf software packages. The following sections outline how to take over your project's pipeline configuration (config) and customize it for your studio. ## Taking Over the Project Config -Use Shotgun Desktop (Desktop) to take over your project's configuration. RMB click within Desktop or click the user icon in the bottom right to show the popup menu. Select the **Advanced project setup…** option and follow the wizard to locally install your project configuration. The images below show the required steps. You can also follow the steps outlined in the Integrations Admin Guide for [Taking over a Pipeline Configuration](https://support.shotgunsoftware.com/hc/en-us/articles/115000067493-Integrations-Admin-Guide#Taking%20over%20a%20Pipeline%20Configuration). +Use {% include product %} Desktop (Desktop) to take over your project's configuration. RMB click within Desktop or click the user icon in the bottom right to show the popup menu. Select the **Advanced project setup…** option and follow the wizard to locally install your project configuration. The images below show the required steps. You can also follow the steps outlined in the Integrations Admin Guide for [Taking over a Pipeline Configuration](https://support.shotgunsoftware.com/hc/en-us/articles/115000067493-Integrations-Admin-Guide#Taking%20over%20a%20Pipeline%20Configuration). {% include figure src="./images/tutorial/image_5.png" caption="Select the **Advanced project setup…** in the Desktop popup menu" %} @@ -97,7 +97,7 @@ Use Shotgun Desktop (Desktop) to take over your project's configuration. RMB cli {% include figure src="./images/tutorial/wizard_02.png" caption="Choose the **Default configuration**" %} -If this is your first time setting up a Shotgun project, you'll also be prompted to define a storage location for your project data. Otherwise, you can select an existing storage location. +If this is your first time setting up a {% include product %} project, you'll also be prompted to define a storage location for your project data. Otherwise, you can select an existing storage location. {% include figure src="./images/tutorial/wizard_03.png" caption="Create a new storage." %} @@ -105,7 +105,7 @@ If this is your first time setting up a Shotgun project, you'll also be prompted {% include figure src="./images/tutorial/wizard_05.png" caption="Set the path(s) where this storage will be accessible on the operating systems you intend to use." %} -You can view and edit the storages for your shotgun site in your **Site Preferences**, under the **File Management** section. You can learn more about these settings [here](https://support.shotgunsoftware.com/hc/en-us/articles/219030938). +You can view and edit the storages for your {% include product %} site in your **Site Preferences**, under the **File Management** section. You can learn more about these settings [here](https://support.shotgunsoftware.com/hc/en-us/articles/219030938). Now that you have a storage location selected, you'll choose the name of the directory in that location for your new project. @@ -121,7 +121,7 @@ The folder you select on the screen above is where your configuration will be in When you click **Run Setup** on the above screen, Desktop will begin to download and install all of the required components of your configuration. The installation process could take several minutes to complete. Once complete, you will have a local copy of the entire project configuration that you will modify in the following steps. -The configuration location you specified during the Desktop installation tutorial is recorded in Shotgun in the Pipeline Configurations page for your project. +The configuration location you specified during the Desktop installation tutorial is recorded in {% include product %} in the Pipeline Configurations page for your project. {% include figure src="./images/tutorial/image_10.png" caption="The Pipeline Configuration entity in Shotgun" %} @@ -157,9 +157,9 @@ Once the file is in your configuration's **`hooks`** folder, you will be ready t # Building the Pipeline -At this point you should be ready to begin building a pipeline. You have a project set up in Shotgun, you can launch Maya & Nuke via Desktop, and you've taken control of the project's configuration. You also have a basic understanding of the structure of the config and are ready to begin fleshing out the artist workflow. +At this point you should be ready to begin building a pipeline. You have a project set up in {% include product %}, you can launch Maya & Nuke via Desktop, and you've taken control of the project's configuration. You also have a basic understanding of the structure of the config and are ready to begin fleshing out the artist workflow. -The following sections will walk through each step of the pipeline, highlighting the features that are available out-of-the-box and walking you through the process of customizing the Shotgun integrations. By the end of these sections, you will have a simple, fully functional, end-to-end production pipeline. You will also get a feel for the steps artists will take as they work on production. +The following sections will walk through each step of the pipeline, highlighting the features that are available out-of-the-box and walking you through the process of customizing the {% include product %} integrations. By the end of these sections, you will have a simple, fully functional, end-to-end production pipeline. You will also get a feel for the steps artists will take as they work on production. {% include info title="Note" content="All code and configuration for this tutorial can be found on the **`pipeline_tutorial`** branch of the [**`tk-config-default2`** repository](https://github.com/shotgunsoftware/tk-config-default2/tree/pipeline_tutorial/). Feel free to use this branch if you need hints as to where files should live, where code should be added, etc." %} @@ -167,9 +167,9 @@ The following sections will walk through each step of the pipeline, highlighting The first step in the simple pipeline is Modeling. In this section you will create the first iteration of the Teapot Asset in your project. You will save it to disk in your project's folder structure and then publish it. -First, launch Maya from Shotgun Desktop. +First, launch Maya from {% include product %} Desktop. -Once Maya has full loaded, you will see the File Open Dialog appear. This dialog allows you to browse existing Maya files within the project. It also allows you to create new files that the Shotgun integrations will be aware of. +Once Maya has full loaded, you will see the File Open Dialog appear. This dialog allows you to browse existing Maya files within the project. It also allows you to create new files that the {% include product %} integrations will be aware of. Select the Assets tab and drill down into the Teapot's modeling task. Since there are no artist work files for this task yet, click the **+ New File** button. @@ -183,7 +183,7 @@ Next, model a Teapot, or [download](https://raw.githubusercontent.com/shotgunsof {% include figure src="./images/tutorial/image_14.png" %} -When you're happy with your Teapot model, select the **Shotgun > File Save…** menu action. This dialog will prompt you to save the file to a given name, version, and type. +When you're happy with your Teapot model, select the **{% include product %} > File Save…** menu action. This dialog will prompt you to save the file to a given name, version, and type. {% include figure src="./images/tutorial/image_15.png" %} @@ -201,19 +201,19 @@ Also notice the preview of the file name and path to be written at the bottom of Click the **Save** button to save the teapot model. -An important thing to note at this point is that the steps you just completed will be the same steps artists take when opening and saving workfiles throughout the pipeline. The File Open and File Save dialogs are part of Workfiles App. This "multi" app runs in all of the DCCs supported by the Shotgun integrations and provides a consistent workflow for all artists. +An important thing to note at this point is that the steps you just completed will be the same steps artists take when opening and saving workfiles throughout the pipeline. The File Open and File Save dialogs are part of Workfiles App. This "multi" app runs in all of the DCCs supported by the {% include product %} integrations and provides a consistent workflow for all artists. The next step is to make some changes to your teapot. Make sure the lid geometry is separate from the rest of the model so that it can be rigged later on. {% include figure src="./images/tutorial/image_16.png" %} -Once you're satisfied with your work, run the **Shotgun > File Save…** menu action again. This time the dialog will default your version number to 2. The automatic incrementing of the file version allows artists to maintain a complete history of the work they've done. Click the Save button. +Once you're satisfied with your work, run the **{% include product %} > File Save…** menu action again. This time the dialog will default your version number to 2. The automatic incrementing of the file version allows artists to maintain a complete history of the work they've done. Click the Save button. {% include figure src="./images/tutorial/image_17.png" %} Once you have saved the Teapot model to version 2, you are ready for the last step in this section of the tutorial. -Now that your Teapot model is ready, you need to publish it so that it can be surfaced and rigged. To publish, click the **Shotgun > Publish…** menu action. You will be presented with the Publish App dialog. +Now that your Teapot model is ready, you need to publish it so that it can be surfaced and rigged. To publish, click the **{% include product %} > Publish…** menu action. You will be presented with the Publish App dialog. {% include figure src="./images/tutorial/image_18.png" %} @@ -225,7 +225,7 @@ On the left side of the dialog you will see an item representing the current May Explore the Publish App by clicking on the items on the left side of the tree. You'll notice that the items to be acted upon, when selected, allow you to enter a description of what is being published. You can also take a screenshot to be associated with the item by clicking the camera icon on the right. -When you are ready, click the **Publish** button in the bottom right corner to publish the current work file and the teapot geometry. Once complete, you can browse to the Teapot Asset in Shotgun to verify that the publish completed successfully. +When you are ready, click the **Publish** button in the bottom right corner to publish the current work file and the teapot geometry. Once complete, you can browse to the Teapot Asset in {% include product %} to verify that the publish completed successfully. {% include figure src="./images/tutorial/image_19.png" %} @@ -259,15 +259,15 @@ Next up, the surfacing workflow. In this section you will build on what you learned in the modeling section. You will learn how to load the Teapot model you created in the previous section using the Loader app. You will also learn how to customize the Publish app to publish shaders for your Teapot. -Start by launching Maya from Desktop. If you still have Maya open after working through the previous section, you do not need to relaunch. Once Maya is open, use the **Shotgun > File Open…** menu item to open the Workfiles app. Just like in the Modeling section, use the Assets tab to drill down into the Teapot asset's tasks. This time, select the surfacing task and click **+ New File**. +Start by launching Maya from Desktop. If you still have Maya open after working through the previous section, you do not need to relaunch. Once Maya is open, use the **{% include product %} > File Open…** menu item to open the Workfiles app. Just like in the Modeling section, use the Assets tab to drill down into the Teapot asset's tasks. This time, select the surfacing task and click **+ New File**. {% include figure src="./images/tutorial/image_21.png" width="450px" %} -You are now working in the Teapot's surfacing task. An easy way to verify that you are in the right production context is to check the first entry in the Shotgun menu. +You are now working in the Teapot's surfacing task. An easy way to verify that you are in the right production context is to check the first entry in the {% include product %} menu. {% include figure src="./images/tutorial/image_22.png" %} -Next you need to load the teapot model into your new surfacing work file. To do this, launch the Loader app via the **Shotgun > Load…** menu item in Maya. +Next you need to load the teapot model into your new surfacing work file. To do this, launch the Loader app via the **{% include product %} > Load…** menu item in Maya. {% include figure src="./images/tutorial/image_23.png" %} @@ -283,7 +283,7 @@ Next, add a simple procedural shader to the teapot. Shader management can be a time consuming and complex task when building a pipeline. It is often very specific to a studio. It is for these reasons that the shipped Maya integration does not handle shader or texture management out-of-the-box. -Use the **Shotgun > File Save…** menu action to save the current session before continuing. +Use the **{% include product %} > File Save…** menu action to save the current session before continuing. ### Custom Shader Publish @@ -445,9 +445,9 @@ That should be everything. You have overridden the Publish app's collector hook {% include info title="Note" content="If you closed Maya while making the customizations to your configuration, do not worry. You can simply launch Maya again and use the File Open dialog to open your surfacing work file. You can skip the reloading step below." %} -##### Reloading the Shotgun Integrations +##### Reloading the {% include product %} Integrations -In order to try out your customizations, you'll need to reload the integrations in your Maya session. To do this, click the **Shotgun > [Task Name] > Work Area Info…** menu action. +In order to try out your customizations, you'll need to reload the integrations in your Maya session. To do this, click the **{% include product %} > [Task Name] > Work Area Info…** menu action. {% include figure src="./images/tutorial/image_30.png" %} @@ -457,14 +457,14 @@ This will launch the Work Area Info app that provides information about your cur ### Publishing Shader Networks -Now it is time to see the results of your changes to the project configuration. Launch the publish app from the Shotgun menu. You should see the collected teapot mesh item with a **Publish Shaders** plugin attached: +Now it is time to see the results of your changes to the project configuration. Launch the publish app from the {% include product %} menu. You should see the collected teapot mesh item with a **Publish Shaders** plugin attached: {% include figure src="./images/tutorial/image_32.png" %} -Enter a description of your work and capture a thumbnail of your surfaced Teapot to associate with the published files. Finally, click publish to export the Teapot shaders to disk and register the file as a publish in Shotgun. When finished, notice that the session publish plugin has automatically saved your work file to the next available version. This is the default behavior within all of the DCCs supported by Shotgun integrations. +Enter a description of your work and capture a thumbnail of your surfaced Teapot to associate with the published files. Finally, click publish to export the Teapot shaders to disk and register the file as a publish in {% include product %}. When finished, notice that the session publish plugin has automatically saved your work file to the next available version. This is the default behavior within all of the DCCs supported by {% include product %} integrations. -You can now browse to the Teapot asset in Shotgun to verify that everything worked as expected. +You can now browse to the Teapot asset in {% include product %} to verify that everything worked as expected. {% include figure src="./images/tutorial/image_33.png" %} @@ -476,9 +476,9 @@ Next up, the rigging workflow. ## Rigging Workflow -At this point, you should feel pretty comfortable opening (or creating), saving, and publishing workfiles using the Workfile and Publish apps provided by Shotgun. You've also had a chance to use the Loader app to load a publish from upstream. Use what you've learned to complete the following tasks: +At this point, you should feel pretty comfortable opening (or creating), saving, and publishing workfiles using the Workfile and Publish apps provided by {% include product %}. You've also had a chance to use the Loader app to load a publish from upstream. Use what you've learned to complete the following tasks: -* Launch Maya from Shotgun Desktop +* Launch Maya from {% include product %} Desktop * Create a new workfile in the Teapot asset's rigging step @@ -488,7 +488,7 @@ At this point, you should feel pretty comfortable opening (or creating), saving, * Save and publish the Teapot rig -You should end up with something like this in Shotgun: +You should end up with something like this in {% include product %}: {% include figure src="./images/tutorial/image_35.png" %} @@ -496,7 +496,7 @@ Next, let's see how artists handle upstream changes in their workflow. Open up t {% include figure src="./images/tutorial/image_36.png" %} -Open the work file in the Teapot's rigging step again (via **Shotgun > File Open…**). Now launch the **Shotgun > Scene Breakdown…** menu action. This launches the Breakdown app which shows you all of the upstream publishes that you have referenced into your work file. In this case, there is only the upstream Teapot model. You should see something like this: +Open the work file in the Teapot's rigging step again (via **{% include product %} > File Open…**). Now launch the **{% include product %} > Scene Breakdown…** menu action. This launches the Breakdown app which shows you all of the upstream publishes that you have referenced into your work file. In this case, there is only the upstream Teapot model. You should see something like this: {% include figure src="./images/tutorial/image_37.png" width="400px" %} @@ -518,7 +518,7 @@ In this section, you will begin working in the Shot you created for your project Begin by using what you learned in the previous sections to complete the following tasks: -* Launch Maya from Shotgun Desktop +* Launch Maya from {% include product %} Desktop * Create a new workfile in your Shot's layout step (Hint: use the Shots tab in the Loader) @@ -530,7 +530,7 @@ Now block your simple scene with the Teapot on the Table. Add a camera to your s {% include figure src="./images/tutorial/image_41.gif" %} -Once you are happy with your shot layout, save the file via the **Shotgun > File Save…** menu action. If you were to go ahead and publish at this point, you would only see the entire maya session as an available item to publish. +Once you are happy with your shot layout, save the file via the **{% include product %} > File Save…** menu action. If you were to go ahead and publish at this point, you would only see the entire maya session as an available item to publish. An easy customization to add, and one that provides a lot of flexibility to a pipeline, is the ability to publish stand-alone cameras to a file format that is easy to import into other packages. This makes it possible to generate the camera once, typically in layout, and then have all other pipeline steps, such as animation, lighting, and compositing, consume it directly. @@ -632,7 +632,7 @@ As you can see in the image, the new camera item is collected and the publish pl {% include info title="Note" content="Similarly to Alembic export, the camera publish plugin requires the FBX export plugin to be loaded. If you don't see the camera publish plugin item, check to ensure that the FBX plugin is loaded, and re-launch the publisher." %} -You should see something like this in Shotgun: +You should see something like this in {% include product %}: {% include figure src="./images/tutorial/image_46.png" %} @@ -644,7 +644,7 @@ Up to this point, you've only customized the Publish app in order to write custo Use what you've learned in previous sections to complete the following tasks. -* Launch Maya from Shotgun Desktop +* Launch Maya from {% include product %} Desktop * Create a new workfile in your Shot's animation step @@ -662,7 +662,7 @@ Find the section where the app is configured for maya and add this line to the l **`FBX Camera: [reference, import]`** -In the custom camera publish plugin, the **`FBXExport`** mel command in Maya was used to write the camera to disk, and the publish type used to register the file with Shotgun was **`FBX Camera`**. The line you added to the settings tells the loader to display the **`reference`** and **`import`** actions for any publishes of type **`FBX Camera`**. These actions are defined in the [tk-maya-actions.py](https://github.com/shotgunsoftware/tk-multi-loader2/blob/master/hooks/tk-maya_actions.py) hook of the Loader app. These actions are implemented in a way to handle any type of file that Maya can reference or import. The **`.fbx`** files generated by the custom plugin fall into that category so this is the only change needed to be able to load the published cameras. +In the custom camera publish plugin, the **`FBXExport`** mel command in Maya was used to write the camera to disk, and the publish type used to register the file with {% include product %} was **`FBX Camera`**. The line you added to the settings tells the loader to display the **`reference`** and **`import`** actions for any publishes of type **`FBX Camera`**. These actions are defined in the [tk-maya-actions.py](https://github.com/shotgunsoftware/tk-multi-loader2/blob/master/hooks/tk-maya_actions.py) hook of the Loader app. These actions are implemented in a way to handle any type of file that Maya can reference or import. The **`.fbx`** files generated by the custom plugin fall into that category so this is the only change needed to be able to load the published cameras. Your app settings should now look like this: @@ -688,7 +688,7 @@ In this section, you will bring together everything you published in the previou First, use what you've learned in previous sections to complete the following tasks. -* Launch Maya from Shotgun Desktop +* Launch Maya from {% include product %} Desktop * Create a new workfile in your Shot's lighting step @@ -783,11 +783,11 @@ Render your shot to disk. {% include info title="Note" content="As you can see, there are issues with the surfacing of both the Teapot and the Table asset. For the purposes of this tutorial, assume these were intentional, artistic choices. If you want to address these issues, you can always load the surfacing work files for these assets and adjust the shaders and re-publish them. If you do, remember to update the references in the lighting work file and re-render. If you go through the steps, you may find that the breakdown app does not reconnect your updated shaders after reloading the reference. Based on your experience modifying the loader to hook up shader references, you should be able to update the breakdown app's scene operations hook to add the required logic. HINT: See the update method in [this file](https://github.com/shotgunsoftware/tk-multi-breakdown/blob/master/hooks/tk-maya_scene_operations.py#L69)." %} -The shipped Shotgun integrations will collect image sequences by looking at the render layers defined in the file. Once your render is complete, launch the publisher. You will see the rendered sequence as an item in the tree. +The shipped {% include product %} integrations will collect image sequences by looking at the render layers defined in the file. Once your render is complete, launch the publisher. You will see the rendered sequence as an item in the tree. {% include figure src="./images/tutorial/image_55.png" %} -Go ahead and publish the session and the rendered image file sequence. You should see something like this in Shotgun: +Go ahead and publish the session and the rendered image file sequence. You should see something like this in {% include product %}: {% include figure src="./images/tutorial/image_56.png" %} @@ -799,9 +799,9 @@ In this final section of the tutorial, you will be introduced to some of the def Start by following these steps to prepare your work file. -* Launch Nuke from Shotgun Desktop +* Launch Nuke from {% include product %} Desktop -* Just like in Maya, use the Shotgun > File Open… menu action to create a new work file in the Shot's compositing step. +* Just like in Maya, use the {% include product %} > File Open… menu action to create a new work file in the Shot's compositing step. Load the image sequence you rendered and published in the previous section via the Loader app. @@ -814,40 +814,40 @@ Make sure your Nuke Project Settings output format matches your rendered images. {% include figure src="./images/tutorial/image_58.png" %} -Once you are happy with your comp, use the **Shotgun > File Save…** menu action to save your work file. +Once you are happy with your comp, use the **{% include product %} > File Save…** menu action to save your work file. -Next, click the Shotgun logo in the left hand menu in Nuke. Click on one of the Shotgun-aware write nodes in that menu: +Next, click the {% include product %} logo in the left hand menu in Nuke. Click on one of the Shotgun-aware write nodes in that menu: {% include figure src="./images/tutorial/image_59.png" width="400px" %} -The Shotgun Write Node app provides a layer on top of the built-in Nuke Write node that automatically evaluates the output path based on your current Shotgun context. +The {% include product %} Write Node app provides a layer on top of the built-in Nuke Write node that automatically evaluates the output path based on your current {% include product %} context. {% include figure src="./images/tutorial/image_60.png" %} -Render the image frames to disk. You can now publish your nuke session to associate the work file with the rendered images. By default, the publisher will collect the rendered frames and attach a plugin to register the frames with Shotgun. A second plugin will upload the frames for review by way of an integration that runs in the background called review submission. This app uses nuke to generate a quicktime that will be uploaded and made available for review. +Render the image frames to disk. You can now publish your nuke session to associate the work file with the rendered images. By default, the publisher will collect the rendered frames and attach a plugin to register the frames with {% include product %}. A second plugin will upload the frames for review by way of an integration that runs in the background called review submission. This app uses nuke to generate a quicktime that will be uploaded and made available for review. {% include figure src="./images/tutorial/image_61.png" %} -Another useful integration is the Quick Review app. This is an output node that will quickly generate and upload a quicktime to Shotgun for Review. The app can be found in the left hand menu next to the Shotgun Write Nodes. +Another useful integration is the Quick Review app. This is an output node that will quickly generate and upload a quicktime to {% include product %} for Review. The app can be found in the left hand menu next to the {% include product %} Write Nodes. {% include figure src="./images/tutorial/image_62.png" width="400px" %} -Create a Quick Review node, then click the Upload button to render the input to disk, generate the quicktime, and upload the result to Shotgun for review. Some standard options are provided before submitting the frames. +Create a Quick Review node, then click the Upload button to render the input to disk, generate the quicktime, and upload the result to {% include product %} for review. Some standard options are provided before submitting the frames. {% include figure src="./images/tutorial/image_63.png" %} -Check the media tab in Shotgun to see both of the uploaded quicktimes. +Check the media tab in {% include product %} to see both of the uploaded quicktimes. {% include figure src="./images/tutorial/image_64.png" %} -For more information on reviewing media in Shotgun, see the [official documentation](https://support.shotgunsoftware.com/hc/en-us/sections/204245448-Review-and-approval). +For more information on reviewing media in {% include product %}, see the [official documentation](https://support.shotgunsoftware.com/hc/en-us/sections/204245448-Review-and-approval). # Conclusion -Congratulations, you're done! Hopefully this tutorial has given you a starting point for building your own custom pipeline using the Shotgun integrations. You should have an understanding of how to extend the default integrations to meet the specific needs of your studio. +Congratulations, you're done! Hopefully this tutorial has given you a starting point for building your own custom pipeline using the {% include product %} integrations. You should have an understanding of how to extend the default integrations to meet the specific needs of your studio. Ask questions and learn how other studios are using Toolkit over at the [shotgun-dev Google Group](https://groups.google.com/a/shotgunsoftware.com/forum/#!forum/shotgun-dev). Be sure to subscribe to stay up to date with the latest posts! If there are features or workflows that you feel are outside of the default integrations, then you can always write your own apps. [Here is an excellent document](https://support.shotgunsoftware.com/entries/95440137) to help you get started writing your first app. -As always, if you have additional questions about this tutorial or about Shotgun or the Toolkit platform in general, feel free to [submit a ticket](https://support.shotgunsoftware.com/hc/en-us/requests/new). +As always, if you have additional questions about this tutorial or about {% include product %} or the Toolkit platform in general, feel free to [submit a ticket](https://support.shotgunsoftware.com/hc/en-us/requests/new). diff --git a/docs/en/guides/review.md b/docs/en/guides/review.md index eee2cbae1..99b1de39d 100644 --- a/docs/en/guides/review.md +++ b/docs/en/guides/review.md @@ -13,4 +13,4 @@ Dig into RV's Reference Manuals for a complete understanding of node graphs, cus Check out the RV-SDI manual to learn about our implementation of the NVIDIA SDI video device as a presentation mode device. -Look to our Integration Packages for seamless workflows with Maya, Nuke, and even Shotgun itself. +Look to our Integration Packages for seamless workflows with Maya, Nuke, and even {% include product %} itself. diff --git a/docs/en/guides/webhooks.md b/docs/en/guides/webhooks.md index 325d52d9a..8e99c28a4 100644 --- a/docs/en/guides/webhooks.md +++ b/docs/en/guides/webhooks.md @@ -9,7 +9,7 @@ lang: en {% include info title="Beta" content="Webhooks is currently in beta. Join the [webhooks community forum](https://community.shotgunsoftware.com/c/webhooks) to learn more and participate." %} -Webhooks allow a service you control to be notified of events that occur in Shotgun. When you create a webhook, you specify the type of event you are interested in and tell Shotgun what URL to send data to when it is triggered. Once the relevant event happens in Shotgun, a payload of data describing the event will be sent to the webhook’s URL. This allows you to build tight integrations with Shotgun and automate portions of your workflow. +Webhooks allow a service you control to be notified of events that occur in {% include product %}. When you create a webhook, you specify the type of event you are interested in and tell {% include product %} what URL to send data to when it is triggered. Once the relevant event happens in {% include product %}, a payload of data describing the event will be sent to the webhook’s URL. This allows you to build tight integrations with {% include product %} and automate portions of your workflow. ## What are some examples of how to use webhooks? @@ -17,7 +17,7 @@ There are numerous use cases for webhooks. A few that we think are compelling ar ### Create a directory structure on disk when an entity is created -One workflow that we have seen repeated many times over is the need to create a directory structure on disk when a new entity is created in Shotgun. Why not go ahead and make sure that a new shot is ready for artist work automatically once it is created in Shotgun? +One workflow that we have seen repeated many times over is the need to create a directory structure on disk when a new entity is created in {% include product %}. Why not go ahead and make sure that a new shot is ready for artist work automatically once it is created in {% include product %}? ### Automation of status management @@ -25,9 +25,9 @@ When your animation team is finished with their work, why not go ahead and chang Another great example of how to automate status management would be to trigger a status change on a `Task` entity when a new `Note` is created. This is a good way to indicate to the artist and production teams that a supervisor has requested changes or fixes to the current work after a review session. -## When should webhooks be used instead of the Shotgun event daemon? +## When should webhooks be used instead of the {% include product %} event daemon? -Webhooks and the [Shotgun event daemon](https://github.com/shotgunsoftware/shotgunEvents/wiki) offer similar features, but with a few key differences. The event daemon requires that you run, monitor, and maintain your own service. All of your code must be written in Python, and it allows you to initiate your own connections to Shotgun. Webhooks, in contrast, answer connections and can be written in any programming language. They can be hosted in a serverless environment, such as [AWS Lambda](https://aws.amazon.com/lambda/), or can trigger any of the automation platforms available online, such as [Zapier](https://zapier.com) and [IFTTT](https://ifttt.com). If your use case works with webhooks, it should be the preferred solution. +Webhooks and the [{% include product %} event daemon](https://github.com/shotgunsoftware/shotgunEvents/wiki) offer similar features, but with a few key differences. The event daemon requires that you run, monitor, and maintain your own service. All of your code must be written in Python, and it allows you to initiate your own connections to {% include product %}. Webhooks, in contrast, answer connections and can be written in any programming language. They can be hosted in a serverless environment, such as [AWS Lambda](https://aws.amazon.com/lambda/), or can trigger any of the automation platforms available online, such as [Zapier](https://zapier.com) and [IFTTT](https://ifttt.com). If your use case works with webhooks, it should be the preferred solution. ## Creating a webhook @@ -66,7 +66,7 @@ True ### Validate SSL certificate -Validation of SSL certificates is an optional feature that will help ensure the security of any connections made to the webhook’s consumer URL. If turned on, when a delivery is made to the webhook’s URL, Shotgun will use OpenSSL’s certificate validation routine to verify the certificate. +Validation of SSL certificates is an optional feature that will help ensure the security of any connections made to the webhook’s consumer URL. If turned on, when a delivery is made to the webhook’s URL, {% include product %} will use OpenSSL’s certificate validation routine to verify the certificate. ## Webhook status @@ -77,7 +77,7 @@ A webhook can have one of several different statuses, indicating its health and | Status | Example | Description | |--------|:-------:|:-----------:| | Active | ![Active](./images/webhooks/webhook_status_active.png) | The webhook is operating in a stable fashion. No deliveries to this webhook's consumer URL have failed to reach their destination in the past 24 hours. | -| Unstable | ![Unstable](./images/webhooks/webhook_status_unstable.png) | The webhook is operating in an unstable fashion. Some deliveries have failed to reach their destination in the past 24 hours, but not enough to cause Shotgun to consider the webhook to be dead. | +| Unstable | ![Unstable](./images/webhooks/webhook_status_unstable.png) | The webhook is operating in an unstable fashion. Some deliveries have failed to reach their destination in the past 24 hours, but not enough to cause {% include product %} to consider the webhook to be dead. | | Failed | ![Failed](./images/webhooks/webhook_status_failed.png) | The webhook is considered to be dead, and no further deliveries will be attempted. This is a result of too many delivery failures in a short period of time, and the system has determined that the webhook should no longer be considered viable. **A webhook is considered failed if it has 10 failed deliveries in the past 24 hours**. | | Disabled | ![Disabled](./images/webhooks/webhook_status_disabled.png) | The webhook is in a disabled state, and no further deliveries will be attempted until it is re-enabled. | @@ -101,7 +101,7 @@ Deliveries can be expanded to show detailed information about the request sent t #### Request Payload -The payload sent to the webhook's URL contains information describing the event that occurred in Shotgun and who triggered it. It is provided in JSON format. +The payload sent to the webhook's URL contains information describing the event that occurred in {% include product %} and who triggered it. It is provided in JSON format. {% include warning title="Payload size" content="The maximum size of a delivery's payload is 1 megabyte. Any event triggered in Shotgun that would result in a payload size larger than 1 megabyte will have its `new_value` and `old_value` keys removed, and a `warning` key added that contains a message explaining what happened, why, and how to retrieve the entire event log entry from Shotgun." %} @@ -144,7 +144,7 @@ The payload sent to the webhook's URL contains information describing the event ##### Session UUID -Provided as part of the event payload is the `session_uuid` that triggered the event in Shotgun. This value can be provided to [Shotgun's Python API](https://developer.shotgunsoftware.com/python-api/reference.html?highlight=session_uuid#shotgun_api3.shotgun.Shotgun.set_session_uuid), which will cause any open browser session with that session_uuid to display updates for events generated by the API. +Provided as part of the event payload is the `session_uuid` that triggered the event in {% include product %}. This value can be provided to [{% include product %}'s Python API](https://developer.shotgunsoftware.com/python-api/reference.html?highlight=session_uuid#shotgun_api3.shotgun.Shotgun.set_session_uuid), which will cause any open browser session with that session_uuid to display updates for events generated by the API. ### Responding to deliveries @@ -174,7 +174,7 @@ Where a high rate of overall throughput is needed, then consumer endpoints shoul ### Acknowledgements -A delivery can be updated to include an acknowledgement. When a delivery is made, headers are provided as part of the request. Included in those headers is the ID of the delivery record, stored in the `x-sg-delivery-id` key. This ID can be used to update the delivery record to include an acknowledgement using [the Shotgun REST API](https://developer.shotgunsoftware.com/rest-api). +A delivery can be updated to include an acknowledgement. When a delivery is made, headers are provided as part of the request. Included in those headers is the ID of the delivery record, stored in the `x-sg-delivery-id` key. This ID can be used to update the delivery record to include an acknowledgement using [the {% include product %} REST API](https://developer.shotgunsoftware.com/rest-api). {% include warning title="Acknowledgement size" content="The maximum size allowed for an acknowledgement is 4 kilobytes." %} @@ -195,7 +195,7 @@ A delivery can be updated to include an acknowledgement. When a delivery is made #### What are acknowledgements used for? -Acknowledgements allow for out of band, detailed reporting of success or failure to process a delivery that was successfully received by your webhook's URL. This creates a separation between the status of receiving the delivery from Shotgun and the success or failure to process the event associated with that delivery. In this way, successfully-delivered events can contain additional information useful for debugging purposes. A good example would be a webhook triggered on the creation of an `Asset` entity. If that webhook's responsibility is to create a directory structure on disk for each new `Asset`, the webhook's URL could successfully receive a delivery, but be unable to create the associated directories due to a disk or network outage. It could then update the delivery record with a detailed error message stating that the directory structure was not created, and why. +Acknowledgements allow for out of band, detailed reporting of success or failure to process a delivery that was successfully received by your webhook's URL. This creates a separation between the status of receiving the delivery from {% include product %} and the success or failure to process the event associated with that delivery. In this way, successfully-delivered events can contain additional information useful for debugging purposes. A good example would be a webhook triggered on the creation of an `Asset` entity. If that webhook's responsibility is to create a directory structure on disk for each new `Asset`, the webhook's URL could successfully receive a delivery, but be unable to create the associated directories due to a disk or network outage. It could then update the delivery record with a detailed error message stating that the directory structure was not created, and why. ## Testing webhooks diff --git a/docs/en/quick-answers/administering.md b/docs/en/quick-answers/administering.md index 589991cc8..624446216 100644 --- a/docs/en/quick-answers/administering.md +++ b/docs/en/quick-answers/administering.md @@ -10,11 +10,11 @@ Administering A collection of quick answers based around administering and configuring your Toolkit setup. -#### Shotgun Desktop: -- [How do I re-setup a Toolkit project using Shotgun Desktop?](./administering/resetup-project-with-sg-desktop.md) -- [How do I install the Shotgun Desktop silently on Windows?](./administering/install-desktop-silent.md) -- [How do I set up a desktop/launcher icon for Shotgun Desktop on Linux?](./administering/create-shotgun-desktop-shortcut.md) -- [How can I disable the Shotgun Desktop's browser integration?](./administering/disable-browser-integration.md) +#### {% include product %} Desktop: +- [How do I re-setup a Toolkit project using {% include product %} Desktop?](./administering/resetup-project-with-sg-desktop.md) +- [How do I install the {% include product %} Desktop silently on Windows?](./administering/install-desktop-silent.md) +- [How do I set up a desktop/launcher icon for {% include product %} Desktop on Linux?](./administering/create-shotgun-desktop-shortcut.md) +- [How can I disable the {% include product %} Desktop's browser integration?](./administering/disable-browser-integration.md) #### Managing your config: diff --git a/docs/en/quick-answers/administering/convert-from-single-root-to-multi.md b/docs/en/quick-answers/administering/convert-from-single-root-to-multi.md index db1fe2859..96469a4de 100644 --- a/docs/en/quick-answers/administering/convert-from-single-root-to-multi.md +++ b/docs/en/quick-answers/administering/convert-from-single-root-to-multi.md @@ -10,19 +10,19 @@ lang: en The Default Configuration we provide is set up to use a single local storage root (i.e, all of your project files are stored underneath a single root point like `/sgtk/projects`). You may want to add a new storage root to store some of your project files. This is a common situation that arises when you're running out of disk space or want some media to be on a faster storage, etc. Let’s say you want to add another root named “secondary”. Here are the steps you need to take: -## Add the local storage in Shotgun +## Add the local storage in {% include product %} -- In Shotgun, navigate to the **Admin > Site Preferences** page +- In {% include product %}, navigate to the **Admin > Site Preferences** page - Open up the **File Management** section - Click on **[+] Add Local File Storage** - Fill out the name ("secondary") and the paths to the storage root on all of the relevant platforms. *If you're not using a particular platform, you can simply leave it blank.* - Click on the **Save Page** button on the top or the bottom of the page -![Shotgun file management prefs](images/shotgun-pref-file-management.png) +![{% include product %} file management prefs](images/shotgun-pref-file-management.png) ## Add the new root to your pipeline configuration -Toolkit caches information about the local storages used in a pipeline configuration in the `config/core/roots.yml` file. Edit this file to add the new **secondary** storage root you just created in Shotgun: +Toolkit caches information about the local storages used in a pipeline configuration in the `config/core/roots.yml` file. Edit this file to add the new **secondary** storage root you just created in {% include product %}: primary: { linux_path: /mnt/hgfs/sgtk/projects, @@ -90,4 +90,4 @@ You should follow this same pattern for each template path in your `config/core/ {% include info title="Note" content="You do not need to specify a `root_name` for templates that use the default storage root. The default root is indicated by specifying `default: true` in the `roots.yml` file. If a default is not explicitly defined in `roots.yml`, the root named **primary** will be considered the default." %} -1 *It is worth noting that updating the paths might not be ideal, since any old files that were created using the previous value will not be accessible by Toolkit once the new value is set (e.g. old work files won't be found by Toolkit after changing their template path). If this is a concern, you may then create a new template (e.g. houdini_shot_publish_v2) with the new location and upgrade your apps to use that new version. Not all apps handle a fallback concept like this, but this will allow some apps to recognize the old files. This does not affect publishes, as these are always linked to their publish in Shotgun.* +1 *It is worth noting that updating the paths might not be ideal, since any old files that were created using the previous value will not be accessible by Toolkit once the new value is set (e.g. old work files won't be found by Toolkit after changing their template path). If this is a concern, you may then create a new template (e.g. houdini_shot_publish_v2) with the new location and upgrade your apps to use that new version. Not all apps handle a fallback concept like this, but this will allow some apps to recognize the old files. This does not affect publishes, as these are always linked to their publish in {% include product %}.* diff --git a/docs/en/quick-answers/administering/create-shotgun-desktop-shortcut.md b/docs/en/quick-answers/administering/create-shotgun-desktop-shortcut.md index 23f60b9a9..25cde4e68 100644 --- a/docs/en/quick-answers/administering/create-shotgun-desktop-shortcut.md +++ b/docs/en/quick-answers/administering/create-shotgun-desktop-shortcut.md @@ -5,10 +5,10 @@ pagename: create-shotgun-desktop-shortcut lang: en --- -# How do I set up a desktop/launcher icon for Shotgun Desktop on Linux? +# How do I set up a desktop/launcher icon for {% include product %} Desktop on Linux? -The current Shotgun Desktop installer doesn't automatically create shortcuts and launch entries, so you have to manually go in and do this afterwards. It's straightforward and may differ depending on which flavour of Linux you are using. +The current {% include product %} Desktop installer doesn't automatically create shortcuts and launch entries, so you have to manually go in and do this afterwards. It's straightforward and may differ depending on which flavour of Linux you are using. -Once you have run the Shotgun desktop installer, the Shotgun Desktop executable will be located in the `/opt/Shotgun folder`. The name of the executable is Shotgun. -No icon is distributed with the installer. Download it from the [Shotgun Desktop engine github repository](https://github.com/shotgunsoftware/tk-desktop/blob/aac6fe004bd003bf26316b9859bd4ebc42eb82dc/resources/default_systray_icon.png). +Once you have run the {% include product %} desktop installer, the {% include product %} Desktop executable will be located in the `/opt/Shotgun folder`. The name of the executable is {% include product %}. +No icon is distributed with the installer. Download it from the [{% include product %} Desktop engine github repository](https://github.com/shotgunsoftware/tk-desktop/blob/aac6fe004bd003bf26316b9859bd4ebc42eb82dc/resources/default_systray_icon.png). Once you have downloaded the icon and have the path to the executable (`/opt/Shotgun/Shotgun`), please manually create any desktop or menu launchers you may require. The process for doing this varies depending on the version of Linux, but you can typically create a desktop launcher by right clicking on the Desktop and looking for a suitable menu option there. \ No newline at end of file diff --git a/docs/en/quick-answers/administering/disable-browser-integration.md b/docs/en/quick-answers/administering/disable-browser-integration.md index 023da748c..17756b95d 100644 --- a/docs/en/quick-answers/administering/disable-browser-integration.md +++ b/docs/en/quick-answers/administering/disable-browser-integration.md @@ -5,15 +5,15 @@ pagename: disable-browser-integration lang: en --- -# How can I disable Shotgun Desktop's browser integration? +# How can I disable {% include product %} Desktop's browser integration? To disable browser integration, follow these two simple steps. 1. Create or open the text file at: - Windows: %APPDATA%\Shotgun\preferences\toolkit.ini - Macosx: ~/Library/Preferences/Shotgun/toolkit.ini - Linux: ~/.shotgun/preferences/toolkit.ini + Windows: %APPDATA%\{% include product %}\preferences\toolkit.ini + Macosx: ~/Library/Preferences/{% include product %}/toolkit.ini + Linux: ~/.{% include product %}/preferences/toolkit.ini 2. Add the following section: @@ -24,4 +24,4 @@ See complete instructions on how to configure the browser integration in our [Ad **Alternate method** -If you've taken over your Toolkit pipeline configuration, an alternative would be to remove the [`tk-shotgun` engine from your environments](https://github.com/shotgunsoftware/tk-config-default2/blob/master/env/project.yml#L48) so that it can't load any actions. \ No newline at end of file +If you've taken over your Toolkit pipeline configuration, an alternative would be to remove the [`tk-{% include product %}` engine from your environments](https://github.com/shotgunsoftware/tk-config-default2/blob/master/env/project.yml#L48) so that it can't load any actions. \ No newline at end of file diff --git a/docs/en/quick-answers/administering/install-desktop-silent.md b/docs/en/quick-answers/administering/install-desktop-silent.md index c342f5b39..1c13cdc75 100644 --- a/docs/en/quick-answers/administering/install-desktop-silent.md +++ b/docs/en/quick-answers/administering/install-desktop-silent.md @@ -5,9 +5,9 @@ pagename: install-desktop-silent lang: en --- -# How do I install the Shotgun Desktop silently on Windows? +# How do I install the {% include product %} Desktop silently on Windows? -To run the Shotgun Desktop installer silently, simply launch the Shotgun Desktop installer the following way: +To run the {% include product %} Desktop installer silently, simply launch the {% include product %} Desktop installer the following way: `ShotgunInstaller_Current.exe /S` diff --git a/docs/en/quick-answers/administering/move-configuration-location.md b/docs/en/quick-answers/administering/move-configuration-location.md index c343ab2ca..4b7183a4c 100644 --- a/docs/en/quick-answers/administering/move-configuration-location.md +++ b/docs/en/quick-answers/administering/move-configuration-location.md @@ -9,7 +9,7 @@ lang: en {% include info title="Note" content="The contents of this doc only apply to [centralized configuration setups](https://developer.shotgunsoftware.com/tk-core/initializing.html#centralized-configurations). [Distributed configurations](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations) are cached locally to the individual client machines and are managed automatically by Toolkit." %} -The easiest way to move your pipeline configuration to a new location is by using the `tank move_configuration` command. This will take care of moving your files, updating Shotgun, and updating your config files to point to the new location. +The easiest way to move your pipeline configuration to a new location is by using the `tank move_configuration` command. This will take care of moving your files, updating {% include product %}, and updating your config files to point to the new location. This command is also useful if you are only moving the location for a single operating system, or were not previously using a certain operating system but would like to add it now. Toolkit will detect what needs to be moved or added and what doesn’t, and will show you what it is about to do to allow you to confirm before progressing. @@ -27,10 +27,10 @@ This command is also useful if you are only moving the location for a single ope $ cd /sgtk/software/shotgun/scarlet $ ./tank move_configuration - Welcome to the Shotgun Pipeline Toolkit! + Welcome to the {% include product %} Pipeline Toolkit! For documentation, see https://toolkit.shotgunsoftware.com Starting Toolkit for your current path '/sgtk/software/shotgun/scarlet' - - The path is not associated with any Shotgun object. + - The path is not associated with any {% include product %} object. - Falling back on default project settings. - Using configuration 'Primary' and Core v0.15.22 - Setting the Context to Scarlet. @@ -71,10 +71,10 @@ This command is also useful if you are only moving the location for a single ope $ cd /sgtk/software/shotgun/scarlet $ ./tank move_configuration "/mnt/hgfs/sgtk/software/shotgun/scarlet_new" "z:\sgtk\software\shotgun\scarlet_new" "/sgtk/software/shotgun/scarlet_new" - Welcome to the Shotgun Pipeline Toolkit! + Welcome to the {% include product %} Pipeline Toolkit! For documentation, see https://toolkit.shotgunsoftware.com Starting toolkit for path '/sgtk/software/shotgun/scarlet' - - The path is not associated with any Shotgun object. + - The path is not associated with any {% include product %} object. - Falling back on default project settings. - Using configuration 'Primary' and Core v0.15.22 - Setting the Context to Scarlet. @@ -129,7 +129,7 @@ This command is also useful if you are only moving the location for a single ope Copying /sgtk/software/shotgun/scarlet/install/frameworks... Copying /sgtk/software/shotgun/scarlet/install/frameworks/app_store... Updating cached locations in /sgtk/software/shotgun/scarlet_new/config/core/install_location.yml... - Updating Shotgun Configuration Record... + Updating {% include product %} Configuration Record... Deleting original configuration files... All done! Your configuration has been successfully moved. @@ -152,7 +152,7 @@ If you've already started moving things manually and are stuck, here's a rundown Update the paths in this file to point to the new location for your pipeline configuration on all of the applicable platforms. If you're not using a platform, enter an empty string `''` - # Shotgun Pipeline Toolkit configuration file + # {% include product %} Pipeline Toolkit configuration file # This file was automatically created by setup_project # This file reflects the paths in the primary pipeline @@ -163,7 +163,7 @@ If you've already started moving things manually and are stuck, here's a rundown # End of file. -3. Locate the corresponding PipelineConfiguration entity in Shotgun for this project and modify the Linux Path, Mac Path, and Windows Path field values to match the changes you made above. +3. Locate the corresponding PipelineConfiguration entity in {% include product %} for this project and modify the Linux Path, Mac Path, and Windows Path field values to match the changes you made above. ![Pipeline Configuration locations in Shotgun.](images/new-pipeline-configuration-locations.png) diff --git a/docs/en/quick-answers/administering/move-project-directories.md b/docs/en/quick-answers/administering/move-project-directories.md index fa7846c80..108e70863 100644 --- a/docs/en/quick-answers/administering/move-project-directories.md +++ b/docs/en/quick-answers/administering/move-project-directories.md @@ -12,11 +12,11 @@ lang: en Sometimes it's necessary to move your project files (scene files, renders, etc.) to a new root storage location (e.g., from `/mnt/smalldrive` to `/mnt/bigdrive/foo`). This can be done whether you're using a single or multi-root configuration. For example, let's say we want to move your storage named **"asset_storage"**: - Copy (or move) your project files from the old location to the new location. -- In Shotgun, navigate to the **Admin > Site Preferences** page and open the **File Management** section. - ![Shotgun storage roots section in the site preferences.](./images/shotgun-storage-roots.png) +- In {% include product %}, navigate to the **Admin > Site Preferences** page and open the **File Management** section. + ![{% include product %} storage roots section in the site preferences.](./images/shotgun-storage-roots.png) - Update the Local File Storage named "primary" with the paths for each platform to the new storage for your project files. If you're not using a specific platform, leave it blank. - Click on the **"Save Changes"** button on the top or bottom of the page. -- Update your `config/core/roots.yml` file in your project configuration to match the new path values you just saved in Shotgun. +- Update your `config/core/roots.yml` file in your project configuration to match the new path values you just saved in {% include product %}. Toolkit stores publish paths as relative paths from a storage root. So with the old storage root the path was expanded like so: @@ -26,7 +26,7 @@ With the new storage root definition, the path is now expanded like this: [asset-storage]/assets/Character/betty => /mnt/bigdrive/foo/assets/Character/betty -and we don't need to worry about updating any other publish information in Shotgun or Toolkit! +and we don't need to worry about updating any other publish information in {% include product %} or Toolkit! {% include warning title="Warning" content="The above steps assume that you are re-pathing the existing storage root. If instead you trash the existing one or create a new one then you will need to re-register all your folders and re-publish your `PublishedFiles` entities." %} @@ -36,4 +36,4 @@ If any of your scene files have references in them that are pointing to the old ## Versions -If you have Version entities in Shotgun that store information in the Path to Movie or Path to Frames fields that are affected by this change, these will also have to be updated to point to the new location since these fields are string fields that contain an absolute path to the media. \ No newline at end of file +If you have Version entities in {% include product %} that store information in the Path to Movie or Path to Frames fields that are affected by this change, these will also have to be updated to point to the new location since these fields are string fields that contain an absolute path to the media. \ No newline at end of file diff --git a/docs/en/quick-answers/administering/resetup-project-with-sg-desktop.md b/docs/en/quick-answers/administering/resetup-project-with-sg-desktop.md index 9d3b1277b..4bde95f15 100644 --- a/docs/en/quick-answers/administering/resetup-project-with-sg-desktop.md +++ b/docs/en/quick-answers/administering/resetup-project-with-sg-desktop.md @@ -5,16 +5,16 @@ pagename: resetup-project-with-sg-desktop lang: en --- -# How do I re-setup a Toolkit project using Shotgun Desktop? +# How do I re-setup a Toolkit project using {% include product %} Desktop? -If you’ve already set up a Toolkit configuration for a project and need to start fresh, the Advanced Setup Wizard in Shotgun Desktop will not allow you to re-setup the project unless you’ve removed the previously setup configuration. +If you’ve already set up a Toolkit configuration for a project and need to start fresh, the Advanced Setup Wizard in {% include product %} Desktop will not allow you to re-setup the project unless you’ve removed the previously setup configuration. Here are the steps for manually removing those settings: -1. Delete any `PipelineConfiguration` entities linked to your Project in Shotgun..

![Access to the PipelineConfiguration entity page](images/pipeline-configuration-entity-page.png)

-2. Set the `Tank Name` field on your `Project` entity in Shotgun to a blank value.

![Clear the project tank name field](images/clear-project-tank-name.png)

+1. Delete any `PipelineConfiguration` entities linked to your Project in {% include product %}..

![Access to the PipelineConfiguration entity page](images/pipeline-configuration-entity-page.png)

+2. Set the `Tank Name` field on your `Project` entity in {% include product %} to a blank value.

![Clear the project tank name field](images/clear-project-tank-name.png)

3. Remove any corresponding pipeline configuration directories on disk.. -4. In Shotgun Desktop select the project you wish to set up. *If you were already viewing the project, jump out to the project list view and then back into your project again.* +4. In {% include product %} Desktop select the project you wish to set up. *If you were already viewing the project, jump out to the project list view and then back into your project again.* 6. Now you can run the project setup process again. **Alternate method** diff --git a/docs/en/quick-answers/administering/what-is-path-cache.md b/docs/en/quick-answers/administering/what-is-path-cache.md index 806105216..5bf165f18 100644 --- a/docs/en/quick-answers/administering/what-is-path-cache.md +++ b/docs/en/quick-answers/administering/what-is-path-cache.md @@ -7,19 +7,19 @@ lang: en # What is the Path Cache? What are Filesystem Locations? -The path cache is used by Toolkit to track the associations between folders on disk and entities in Shotgun. -The master cache is stored in Shotgun using the `FilesystemLocation` entity type. Each user then has their own version +The path cache is used by Toolkit to track the associations between folders on disk and entities in {% include product %}. +The master cache is stored in {% include product %} using the `FilesystemLocation` entity type. Each user then has their own version of the path cache [stored locally in the Toolkit cache directory on disk](./where-is-my-cache.md), which is synchronized in the background whenever applications are launched or folders are created. Typically, we don't advise modifying the path cache manually. Our internal processes not only sync your local cache -with the FilesystemLocation entities in Shotgun, but also create event log entries that allow all users' - machines to stay in sync with Shotgun. +with the FilesystemLocation entities in {% include product %}, but also create event log entries that allow all users' + machines to stay in sync with {% include product %}. There are a couple tank commands that can be used to modify the path cache: - `tank unregister_folders` removes path cache associations. - - `tank synchronize_folders` forces a sync of the local path cache with Shotgun. + - `tank synchronize_folders` forces a sync of the local path cache with {% include product %}. Typically you won't need to run either of these commands, but in certain circumstances, they can be useful. For example, `unregister_folders` should be run before renaming or recreating an entity in your project. \ No newline at end of file diff --git a/docs/en/quick-answers/administering/where-is-my-cache.md b/docs/en/quick-answers/administering/where-is-my-cache.md index 74c961934..e290d9d33 100644 --- a/docs/en/quick-answers/administering/where-is-my-cache.md +++ b/docs/en/quick-answers/administering/where-is-my-cache.md @@ -10,7 +10,7 @@ lang: en ## Root Cache Location -Toolkit stores some data in a local cache to prevent unnecessary calls to the Shotgun server. This includes the [path cache](./what-is-path-cache.md), bundle cache, and thumbnails. While the default location should work for most users, it is configurable using the [cache_location core hook](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/cache_location.py) should you need to change it. +Toolkit stores some data in a local cache to prevent unnecessary calls to the {% include product %} server. This includes the [path cache](./what-is-path-cache.md), bundle cache, and thumbnails. While the default location should work for most users, it is configurable using the [cache_location core hook](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/cache_location.py) should you need to change it. The default cache root location is: @@ -37,7 +37,7 @@ The path cache is located at: **Distributed Configurations** The bundle cache is a cached collection of all the applications, engines, and frameworks used across all of the -projects on your Shotgun site. The bundle cache for distributed configs is stored in the following location: +projects on your {% include product %} site. The bundle cache for distributed configs is stored in the following location: Mac: `~/Library/Caches/Shotgun/bundle_cache` diff --git a/docs/en/quick-answers/developing/create-publishes-via-api.md b/docs/en/quick-answers/developing/create-publishes-via-api.md index 34025249e..b09ae463b 100644 --- a/docs/en/quick-answers/developing/create-publishes-via-api.md +++ b/docs/en/quick-answers/developing/create-publishes-via-api.md @@ -14,10 +14,10 @@ The Publish API ultimately uses the core sgtk API method to register the Publish In addition to the the Publish API documentation, we have examples of writing your own publish plugins in our [pipeline tutorial](https://developer.shotgunsoftware.com/cb8926fc/?title=Pipeline+Tutorial). ## Using the register_publish() API method -While it is possible to create publish records in Shotgun using a raw Shotgun API call, we would strongly recommend using Toolkit's convenience method. +While it is possible to create publish records in {% include product %} using a raw {% include product %} API call, we would strongly recommend using Toolkit's convenience method. All toolkit apps that create publishes are using a API utility method method called [`sgtk.util.register_publish()`](https://developer.shotgunsoftware.com/tk-core/utils.html#sgtk.util.register_publish). -Basically, this method will create a new PublishedFile entity in Shotgun and is trying to make that easy by using toolkit concepts. Your code would need to do something along these lines: +Basically, this method will create a new PublishedFile entity in {% include product %} and is trying to make that easy by using toolkit concepts. Your code would need to do something along these lines: ```python # Get access to the Toolkit API diff --git a/docs/en/quick-answers/developing/setting-software-environment-variables.md b/docs/en/quick-answers/developing/setting-software-environment-variables.md index 6ce8560eb..31dae903e 100644 --- a/docs/en/quick-answers/developing/setting-software-environment-variables.md +++ b/docs/en/quick-answers/developing/setting-software-environment-variables.md @@ -7,10 +7,10 @@ lang: en # How do I set environment variables before launching software? -Shotgun Toolkit allows you to use hooks during the launch process to configure the environment and run custom code. +{% include product %} Toolkit allows you to use hooks during the launch process to configure the environment and run custom code. -When you launch software, for example Nuke or Maya, via Shotgun Desktop or through the browser integration, the `tk-multi-launchapp` will be run. -This app is responsible for launching the software and ensuring the Shotgun integrations start up as expected. There are two points during this process that are exposed via hooks to allow custom code to be run. +When you launch software, for example Nuke or Maya, via {% include product %} Desktop or through the browser integration, the `tk-multi-launchapp` will be run. +This app is responsible for launching the software and ensuring the {% include product %} integrations start up as expected. There are two points during this process that are exposed via hooks to allow custom code to be run. ## before_app_launch.py diff --git a/docs/en/quick-answers/developing/sgtk-script-authentication.md b/docs/en/quick-answers/developing/sgtk-script-authentication.md index b21eff2a5..b8993a961 100644 --- a/docs/en/quick-answers/developing/sgtk-script-authentication.md +++ b/docs/en/quick-answers/developing/sgtk-script-authentication.md @@ -8,7 +8,7 @@ lang: en # How do I work with authentication and login credentials in custom scripts? ## Error Message -If you're seeing an error like the one below coming from your script, then it means your script is not authorized to talk to your Shotgun site. +If you're seeing an error like the one below coming from your script, then it means your script is not authorized to talk to your {% include product %} site. ```text tank.errors.TankError: Missing required script user in config '/path/to/your/project/config/core/shotgun.yml' diff --git a/docs/en/quick-answers/developing/toolkit-core-event-daemon.md b/docs/en/quick-answers/developing/toolkit-core-event-daemon.md index 28a4bb3da..7d338e965 100644 --- a/docs/en/quick-answers/developing/toolkit-core-event-daemon.md +++ b/docs/en/quick-answers/developing/toolkit-core-event-daemon.md @@ -14,7 +14,7 @@ lang: en Toolkit's sgtk API is project-centric. In other words, you must import it specifically from the project you wish to use it on. This means that if you use sgtk API operations for multiple projects in a single Python session, then you will run into a problem, as Python only allows a module with the same name to be imported once. -If you're using the [shotgun event daemon](https://github.com/shotgunsoftware/shotgunEvents), you may want to perform Toolkit actions inside of a plugin for certain events. This can be tricky since Python only imports a module once. So if your Toolkit Core API for Project A is imported the first time the plugin is run, that is the version that will remain imported for the life of the daemon. This means if the next event dispatched to the plugin is for Project B, you may get an error from Toolkit if you try and instantiate a new Toolkit object for Project B using the core API from Project A. +If you're using the [{% include product %} event daemon](https://github.com/shotgunsoftware/shotgunEvents), you may want to perform Toolkit actions inside of a plugin for certain events. This can be tricky since Python only imports a module once. So if your Toolkit Core API for Project A is imported the first time the plugin is run, that is the version that will remain imported for the life of the daemon. This means if the next event dispatched to the plugin is for Project B, you may get an error from Toolkit if you try and instantiate a new Toolkit object for Project B using the core API from Project A. **Example of the problem using centralized configs:** diff --git a/docs/en/quick-answers/troubleshooting.md b/docs/en/quick-answers/troubleshooting.md index 16c60c4b4..d9652a07a 100644 --- a/docs/en/quick-answers/troubleshooting.md +++ b/docs/en/quick-answers/troubleshooting.md @@ -19,14 +19,14 @@ A collection of quick answers aimed at troubleshooting issues. - [Fixing the SSL: CERTIFICATE_VERIFY_FAILED issues with the Python API](./troubleshooting/fix-ssl-certificate-verify-failed.md) #### Software integrations. -- [Why are my Houdini Shotgun integrations not starting?](./troubleshooting/houdini-integrations-not-starting.md) -- [I've launched Nuke/Maya/etc. from Shotgun Desktop, but the Shotgun menu is missing entries](./troubleshooting/menu-entries-missing-in-launched-dcc.md) +- [Why are my Houdini {% include product %} integrations not starting?](./troubleshooting/houdini-integrations-not-starting.md) +- [I've launched Nuke/Maya/etc. from {% include product %} Desktop, but the {% include product %} menu is missing entries](./troubleshooting/menu-entries-missing-in-launched-dcc.md) - [Why does the Nuke integration fail to start when I set the NUKE_PATH environment variable?](./troubleshooting/nuke-path-environment-variable.md) - [Troubleshooting Photoshop integration when two extensions are installed](./troubleshooting/two-photoshop-shotgun-extensions.md) -- [Why does 3ds Max crashes on startup when using Shotgun Toolkit?](./troubleshooting/3dsmax-crashes-on-startup.md) +- [Why does 3ds Max crashes on startup when using {% include product %} Toolkit?](./troubleshooting/3dsmax-crashes-on-startup.md) #### Browser integration - [I can't use local file linking and launch Toolkit applications from Chrome](./troubleshooting/cant-use-file-linking-toolkit-app-chrome.md) - [I can't use local file linking and launch Toolkit applications from Firefox](./troubleshooting/cant-use-file-linking-toolkit-app-firefox.md) -- [Shotgun Desktop / browser integration fails to launch on Linux](./troubleshooting/browser-integration-fails-linux.md) +- [{% include product %} Desktop / browser integration fails to launch on Linux](./troubleshooting/browser-integration-fails-linux.md) diff --git a/docs/en/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md b/docs/en/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md index 3d738bd35..09061e47b 100644 --- a/docs/en/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md +++ b/docs/en/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md @@ -5,9 +5,9 @@ pagename: 3dsmax-crashes-on-startup lang: en --- -# Why does 3ds Max crash on startup when using Shotgun Toolkit? +# Why does 3ds Max crash on startup when using {% include product %} Toolkit? -When launching 3ds Max from Shotgun Desktop or the Shotgun website, it is possible that 3ds Max will freeze, leaving you with a frozen white dialog, or the following message will appear: +When launching 3ds Max from {% include product %} Desktop or the {% include product %} website, it is possible that 3ds Max will freeze, leaving you with a frozen white dialog, or the following message will appear: Microsoft Visual C++ Runtime Library (Not Responding) Runtime Error! @@ -54,4 +54,4 @@ Now save the file. Then, open `config/env/includes/app_launchers.yml` in your pipeline configuration and find the `launch_3dsmax` entry. You should replace `hook_before_app_launch: default` to `hook_before_app_launch: '{config}/before_app_launch.py'`. -You should now be able to launch 3ds Max correctly from Shotgun and Shotgun Desktop. If you still have any issues, please contact support@shotgunsoftware.com +You should now be able to launch 3ds Max correctly from {% include product %} and {% include product %} Desktop. If you still have any issues, please contact support@shotgunsoftware.com diff --git a/docs/en/quick-answers/troubleshooting/browser-integration-fails-linux.md b/docs/en/quick-answers/troubleshooting/browser-integration-fails-linux.md index f954b8281..a2e8c353b 100644 --- a/docs/en/quick-answers/troubleshooting/browser-integration-fails-linux.md +++ b/docs/en/quick-answers/troubleshooting/browser-integration-fails-linux.md @@ -5,9 +5,9 @@ pagename: browser-integration-fails-linux lang: en --- -# Shotgun Desktop / browser integration fails to launch on Linux +# {% include product %} Desktop / browser integration fails to launch on Linux -When running the Shotgun Desktop on Linux for the first time, you may experience one of these error messages. If so, please follow the steps below for your specific error to see if that resolves things. +When running the {% include product %} Desktop on Linux for the first time, you may experience one of these error messages. If so, please follow the steps below for your specific error to see if that resolves things. If you're still stuck, please don't hesitate to contact support@shotgunsoftware.com. ###Contents @@ -51,13 +51,13 @@ You need to install libffi. To do so, run the following command as an administra yum install libffi ``` -If you've installed libffi and it still doesn't work, try creating the following symlink and then re-launching the Shotgun Desktop: +If you've installed libffi and it still doesn't work, try creating the following symlink and then re-launching the {% include product %} Desktop: ``` sudo ln -s /usr/lib64/libffi.so.6.0.1 /usr/lib64/libffi.so.5 ``` -Some users have reported success with the above. Others still have issues. The latest version of Shotgun Desktop added some additional dependencies with the web socket server which we're currently looking into. +Some users have reported success with the above. Others still have issues. The latest version of {% include product %} Desktop added some additional dependencies with the web socket server which we're currently looking into. ## Certificate validation failed related issues @@ -71,7 +71,7 @@ certutil: function failed: SEC_ERROR_BAD_DATABASE: security library: bad databas **Solution** -If you have Google Chrome installed on your computer, launch it and then relaunch the Shotgun Desktop. If you still have the issue, please contact support@shotgunsoftware.com. +If you have Google Chrome installed on your computer, launch it and then relaunch the {% include product %} Desktop. If you still have the issue, please contact support@shotgunsoftware.com. If you don't have Chrome, open a terminal and run the following command: @@ -93,7 +93,7 @@ $ certutil -N -d "sql:$HOME/.pki/nssdb" ``` Do not enter any password. -Launching the Shotgun Desktop should now work correctly. +Launching the {% include product %} Desktop should now work correctly. ## Incompatible Qt versions diff --git a/docs/en/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md b/docs/en/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md index 410068ae7..c3c63f0f4 100644 --- a/docs/en/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md +++ b/docs/en/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md @@ -9,7 +9,7 @@ lang: en ## Overview -Sometimes in Shotgun the action menu will not display the list of Toolkit applications available or will error when using local file linking, even with Shotgun Desktop running. This is a guide to troubleshooting Shotgun Desktop's browser integration in Chrome and will hopefully help you get things working. We have a separate guide for [Firefox](./cant-use-file-linking-toolkit-app-firefox.md). +Sometimes in {% include product %} the action menu will not display the list of Toolkit applications available or will error when using local file linking, even with {% include product %} Desktop running. This is a guide to troubleshooting {% include product %} Desktop's browser integration in Chrome and will hopefully help you get things working. We have a separate guide for [Firefox](./cant-use-file-linking-toolkit-app-firefox.md). - [Diagnosing the issue](#diagnosing-the-issue) - [How to quickly fix certificate issues](#how-to-quickly-fix-certificate-issues) @@ -18,13 +18,13 @@ Sometimes in Shotgun the action menu will not display the list of Toolkit applic ## Diagnosing the issue -### Is Shotgun Desktop running? +### Is {% include product %} Desktop running? Yes, we know. You probably already checked. We had to ask. :) -### Have you restarted Chrome since Shotgun Desktop started? +### Have you restarted Chrome since {% include product %} Desktop started? -If you have launched Chrome before allowing Shotgun Desktop to register the certificate (this happens only the first time you launch Shotgun Desktop and will not be an issue afterwards), Chrome will use an out of date copy of the certificates and will refuse to connect to Shotgun Desktop. Closing all tabs will not necessarily close Chrome, so we recommend that you type [chrome://restart](chrome://restart/) in the address bar and hit enter. This will ensure that all Chrome related processes will be terminated and Chrome then restarted. +If you have launched Chrome before allowing {% include product %} Desktop to register the certificate (this happens only the first time you launch {% include product %} Desktop and will not be an issue afterwards), Chrome will use an out of date copy of the certificates and will refuse to connect to {% include product %} Desktop. Closing all tabs will not necessarily close Chrome, so we recommend that you type [chrome://restart](chrome://restart/) in the address bar and hit enter. This will ensure that all Chrome related processes will be terminated and Chrome then restarted. ### Are you using firewall software? @@ -32,7 +32,7 @@ Ensure that no firewall software is preventing connections to localhost or on po ### Is Chrome rejecting the certificate? -You can verify that Chrome accepts the certificate by browsing to https://localhost:9000. This is the address the Shotgun website tries to access in order to do local file linking and launch Toolkit applications. You should normally be greeted by this message: +You can verify that Chrome accepts the certificate by browsing to https://localhost:9000. This is the address the {% include product %} website tries to access in order to do local file linking and launch Toolkit applications. You should normally be greeted by this message: ![Autobahn Python message](images/autobahn-python.png) @@ -44,7 +44,7 @@ On the other hand, if you are greeted by one of these messages, it means there w ## How to quickly fix certificate issues -The easiest way to circumvent those issues is to click **ADVANCED** and **Proceed to localhost (unsafe)**. This will let Chrome know that you are accepting the certificate nonetheless and will allow the Shotgun website to communicate with Shotgun Desktop. +The easiest way to circumvent those issues is to click **ADVANCED** and **Proceed to localhost (unsafe)**. This will let Chrome know that you are accepting the certificate nonetheless and will allow the {% include product %} website to communicate with {% include product %} Desktop. {% include info title="Note" content="This only enables the connection between your web browser and Shotgun Desktop. The trust setting lets traffic flow between these two applications, **it does not imply trust of any other server on the internet**. Unfortunately, this process needs to be repeated on every single computer with the problem. If this doesn't solve the issue or you feel it would be too complicated to deploy to all your users, we recommend you take a look at the following steps." %} @@ -54,11 +54,11 @@ The easiest way to circumvent those issues is to click **ADVANCED** and **Procee Chrome regularly upgrades its security around self-signed certificates and our browser integration is sometimes broken by these updates. Unfortunately, these sorts of issues can only be remediated by regenerating the certificate’s certificate_path. -To regenerate the certificates, you can pick the **Regenerate Certificates** option under the **Advanced** section of Shotgun Desktop's user menu. (If you don't see this option, please make sure you update the `tk-desktop` engine to unlock it.) +To regenerate the certificates, you can pick the **Regenerate Certificates** option under the **Advanced** section of {% include product %} Desktop's user menu. (If you don't see this option, please make sure you update the `tk-desktop` engine to unlock it.) -After confirming that you want to regenerate the certificates, a series of dialogs will pop-up just like the first time you've generated the certificates. On Windows and macOS, you will be prompted to update the Windows Certificate Store or the macOS keychain twice: once to remove the old certificate and once to register the new one. On Linux, the registration is done silently. Once this is done, let Shotgun Desktop restart. +After confirming that you want to regenerate the certificates, a series of dialogs will pop-up just like the first time you've generated the certificates. On Windows and macOS, you will be prompted to update the Windows Certificate Store or the macOS keychain twice: once to remove the old certificate and once to register the new one. On Linux, the registration is done silently. Once this is done, let {% include product %} Desktop restart. -Once Shotgun Desktop is back up and running, we recommend you restart Chrome by typing [chrome://restart](chrome://restart/) in the address bar to ensure that Chrome is completely shut down and that its certificate cache is cleared. +Once {% include product %} Desktop is back up and running, we recommend you restart Chrome by typing [chrome://restart](chrome://restart/) in the address bar to ensure that Chrome is completely shut down and that its certificate cache is cleared. If your computer is not connected to the Internet and can’t download the updates, please contact support@shotgunsoftware.com. @@ -98,4 +98,4 @@ If you still encounter issues using the browser integration after these changes, ## Troubleshooting on other OSes -If you have issues with the Shotgun Desktop integration on other OSes, please contact our [support team](https://support.shotgunsoftware.com/hc/en-us/requests/new) so that we can assist you and update this article. \ No newline at end of file +If you have issues with the {% include product %} Desktop integration on other OSes, please contact our [support team](https://support.shotgunsoftware.com/hc/en-us/requests/new) so that we can assist you and update this article. \ No newline at end of file diff --git a/docs/en/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md b/docs/en/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md index 88442d88d..74e13a291 100644 --- a/docs/en/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md +++ b/docs/en/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md @@ -9,12 +9,12 @@ lang: en ## Overview -Sometimes in Shotgun the action menu will not display the list of Toolkit applications available or will error when using local file linking, even with Shotgun Desktop running. -This is a guide to troubleshooting Shotgun Desktop's browser integration in Firefox and will hopefully help you get things working. We have a separate guide for [Chrome](./cant-use-file-linking-toolkit-app-chrome.md). +Sometimes in {% include product %} the action menu will not display the list of Toolkit applications available or will error when using local file linking, even with {% include product %} Desktop running. +This is a guide to troubleshooting {% include product %} Desktop's browser integration in Firefox and will hopefully help you get things working. We have a separate guide for [Chrome](./cant-use-file-linking-toolkit-app-chrome.md). ## Diagnosing the issue -### Is Shotgun Desktop running? +### Is {% include product %} Desktop running? Yes, we know. You probably already checked. We had to ask. :) @@ -24,7 +24,7 @@ Ensure that no firewall software is preventing connections to **localhost** or o ### Is Firefox rejecting the certificate? -You can verify that Firefox accepts the certificate by browsing to https://localhost:9000, which is the address the Shotgun website tries to access in order to do local file linking and launch Toolkit applications. You should normally be greeted by this message: +You can verify that Firefox accepts the certificate by browsing to https://localhost:9000, which is the address the {% include product %} website tries to access in order to do local file linking and launch Toolkit applications. You should normally be greeted by this message: ![Autobahn Python message](images/autobahn-python.png) @@ -40,9 +40,9 @@ You need to add an exception to the Firefox browser so that the certificate is a ![Add exception to Firefox](images/add-exception-firefox.png) -Click **Get Certificate** and then **Confirm Security Exception**. You can ignore the message about the certificate not being trusted. This is normal as the certificate was generated by Shotgun Desktop and not by a certification authority. +Click **Get Certificate** and then **Confirm Security Exception**. You can ignore the message about the certificate not being trusted. This is normal as the certificate was generated by {% include product %} Desktop and not by a certification authority. -You should now be able to access local file linking and launch Toolkit applications from your Shotgun site. If you are still experiencing issues after adding the exception, please contact us at support@shotgunsoftware.com. +You should now be able to access local file linking and launch Toolkit applications from your {% include product %} site. If you are still experiencing issues after adding the exception, please contact us at support@shotgunsoftware.com. ## How to fix "Secure connection failed" diff --git a/docs/en/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md b/docs/en/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md index d1b12dc93..7579c7279 100644 --- a/docs/en/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md +++ b/docs/en/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md @@ -7,7 +7,7 @@ lang: en # Fixing the SSL: CERTIFICATE_VERIFY_FAILED issues with the Python API -The Python API relies on a list of certificates that is bundled with the API and on your machine in order to connect to the various webservices Shotgun uses. Unfortunately, new certificate authorities can be released and those might not be bundled with the Python API or OS. +The Python API relies on a list of certificates that is bundled with the API and on your machine in order to connect to the various webservices {% include product %} uses. Unfortunately, new certificate authorities can be released and those might not be bundled with the Python API or OS. While our Python API comes with a very recent copy of the certificates, as of February 21st 2019, there’s a bug that prevents the API from using those certificates for Amazon S3 uploads, even if you are using the latest version of the API. For background please see [this AWS blog post](https://aws.amazon.com/blogs/security/how-to-prepare-for-aws-move-to-its-own-certificate-authority/). To remediate the situation temporarily, you can try the following solutions. @@ -34,7 +34,7 @@ Add the required CA certificate to the Windows Certificate Store. Windows 7 user 1. Upgrade to the Python API **v3.0.39** -2. a. Set `SHOTGUN_API_CACERTS` to `/path/to/shotgun_api3/lib/httplib2/cacerts.txt` +2. a. Set `{% include product %}_API_CACERTS` to `/path/to/shotgun_api3/lib/httplib2/cacerts.txt` or @@ -47,7 +47,7 @@ the `core/core_api.yml` file of your pipeline configuration, depending on how yo 2. Download an up-to-date list of certificates at [https://github.com/certifi/python-certifi/blob/master/certifi/cacert.pem](https://github.com/certifi/python-certifi/blob/master/certifi/cacert.pem). -3. Set `SHOTGUN_API_CACERTS` to the location where you saved this file. Toolkit doesn’t allow you to specify the `ca_certs` parameter when creating connections the way the Python API does. +3. Set `{% include product %}_API_CACERTS` to the location where you saved this file. Toolkit doesn’t allow you to specify the `ca_certs` parameter when creating connections the way the Python API does. ### If you can’t update the Python API or Toolkit diff --git a/docs/en/quick-answers/troubleshooting/houdini-integrations-not-starting.md b/docs/en/quick-answers/troubleshooting/houdini-integrations-not-starting.md index 714a95eec..a16b503ee 100644 --- a/docs/en/quick-answers/troubleshooting/houdini-integrations-not-starting.md +++ b/docs/en/quick-answers/troubleshooting/houdini-integrations-not-starting.md @@ -5,17 +5,17 @@ pagename: houdini-integrations-not-starting lang: en --- -# Why are my Houdini Shotgun integrations not starting? +# Why are my Houdini {% include product %} integrations not starting? -This covers the most common reason we’ve seen for the Shotgun integrations not starting in Houdini. In this case, -Houdini launches without error from Shotgun Desktop, your Shotgun website, or the tank command. However, once Houdini -is launched, the Shotgun menu or shelf does not appear. +This covers the most common reason we’ve seen for the {% include product %} integrations not starting in Houdini. In this case, +Houdini launches without error from {% include product %} Desktop, your {% include product %} website, or the tank command. However, once Houdini +is launched, the {% include product %} menu or shelf does not appear. -Often the reason for this is that the `HOUDINI_PATH` environment variable has been overridden, and Shotgun relies on that +Often the reason for this is that the `HOUDINI_PATH` environment variable has been overridden, and {% include product %} relies on that for passing the startup script path. -When Houdini is launched from Shotgun, the launch app logic adds the Shotgun bootstrap script path to the `HOUDINI_PATH` +When Houdini is launched from {% include product %}, the launch app logic adds the {% include product %} bootstrap script path to the `HOUDINI_PATH` environment variable. However, the problem can arise when Houdini has a [houdini.env file](http://www.sidefx.com/docs/houdini/basics/config_env.html#setting-environment-variables). This file allows the user to set environment variables that will be present when Houdini is loaded, but any values @@ -32,7 +32,7 @@ Then you should add `$HOUDINI_PATH;` to the end of the path defined in the file HOUDINI_PATH = /example/of/an/existing/path;$HOUDINI_PATH;& -This will allow the Shotgun set value to persist when Houdini launches. +This will allow the {% include product %} set value to persist when Houdini launches. {% include warning title="Caution" content="On Windows we've seen `$HOUDINI_PATH` causing issues. It sometimes tries to bootstrap the Shotgun integration multiple times generating an error like this: diff --git a/docs/en/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md b/docs/en/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md index d6079b3c2..8e134ba57 100644 --- a/docs/en/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md +++ b/docs/en/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md @@ -5,24 +5,24 @@ pagename: menu-entries-missing-in-launched-dcc lang: en --- -# I've launched Nuke/Maya/etc. from Shotgun Desktop, but the Shotgun menu is missing entries +# I've launched Nuke/Maya/etc. from {% include product %} Desktop, but the {% include product %} menu is missing entries -The actions that show up in the Shotgun menu are contextually configured. That means the list of available actions may be different depending on the context you’re in. +The actions that show up in the {% include product %} menu are contextually configured. That means the list of available actions may be different depending on the context you’re in. It's possible you may not be seeing the app you're after because you're in the wrong context. ## Example -When you launch an application from [Shotgun Desktop](https://support.shotgunsoftware.com/entries/95442947), it puts you in the project environment by default. This environment is managed by the config file in your pipeline configuration located at `config/env/project.yml`. Because most user's work will probably not be done in this environment, it's not configured with many apps for you to work with. +When you launch an application from [{% include product %} Desktop](https://support.shotgunsoftware.com/entries/95442947), it puts you in the project environment by default. This environment is managed by the config file in your pipeline configuration located at `config/env/project.yml`. Because most user's work will probably not be done in this environment, it's not configured with many apps for you to work with. **Default Maya Project actions:** -![Shotgun Menu project actions](images/shotgun-menu-project-actions.png) +![{% include product %} Menu project actions](images/shotgun-menu-project-actions.png) -You can use the [Shotgun Workfiles app](https://support.shotgunsoftware.com/hc/en-us/articles/219033088-Your-Work-Files) to select the Asset, Shot, or Task to work on. This will load up the appropriate new environment for you which will then have more apps enabled with menu items in your Shotgun menu. +You can use the [{% include product %} Workfiles app](https://support.shotgunsoftware.com/hc/en-us/articles/219033088-Your-Work-Files) to select the Asset, Shot, or Task to work on. This will load up the appropriate new environment for you which will then have more apps enabled with menu items in your {% include product %} menu. **Default Maya Asset Task actions:** -![Shotgun Menu project actions](images/shotgun-menu-asset-step-actions.png) +![{% include product %} Menu project actions](images/shotgun-menu-asset-step-actions.png) If you believe you're in the correct environment and the actions are still not showing, then the next step is to check the relevant [log](where-are-my-log-files.md), and see if there are any errors. You may need to [enable debug logging](turn-debug-logging-on.md) to get the full output. \ No newline at end of file diff --git a/docs/en/quick-answers/troubleshooting/nuke-path-environment-variable.md b/docs/en/quick-answers/troubleshooting/nuke-path-environment-variable.md index fd5cbcefe..f8fba09c1 100644 --- a/docs/en/quick-answers/troubleshooting/nuke-path-environment-variable.md +++ b/docs/en/quick-answers/troubleshooting/nuke-path-environment-variable.md @@ -10,7 +10,7 @@ lang: en Our integrations set the `NUKE_PATH` environment variable when launching Nuke so that our bootstrap script runs during the Nuke startup process. It's the [`tk-multi-launchapp`](https://support.shotgunsoftware.com/hc/en-us/articles/219032968-Application-Launcher#Set%20Environment%20Variables%20and%20Automate%20Behavior%20at%20Launch) that specifically defines the `NUKE_PATH` prior to it executing the [`before_launch_app.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/6a884aa144851148e8369e9f35a2471087f98d16/hooks/before_app_launch.py) hook. -If you're setting this environment variable during the launch process using something like `os.environ['NUKE_PATH'] = "/my/custom/path"`, then the Shotgun integration won't ever be started, because you'll have removed our startup script path from the environment variable. +If you're setting this environment variable during the launch process using something like `os.environ['NUKE_PATH'] = "/my/custom/path"`, then the {% include product %} integration won't ever be started, because you'll have removed our startup script path from the environment variable. Use this function in `tank.util` to append or prepend your path to the `NUKE_PATH` environment variable, while preserving the path to the Toolkit bootstrap: diff --git a/docs/en/quick-answers/troubleshooting/performance-troubleshooting.md b/docs/en/quick-answers/troubleshooting/performance-troubleshooting.md index 7502ecb0d..3bba42f8f 100644 --- a/docs/en/quick-answers/troubleshooting/performance-troubleshooting.md +++ b/docs/en/quick-answers/troubleshooting/performance-troubleshooting.md @@ -7,14 +7,14 @@ lang: en # Performance troubleshooting -You may come across situations where Toolkit usage can become slow. There can be many reasons for encountering this, ranging from issues with the client side infrastructure such as server speeds or internet connection, to configuration based issues where Toolkit or Shotgun is not configured in a performant way, to areas of our code that could use further optimization. +You may come across situations where Toolkit usage can become slow. There can be many reasons for encountering this, ranging from issues with the client side infrastructure such as server speeds or internet connection, to configuration based issues where Toolkit or {% include product %} is not configured in a performant way, to areas of our code that could use further optimization. Here is a quick list of things to check which we cover in further detail below: -- Make sure your apps, engines, frameworks, core, and Shotgun Desktop [are up to date](#keeping-up-to-date). +- Make sure your apps, engines, frameworks, core, and {% include product %} Desktop [are up to date](#keeping-up-to-date). - Ensure [debug logging](./turn-debug-logging-on.md) is not enabled during general use. - Only [create the folders that you need to](#folder-creation-is-slow), and limit folders so they are only created when they are actually needed. Adding too many folders to your schema will slow things down. -- Storing your user caches on a server can be slow. You can redirect the user’s Shotgun cache by setting the [`SHOTGUN_HOME` environment variable](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables) to point to a location on your local drive. +- Storing your user caches on a server can be slow. You can redirect the user’s {% include product %} cache by setting the [`{% include product %}_HOME` environment variable](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables) to point to a location on your local drive. - [Configure the workfiles and loader apps](#file-open-file-save-or-the-loader-app-is-slow) to filter out content that is not needed by the artist. Consider filtering by statuses to help keep the list of entities short and relevant to the artist’s current tasks. - Check to see if you have any custom hooks and that they are not adding additional overhead. @@ -40,13 +40,13 @@ Table of Contents: ### Cache Location -Shotgun Toolkit [caches data to the user’s home directory](../administering/where-is-my-cache.md). This cache can include a number of different SQLite databases as well as cached apps and configs. Normally the user’s home directory is stored on the machine’s local hard drives, but it's fairly common for studios to redirect them to network storage. Doing this can impact performance—most notably to the SQLite databases, which are used for browser integration and folder creation/lookup among other things. +{% include product %} Toolkit [caches data to the user’s home directory](../administering/where-is-my-cache.md). This cache can include a number of different SQLite databases as well as cached apps and configs. Normally the user’s home directory is stored on the machine’s local hard drives, but it's fairly common for studios to redirect them to network storage. Doing this can impact performance—most notably to the SQLite databases, which are used for browser integration and folder creation/lookup among other things. -If your user directories are stored on a server location, we recommend repathing the Shotgun Toolkit cache using the [`SHOTGUN_HOME` environment variable](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables). The `SHOTGUN_HOME` environment variable is used to set the location where Toolkit caches various data, such as the bundle cache, thumbnails, SQLite databases used for fast lookup of data and other things. +If your user directories are stored on a server location, we recommend repathing the {% include product %} Toolkit cache using the [`{% include product %}_HOME` environment variable](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables). The `{% include product %}_HOME` environment variable is used to set the location where Toolkit caches various data, such as the bundle cache, thumbnails, SQLite databases used for fast lookup of data and other things. ### Debugging -You can enable debug logging in Shotgun Toolkit, so that you can get more verbose output from the various processes. This can be incredibly useful when trying to diagnose issues, however, the debug setting is not designed to be enabled during normal everyday use. The increase in logging output can significantly impact performance. +You can enable debug logging in {% include product %} Toolkit, so that you can get more verbose output from the various processes. This can be incredibly useful when trying to diagnose issues, however, the debug setting is not designed to be enabled during normal everyday use. The increase in logging output can significantly impact performance. When encountering performance issues, especially ones that are localized to specific machines or users, first check that [debug logging](./turn-debug-logging-on.md) isn’t enabled. @@ -72,22 +72,22 @@ In summary, if you have slow storage but a reasonable internet connection, then {% include info title="Note" content="If you are interested in the distributed configs but are concerned about downloading the dependencies per machine, it is possible to centralize just your bundle cache so that it is shared among all users." %} -When using distributed configs, a user will only have to download something if it is not already found in the cache, and once one user has downloaded it, others will be able to benefit from it as well. To achieve this you can set the [`SHOTGUN_BUNDLE_CACHE_PATH` environment variable](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables) on each machine to point to the shared location. +When using distributed configs, a user will only have to download something if it is not already found in the cache, and once one user has downloaded it, others will be able to benefit from it as well. To achieve this you can set the [`{% include product %}_BUNDLE_CACHE_PATH` environment variable](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables) on each machine to point to the shared location. ## Launching software is slow -You may notice that when launching software such as Maya, Nuke, Houdini, or others, they take longer to start up than without Shotgun. It is normal that they may take a short while longer than without Shotgun, but sometimes these times can increase to unacceptable levels, (normally depending on the software we would expect them to startup in under a minute). This can be one of the more tricky areas to diagnose as there are many processes involved in launching the software. +You may notice that when launching software such as Maya, Nuke, Houdini, or others, they take longer to start up than without {% include product %}. It is normal that they may take a short while longer than without {% include product %}, but sometimes these times can increase to unacceptable levels, (normally depending on the software we would expect them to startup in under a minute). This can be one of the more tricky areas to diagnose as there are many processes involved in launching the software. ### Diagnosis The first thing you should do is figure out under what conditions this is happening. -1. **Is it slow when launching without Shotgun?** - This might seem obvious, but it’s worth checking that the issue only occurs when launching with Shotgun. -2. **Is it slow regardless of which approach you use to launch, i.e., is it about the same if you launch from SG Desktop, or from the SG site using the browser integration?** - If it's slow launching from the Shotgun site but not from SG Desktop, then it could be an issue with the browser integration, or it could point to issues creating the folders on disk. If you’re launching from a context other than a Project, then it will likely be creating more folders on disk so this might explain where the time is taken. It’s also worth noting that we check for the existence of the required folders every time software is launched. +1. **Is it slow when launching without {% include product %}?** - This might seem obvious, but it’s worth checking that the issue only occurs when launching with {% include product %}. +2. **Is it slow regardless of which approach you use to launch, i.e., is it about the same if you launch from SG Desktop, or from the SG site using the browser integration?** - If it's slow launching from the {% include product %} site but not from SG Desktop, then it could be an issue with the browser integration, or it could point to issues creating the folders on disk. If you’re launching from a context other than a Project, then it will likely be creating more folders on disk so this might explain where the time is taken. It’s also worth noting that we check for the existence of the required folders every time software is launched. 3. **Does it happen on all projects?** - If it doesn't, then it’s likely to be something specific to the way the configuration is setup. 4. **Does this happen at specific points in the day?** - If so, then this could point to high demand on the infrastructure, such as server usage being higher at certain times of the day. 5. **Does this happen for all Machines/OSs used?** - If a particular machine is slow, then it's possible there is something outside of Toolkit that is causing the issues. However, clearing the Toolkit cache on that machine is a good first step. Different OSs come with different versions of software and Python packages, and sometimes performance issues can crop up on specific builds. Specifically we have seen issues with performance on Windows using Samba (SMB) shares. There isn’t a fix for this as such, but it’s good to be aware of if you are using it. If you believe the issue is limited to a certain OS, Python package, or software version then please let our [support team](https://support.shotgunsoftware.com/hc/en-us/requests/new) know so they can investigate further. -6. **Does this happen for all users?** - Similar to above, it’s possible that as a different user on the same machine, the issue might disappear. In this situation, start by clearing the user’s local Shotgun cache. Also, make sure debug logging is not enabled for normal production use, as this will impact performance. +6. **Does this happen for all users?** - Similar to above, it’s possible that as a different user on the same machine, the issue might disappear. In this situation, start by clearing the user’s local {% include product %} cache. Also, make sure debug logging is not enabled for normal production use, as this will impact performance. 7. **Is the slow launching exclusive to a specific app/software or are all apps/software launched abnormally slow?** - If specific software is slow to launch, this might mean that there is a configuration issue. It may be worth checking to see if you have any custom hooks set up to run either before or after launch that might be impacting performance. Common hooks used in start up are [`before_app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/master/hooks/before_app_launch.py), [`app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/master/hooks/app_launch.py), and the core hook [`engine_init.py`](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/engine_init.py). There can also be occurrences from time to time where a newer version of software is released and our integrations are suddenly much slower to start. In this situation, you should reach out to [support](https://support.shotgunsoftware.com/hc/en-us/requests/new) to check if they are aware of this, and if there is any known fix. Please provide the version number of the software your using (including patches/service pack if applicable) and the version of the tk engine and core you’re running. ### Is the issue pre or post launch? @@ -99,13 +99,13 @@ The first step performs some initial operations, such as gathering the informati Usually, you can see without looking at the logs if the performance issue lies in the first step of the process or the second: - By watching and seeing if it takes a long time for the software’s splash screen to start. If it does then the issue could well be in the first step. -- By seeing the software begin to start up relatively quickly but then become slow (after getting to the point where it has finished initializing and the Shotgun menu is present). If this is the case then the issue will fall into the second step. +- By seeing the software begin to start up relatively quickly but then become slow (after getting to the point where it has finished initializing and the {% include product %} menu is present). If this is the case then the issue will fall into the second step. Knowing this will help you in the next bit which is looking at the logs. ### Checking the logs -Now you hopefully have some idea of if the issue is in the first step or the second step of the launching; this will help target which log you will be looking in. The logs are broken up per engine, so if the issue appears to be in the pre-launch phase, then you will need to look in either the `tk-desktop.log` or in the `tk-shotgun.log`, depending on if you launched from SG Desktop or the SG site respectively. +Now you hopefully have some idea of if the issue is in the first step or the second step of the launching; this will help target which log you will be looking in. The logs are broken up per engine, so if the issue appears to be in the pre-launch phase, then you will need to look in either the `tk-desktop.log` or in the `tk-{% include product %}.log`, depending on if you launched from SG Desktop or the SG site respectively. The next thing you should do is enable debug logging. {% include info title="Note" content="If it was already enabled, as [mentioned above](#debugging) this could be a cause for sluggishness, so you should also test without it enabled" %} @@ -117,14 +117,14 @@ For example, here are a few lines where a 5 second jump in time occurs during fo 2019-05-01 11:28:01,847 [82801 INFO sgtk.env.asset.tk-shotgun.tk-shotgun-folders] 1 Asset processed - Processed 66 folders on disk. -Once you locate the jumps in time, the log line will hopefully give you some idea about what was happening at that stage, such as if it occurred during folder creation, or if it was trying to get a Shotgun connection. +Once you locate the jumps in time, the log line will hopefully give you some idea about what was happening at that stage, such as if it occurred during folder creation, or if it was trying to get a {% include product %} connection. Reading logs can be tricky though and the contents may not always make sense, so again you can reach out to [support](https://support.shotgunsoftware.com/hc/en-us/requests/new) to assist you with this bit. ### Common causes of slow software launches |-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Slow internet speed** | Pretty much every aspect of Toolkit usage where it needs to connect and communicate with the Shotgun site will be affected by slow internet speeds. In this case, typically, you will see speed issues in other situations in addition to launching software. However, if the connection is unstable rather than slow, you’re more likely to run into performance issues during launch (as there is quite a bit of Shotgun communication going on throughout the process). | +| **Slow internet speed** | Pretty much every aspect of Toolkit usage where it needs to connect and communicate with the {% include product %} site will be affected by slow internet speeds. In this case, typically, you will see speed issues in other situations in addition to launching software. However, if the connection is unstable rather than slow, you’re more likely to run into performance issues during launch (as there is quite a bit of {% include product %} communication going on throughout the process). | | **Slow server access** | This can certainly affect launch times. If you're using a [centralized config](#centralized-configs-vs-distributed-configs), (i.e., your config is stored on a central server) there can be a lot of I/O as it reads your configuration files. On top of that, launching the software will trigger folder creation for the context it’s being launched in. This means that it will be checking to see if your folders are created, and creating them if not. | | **Folder creation** | As mentioned above, folder creation can be a common cause of slowdown. [See the folder creation performance troubleshooting below for more details.](#folder-creation-is-slow) | @@ -204,7 +204,7 @@ This would mean that these folders would only get created if the folder creation ### Registering folders -During the folder creation process the folders are [registered](../administering/what-is-path-cache.md) so that the paths can be used to look up the context in the future. [As mentioned before](#folder-creation-is-slow), part of this process requires talking to the Shotgun site, which is the central location where the registries are stored. However, these registries are also cached locally to enable faster lookup by the tools. +During the folder creation process the folders are [registered](../administering/what-is-path-cache.md) so that the paths can be used to look up the context in the future. [As mentioned before](#folder-creation-is-slow), part of this process requires talking to the {% include product %} site, which is the central location where the registries are stored. However, these registries are also cached locally to enable faster lookup by the tools. #### SQLite database diff --git a/docs/en/quick-answers/troubleshooting/turn-debug-logging-on.md b/docs/en/quick-answers/troubleshooting/turn-debug-logging-on.md index 649451396..dc8ef3cc8 100644 --- a/docs/en/quick-answers/troubleshooting/turn-debug-logging-on.md +++ b/docs/en/quick-answers/troubleshooting/turn-debug-logging-on.md @@ -11,13 +11,13 @@ Sometimes you want to see more logging data than Toolkit tools output by default {% include info title="Note" content="Not sure where to find your log files? Take a look at our [Where are my log files?](./where-are-my-log-files.md) doc." %} -## Enable debugging through Shotgun Desktop +## Enable debugging through {% include product %} Desktop -The easiest way to enable debugging is to toggle it on through the Shotgun Desktop app. This can be set once you are logged into Shotgun Desktop: click on your profile picture in the bottom right of the app, and select **Advanced -> Toggle Debug Logging**. This setting is persistent between sessions, so remember to turn it off when you are finished. +The easiest way to enable debugging is to toggle it on through the {% include product %} Desktop app. This can be set once you are logged into {% include product %} Desktop: click on your profile picture in the bottom right of the app, and select **Advanced -> Toggle Debug Logging**. This setting is persistent between sessions, so remember to turn it off when you are finished. ![Toggle debug logging in SG Desktop](images/desktop-enable-debug-logging.png) -It should also be noted that when this is toggled on, apps launched from Shotgun Desktop, or even the Toolkit commands through the browser integration, will also inherit this debug state. +It should also be noted that when this is toggled on, apps launched from {% include product %} Desktop, or even the Toolkit commands through the browser integration, will also inherit this debug state. ## Setting up an environment variable @@ -71,7 +71,7 @@ If you are in an advanced setup, there are a few more options for you. This func Every engine has a `debug_logging` setting in the environment file. Turning this on will emit additional debug-level log messages to the default output in your Software (e.g., the script editor in Nuke or Maya). All of the apps running in your engine will emit these debug-level messages so turning this on for the engine will effectively turn it on for all of your apps as well. -This does not output any log messages to a file. We are working on a more standard logging framework that will allow this. The exceptions are [Shotgun Desktop](https://support.shotgunsoftware.com/hc/en-us/articles/219039818-Shotgun-Desktop) and the [Photoshop engine](https://support.shotgunsoftware.com/hc/en-us/articles/115000026653-Photoshop-CC), which log output both in a GUI console and to a file. +This does not output any log messages to a file. We are working on a more standard logging framework that will allow this. The exceptions are [{% include product %} Desktop](https://support.shotgunsoftware.com/hc/en-us/articles/219039818-Shotgun-Desktop) and the [Photoshop engine](https://support.shotgunsoftware.com/hc/en-us/articles/115000026653-Photoshop-CC), which log output both in a GUI console and to a file. ### Turning on debug logging for an engine in your software @@ -151,7 +151,7 @@ If you’re running the tank command and want to see debug output in your termin ---------------------------------------------------------------------- - Welcome to the Shotgun Pipeline Toolkit update checker! + Welcome to the {% include product %} Pipeline Toolkit update checker! This script will check if the Toolkit Core API installed in /sgtk/software/shotgun/scarlet is up to date. diff --git a/docs/en/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md b/docs/en/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md index 1ce639460..b23a3dfcb 100644 --- a/docs/en/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md +++ b/docs/en/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md @@ -9,13 +9,13 @@ lang: en ## What is the problem? -With the release of our After Effects integration, there is a common plugin that can be used by all Adobe apps that integrate with Shotgun. As part of this change, we needed to rename the extension so that we could preserve backward compatibility with our older Photoshop integration and make it possible for studios to cleanly transition to the update. +With the release of our After Effects integration, there is a common plugin that can be used by all Adobe apps that integrate with {% include product %}. As part of this change, we needed to rename the extension so that we could preserve backward compatibility with our older Photoshop integration and make it possible for studios to cleanly transition to the update. -Unfortunately, this also means that it is possible to have two Shotgun extensions installed as you upgrade: +Unfortunately, this also means that it is possible to have two {% include product %} extensions installed as you upgrade: -![Multiple Shotgun extensions showing in the Photoshop menu](./images/photoshop-extension-panel.png) +![Multiple {% include product %} extensions showing in the Photoshop menu](./images/photoshop-extension-panel.png) -The **Shotgun Adobe Panel** is the new one, and should be used when you are using `v1.7.0` of the Photoshop integration or newer. +The **{% include product %} Adobe Panel** is the new one, and should be used when you are using `v1.7.0` of the Photoshop integration or newer. ## How do I fix it? @@ -24,7 +24,7 @@ To get rid of the older extension, you can remove it from the Adobe install loca - OSX: `~/Library/Application Support/Adobe/CEP/extensions/com.sg.basic.ps` - Windows: `%AppData%\Adobe\CEP\extensions\com.sg.basic.ps` -![Multiple Shotgun extensions showing in the Photoshop menu](./images/shotgun-desktop-console-photoshop-extension.png) +![Multiple {% include product %} extensions showing in the Photoshop menu](./images/shotgun-desktop-console-photoshop-extension.png) If you quit Photoshop and remove that directory, then you should have just the one extension on relaunch. diff --git a/docs/en/quick-answers/troubleshooting/where-are-my-log-files.md b/docs/en/quick-answers/troubleshooting/where-are-my-log-files.md index 463490505..7d8c8a352 100644 --- a/docs/en/quick-answers/troubleshooting/where-are-my-log-files.md +++ b/docs/en/quick-answers/troubleshooting/where-are-my-log-files.md @@ -7,7 +7,7 @@ lang: en # Where are my log files? -By default, Shotgun Desktop and Integrations store their log files in the following directory: +By default, {% include product %} Desktop and Integrations store their log files in the following directory: **Mac** @@ -23,6 +23,6 @@ By default, Shotgun Desktop and Integrations store their log files in the follow Log file names are in the form `tk-.log`. Examples include `tk-desktop.log` or `tk-maya.log`. -If you've set the [`SHOTGUN_HOME` environment variable](http://developer.shotgunsoftware.com/tk-core/utils.html#localfilestoragemanager) to override the user's cache location, then the log files will be located in: `$SHOTGUN_HOME/logs`. +If you've set the [`{% include product %}_HOME` environment variable](http://developer.shotgunsoftware.com/tk-core/utils.html#localfilestoragemanager) to override the user's cache location, then the log files will be located in: `$SHOTGUN_HOME/logs`. {% include info title="Note" content="You can also reach this directory from Shotgun Desktop. Selecting a project, click the down-arrow button to the right of the project name, and choose **Open Log Folder**." %} diff --git a/docs/en/reference/pipeline-integrations/env-config-ref.md b/docs/en/reference/pipeline-integrations/env-config-ref.md index fc27ac713..d8fe98c77 100644 --- a/docs/en/reference/pipeline-integrations/env-config-ref.md +++ b/docs/en/reference/pipeline-integrations/env-config-ref.md @@ -17,7 +17,7 @@ At the heart of a Toolkit pipeline is the environment configuration. Within a To ## What is an environment? -The Shotgun Toolkit platform provides a fully customizable set of integrations for commonly used content creation software with which you can build your studio pipeline. Within a project’s configuration, you can specify which software packages have integrations, which specific Toolkit apps are available in each, and your options for each app—building out artists workflows to suit your studio’s needs. +The {% include product %} Toolkit platform provides a fully customizable set of integrations for commonly used content creation software with which you can build your studio pipeline. Within a project’s configuration, you can specify which software packages have integrations, which specific Toolkit apps are available in each, and your options for each app—building out artists workflows to suit your studio’s needs. But often in studio pipelines, it’s common for different types of artists to have different workflows. As a simple example, for artists working on assets, you might want to make texture painting software such as Mari available, whereas for artists working on shots, you might want to make compositing software such as Nuke available. @@ -109,7 +109,7 @@ In our example, only a single engine is defined, `tk-maya`. It has two settings ### The location descriptor -Every Toolkit bundle has a `location` setting, which we refer to as the bundle’s *descriptor*. The descriptor tells Toolkit where to find the given bundle, and depending on its type, whether to access it directly or cache it locally. Some examples of locations that a Toolkit bundle can come from are the Shotgun App Store, a git repository, a path on disk, or a zip file uploaded to your Shotgun site. Each of these has a corresponding descriptor type, with settings specific to that type. Here again is the descriptor for the `tk-maya` engine from the example above: +Every Toolkit bundle has a `location` setting, which we refer to as the bundle’s *descriptor*. The descriptor tells Toolkit where to find the given bundle, and depending on its type, whether to access it directly or cache it locally. Some examples of locations that a Toolkit bundle can come from are the {% include product %} App Store, a git repository, a path on disk, or a zip file uploaded to your {% include product %} site. Each of these has a corresponding descriptor type, with settings specific to that type. Here again is the descriptor for the `tk-maya` engine from the example above: ```yaml location: @@ -118,7 +118,7 @@ Every Toolkit bundle has a `location` setting, which we refer to as the bundle version: v0.9.4 ``` -This is a descriptor of type `app_store`, which tells Toolkit to get the given bundle from the Shotgun App Store. Descriptors of type `app_store` have the settings `name` and `version`. +This is a descriptor of type `app_store`, which tells Toolkit to get the given bundle from the {% include product %} App Store. Descriptors of type `app_store` have the settings `name` and `version`. In contrast, if you are actively developing a custom bundle—say you’re working on writing a Toolkit app for a specific workflow in your studio, you may want to get it directly from a path on disk. In this case you’d use a descriptor of type `dev`, which might look like this: diff --git a/docs/en/shotgun.md b/docs/en/shotgun.md index 3174021d5..9d3f5d17c 100644 --- a/docs/en/shotgun.md +++ b/docs/en/shotgun.md @@ -5,13 +5,13 @@ pagename: shotgun-index lang: en --- -# Shotgun Development +# {% include product %} Development Managing a production takes a lot of work to keep all the moving pieces in sync. -Use our Shotgun REST API or Python API to connect directly to your data, the Event Trigger Framework to automate repetitive tasks, and Action Menu Items to launch your apps directly from Shotgun's web interface. +Use our {% include product %} REST API or Python API to connect directly to your data, the Event Trigger Framework to automate repetitive tasks, and Action Menu Items to launch your apps directly from {% include product %}'s web interface. -We encourage you to use Shotgun APIs to develop your own services, applications, modules, and components that operate on or with the Service for your own and your Authorized Users’ use. +We encourage you to use {% include product %} APIs to develop your own services, applications, modules, and components that operate on or with the Service for your own and your Authorized Users’ use. {% include warning title="Authentication Keys" content="We ask that you do not disclose (and do not permit your Authorized Users to disclose) API Information that includes authentication keys or other means that could allow users to access the Service or its functionality without a log on, or use the APIs yourself to access or allow users to access the Service or its functionality without a log on." %} diff --git a/docs/en/toolkit.md b/docs/en/toolkit.md index 1c7ce7a61..c4bfd238e 100644 --- a/docs/en/toolkit.md +++ b/docs/en/toolkit.md @@ -7,6 +7,6 @@ lang: en # Pipeline Integrations -Shotgun includes integrations that bring the Shotgun experience into the creative tools artists use every day. Out of the box, you get plugin within artists’ tools that give you the foundation for a basic publish pipeline. +{% include product %} includes integrations that bring the {% include product %} experience into the creative tools artists use every day. Out of the box, you get plugin within artists’ tools that give you the foundation for a basic publish pipeline. These integrations are built on the Toolkit platform, a set of APIs, UIs, and configurations that give studios the tools to build custom workflows. diff --git a/docs/en/trusted-solutions/cloud.md b/docs/en/trusted-solutions/cloud.md index 84d4854ae..556e249e3 100644 --- a/docs/en/trusted-solutions/cloud.md +++ b/docs/en/trusted-solutions/cloud.md @@ -5,11 +5,11 @@ pagename: cloud-index lang: en --- -# Shotgun in the Cloud +# {% include product %} in the Cloud -## What is Shotgun in the Cloud? +## What is {% include product %} in the Cloud? -Shotgun Cloud is our default offering, hosted on AWS and built on top of Autodesk's Cloud technology platform. Shotgun Cloud is the latest generation of our hosted service and is completely cloud based. +{% include product %} Cloud is our default offering, hosted on AWS and built on top of Autodesk's Cloud technology platform. {% include product %} Cloud is the latest generation of our hosted service and is completely cloud based. ## Further Reading diff --git a/docs/en/trusted-solutions/tier1.md b/docs/en/trusted-solutions/tier1.md index 76c6e5a7e..794358a37 100644 --- a/docs/en/trusted-solutions/tier1.md +++ b/docs/en/trusted-solutions/tier1.md @@ -9,7 +9,7 @@ lang: en ![isolation-theme](./tier1/images/isolation_theme.jpg) -The isolation feature set is an hybrid solution that satisfies strict security and legal requirements, while minimizing Shotgun System Admin specific required knowledge and maintenance. These features enable creative studios to confidently meet their supplier’s and studio’s highly stringent security, privacy, and performance requirements—from the cloud. +The isolation feature set is an hybrid solution that satisfies strict security and legal requirements, while minimizing {% include product %} System Admin specific required knowledge and maintenance. These features enable creative studios to confidently meet their supplier’s and studio’s highly stringent security, privacy, and performance requirements—from the cloud. Continue to [About the isolation feature set](./tier1/getting_started/about.md) for more details. @@ -46,7 +46,7 @@ Go to [Setup](./tier1/setup/setup.md) if you are ready to activate the Isolation ### AWS Knowledge * [Connecting Your Studio With Your AWS VPC](./tier1/knowledge/connecting.md) -* [Shotgun AWS Direct Connect Onboarding](./tier1/knowledge/direct_connect_onboarding.md) +* [{% include product %} AWS Direct Connect Onboarding](./tier1/knowledge/direct_connect_onboarding.md) * [S3](./tier1/knowledge/s3.md) * [VPC / IAM / Security Group](./tier1/knowledge/vpc_iam_sec.md) * [Direct Connect](./tier1/knowledge/direct_connect.md) diff --git a/docs/en/trusted-solutions/tier1/features/media_isolation.md b/docs/en/trusted-solutions/tier1/features/media_isolation.md index 2c28cf6ba..a50d57fdf 100644 --- a/docs/en/trusted-solutions/tier1/features/media_isolation.md +++ b/docs/en/trusted-solutions/tier1/features/media_isolation.md @@ -6,7 +6,7 @@ lang: en --- # Media Isolation -Media Isolation allows your studio to retain ownership and control of the media and attachments that you upload to Shotgun. With Media Isolation, all the content that you upload to Shotgun is stored in your studio's private S3 Bucket. Access to the media is provided to the Shotgun services only, using [AWS AssumeRole keyless Security Token Service](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html). +Media Isolation allows your studio to retain ownership and control of the media and attachments that you upload to {% include product %}. With Media Isolation, all the content that you upload to {% include product %} is stored in your studio's private S3 Bucket. Access to the media is provided to the {% include product %} services only, using [AWS AssumeRole keyless Security Token Service](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html). media-isolation-overview @@ -16,13 +16,13 @@ Storing media and attachments in an S3 bucket that you own means that you remain media-isolation-arch ## More about Access -When using Shotgun to upload and download media it is transferred directly to / from AWS S3 without transiting through Autodesk infrastructure. Shotgun will only access media in two situations: -1. The Shotgun Transcoding service will get read/write access once, soon after upload, when transcoding the media. See [Ephemeral Transcoding](../getting_started/about.md#ephemeral-transcoding) for details. -2. When the Shotgun service generates S3 Links to your sources and transcoded media. +When using {% include product %} to upload and download media it is transferred directly to / from AWS S3 without transiting through Autodesk infrastructure. {% include product %} will only access media in two situations: +1. The {% include product %} Transcoding service will get read/write access once, soon after upload, when transcoding the media. See [Ephemeral Transcoding](../getting_started/about.md#ephemeral-transcoding) for details. +2. When the {% include product %} service generates S3 Links to your sources and transcoded media. -This is rendered possible by leveraging [AWS AssumeRole keyless Security Token Service](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html). When setting up Media Isolation, an AWS Role allowing Shotgun to access your media for the action listed above is created, and the Shotgun service is allowed to assume that role. +This is rendered possible by leveraging [AWS AssumeRole keyless Security Token Service](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html). When setting up Media Isolation, an AWS Role allowing {% include product %} to access your media for the action listed above is created, and the {% include product %} service is allowed to assume that role. -Shotgun Support staff do not have access to your S3 Bucket under any circumstances. +{% include product %} Support staff do not have access to your S3 Bucket under any circumstances. ## Costs When activating Media Isolation the following costs, previously covered by Autodesk, become the responsibility of the client: @@ -30,4 +30,4 @@ When activating Media Isolation the following costs, previously covered by Autod 2. **S3 Bandwidth.** Bandwidth out of the S3 bucket will be assumed by the customer. ## What Media Isolation is not providing -Activating Media Isolation doesn't guarantee that the access to your Shotgun site or media takes place within a closed network. \ No newline at end of file +Activating Media Isolation doesn't guarantee that the access to your {% include product %} site or media takes place within a closed network. \ No newline at end of file diff --git a/docs/en/trusted-solutions/tier1/features/media_replication.md b/docs/en/trusted-solutions/tier1/features/media_replication.md index d97995517..5fde47dbb 100644 --- a/docs/en/trusted-solutions/tier1/features/media_replication.md +++ b/docs/en/trusted-solutions/tier1/features/media_replication.md @@ -7,7 +7,7 @@ lang: en # Media Replication -Shotgun is compatible with the S3 Cross-Region replication feature, allowing your users located in different regions to read from the region closer to them in order to reduce latency and increase throughput. Replication to one region is currently supported. +{% include product %} is compatible with the S3 Cross-Region replication feature, allowing your users located in different regions to read from the region closer to them in order to reduce latency and increase throughput. Replication to one region is currently supported. media-replication-overview @@ -15,23 +15,23 @@ Shotgun is compatible with the S3 Cross-Region replication feature, allowing you Media Isolation is required in order to elect Media Replication. ## Configuration by users -When using Media Replication, each user can customize which region data is read from. A user can either specify the region to use, or use automatic mode. In automatic mode Shotgun selects the replica determined by the user's IP address using IP ranges specified in the Isolation Preferences. +When using Media Replication, each user can customize which region data is read from. A user can either specify the region to use, or use automatic mode. In automatic mode {% include product %} selects the replica determined by the user's IP address using IP ranges specified in the Isolation Preferences. media-replication-preferences ## How it works -Shotgun can be configured to read from up to two different buckets. Using the [AWS S3 Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) feature, you can configure replication between buckets in different regions, and then consume media from the region closest to your users. It is important to underline that media is always uploaded to the main bucket. +{% include product %} can be configured to read from up to two different buckets. Using the [AWS S3 Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) feature, you can configure replication between buckets in different regions, and then consume media from the region closest to your users. It is important to underline that media is always uploaded to the main bucket. media-replication-arch Following AWS service level agreement, S3 guarantees the replication of 99.99% of the object within 15 minutes. ### Replication Delay -A small amount of time, typically under 15 minutes, is required before replication happens. The replication time depends on the size of the object to replicate. In order to alleviate that replication delay, Shotgun will, for a small period of time, generate links from to object in the source bucket instead of the replica. The duration of this transitional state in configurable in the Isolation Preferences. +A small amount of time, typically under 15 minutes, is required before replication happens. The replication time depends on the size of the object to replicate. In order to alleviate that replication delay, {% include product %} will, for a small period of time, generate links from to object in the source bucket instead of the replica. The duration of this transitional state in configurable in the Isolation Preferences. ## Costs Activating the Media Replication feature can increase your AWS costs considerabibly. Before activating, be aware that: -1. Your S3 cost linked to Shotgun usage will more or less double, because the media is now stored in two regions. +1. Your S3 cost linked to {% include product %} usage will more or less double, because the media is now stored in two regions. 2. You will be charged for the transfer cost between the source and the destination region. See [AWS S3 CRR and the destination region](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-and-other-bucket-configs.html#replication-and-dest-region) for more details. ## Next Steps diff --git a/docs/en/trusted-solutions/tier1/features/media_traffic_isolation.md b/docs/en/trusted-solutions/tier1/features/media_traffic_isolation.md index f4db94f1e..1b6d36037 100644 --- a/docs/en/trusted-solutions/tier1/features/media_traffic_isolation.md +++ b/docs/en/trusted-solutions/tier1/features/media_traffic_isolation.md @@ -15,7 +15,7 @@ Communication between your client systems and S3 bucket targets a number of AWS An S3 Proxy component is deployed within your VPC; which is then used as the endpoint for all S3 communication. It can also be made publicly available using AWS Global Accelerator. ## How it works -Shotgun can be configured to use an S3 Proxy address to communicate with your S3 bucket. Deploying the S3 Proxy component within your VPC makes it possible to isolate traffic from the public Internet completely, or to allow more tightly controlled access from the Internet to your media. +{% include product %} can be configured to use an S3 Proxy address to communicate with your S3 bucket. Deploying the S3 Proxy component within your VPC makes it possible to isolate traffic from the public Internet completely, or to allow more tightly controlled access from the Internet to your media. media-traffic-isolation-arch diff --git a/docs/en/trusted-solutions/tier1/features/web_traffic_isolation.md b/docs/en/trusted-solutions/tier1/features/web_traffic_isolation.md index e0c936773..e062739bc 100644 --- a/docs/en/trusted-solutions/tier1/features/web_traffic_isolation.md +++ b/docs/en/trusted-solutions/tier1/features/web_traffic_isolation.md @@ -7,7 +7,7 @@ lang: en # Web Traffic Isolation -Communication between your client systems and your Shotgun site will traverse the open Internet by default. Web Traffic Isolation allows you to restrict access to your Shotgun site from the public Internet entirely and ensure that all traffic transits directly between your AWS VPC and Autodesk's AWS VPC. +Communication between your client systems and your {% include product %} site will traverse the open Internet by default. Web Traffic Isolation allows you to restrict access to your {% include product %} site from the public Internet entirely and ensure that all traffic transits directly between your AWS VPC and Autodesk's AWS VPC. web-traffic-isolation-overview diff --git a/docs/en/trusted-solutions/tier1/getting_started/about.md b/docs/en/trusted-solutions/tier1/getting_started/about.md index 0cd67e752..2798bcb09 100644 --- a/docs/en/trusted-solutions/tier1/getting_started/about.md +++ b/docs/en/trusted-solutions/tier1/getting_started/about.md @@ -7,7 +7,7 @@ lang: en # What is the Isolation Feature Set -The isolation feature set combines our Cloud Hosted Platform with client-managed AWS resources to provide a solution that satisfies the most stringent security and privacy requirements. Clients retain control of their sensitive content without having to host Shotgun on their infrastructure. +The isolation feature set combines our Cloud Hosted Platform with client-managed AWS resources to provide a solution that satisfies the most stringent security and privacy requirements. Clients retain control of their sensitive content without having to host {% include product %} on their infrastructure. Leveraging the isolation feature set has the following advantages over the Standard offering: @@ -15,28 +15,28 @@ Leveraging the isolation feature set has the following advantages over the Stand * **Web Traffic Isolation** from the public internet * **Media Traffic Isolation** from the public internet * **Media Replication** allowing you to replicate media in one additional AWS Region -* Access to fully managed Shotgun Cloud Services +* Access to fully managed {% include product %} Cloud Services * Automatic and continuous version upgrades * Ephemeral compute + in-memory segration between clients -In a nutshell, this means that with the isolation features, your Shotgun site and the data related to it cannot be reached by anyone outside of your studio network. +In a nutshell, this means that with the isolation features, your {% include product %} site and the data related to it cannot be reached by anyone outside of your studio network. -The isolation feature set is a solution that requires less upkeep, as well as less IT/System Administrator knowledge and skills, than hosting Shotgun on-premise. The list of advantages compared to on-premise includes, but is not limited to: +The isolation feature set is a solution that requires less upkeep, as well as less IT/System Administrator knowledge and skills, than hosting {% include product %} on-premise. The list of advantages compared to on-premise includes, but is not limited to: -* No Shotgun specific knowledge required -* No manual Shotgun updates required +* No {% include product %} specific knowledge required +* No manual {% include product %} updates required * Very low level of maintenance required for the AWS components ## Media isolation feature -Media Isolation allows your studio to keep the ownership and control of the media and attachments that you upload to Shotgun. With Media Isolation, all the content that you upload to Shotgun can be store in your studio private S3 bucket. Access to the media is provided to the Shotgun service only, using AWS AssumeRole keyless Security Token Service. Your studio remains in control of the assets and the access to the assets, access that you can revoke at will. +Media Isolation allows your studio to keep the ownership and control of the media and attachments that you upload to {% include product %}. With Media Isolation, all the content that you upload to {% include product %} can be store in your studio private S3 bucket. Access to the media is provided to the {% include product %} service only, using AWS AssumeRole keyless Security Token Service. Your studio remains in control of the assets and the access to the assets, access that you can revoke at will. ## Traffic isolation features -Media and Web traffic isolation features can be enabled to prevent your traffic from being routed on the public internet, limiting it to the AWS backbone and your studio network. The traffic between Shotgun Services and your studio stays in closed network, never going outside AWS or your Studio network. +Media and Web traffic isolation features can be enabled to prevent your traffic from being routed on the public internet, limiting it to the AWS backbone and your studio network. The traffic between {% include product %} Services and your studio stays in closed network, never going outside AWS or your Studio network. With the Media Traffic Isolation feature activated, the media will only leave your studio infrastructure once to get transcoded. ## Media Replication -Shotgun is compatible with the S3 Cross-Region replication feature, allowing your users located in different regions to read from the region closer to them in order to reduce latency and increase throughput. Replication to one region is currently supported. +{% include product %} is compatible with the S3 Cross-Region replication feature, allowing your users located in different regions to read from the region closer to them in order to reduce latency and increase throughput. Replication to one region is currently supported. # Eligibility @@ -46,26 +46,26 @@ The Isolation feature set is available for all Super Awesome clients. See [Getti # What the Isolation Feature Set is not -The isolation feature set is not a completely isolated solution. Both the compute services and the database services are shared amongst clients, and managed by Shotgun. From a hardware standpoint, the isolation features does not guarantee complete physical isolation. However, Shotgun services are guaranteeing isolation at the memory level. Processes are never reused to answer requests from different clients during their lifetime. Client metadata is stored in different databases. Client media is individually stored on S3. +The isolation feature set is not a completely isolated solution. Both the compute services and the database services are shared amongst clients, and managed by {% include product %}. From a hardware standpoint, the isolation features does not guarantee complete physical isolation. However, {% include product %} services are guaranteeing isolation at the memory level. Processes are never reused to answer requests from different clients during their lifetime. Client metadata is stored in different databases. Client media is individually stored on S3. # High Level Architecture ![tier1-arch](../images/tier1-about-arch.png) -The Shotgun cloud service can be decoupled at a high level in 3 parts: +The {% include product %} cloud service can be decoupled at a high level in 3 parts: -**Compute Stack:** The part of the Shotgun Service that handles client requests and serves data to the client. +**Compute Stack:** The part of the {% include product %} Service that handles client requests and serves data to the client. **Data Stack:** Metadata storage (databases). -**Media Storage:** Where the client's attachments, media, and assets are stored. Shotgun uses AWS S3 to store client content. +**Media Storage:** Where the client's attachments, media, and assets are stored. {% include product %} uses AWS S3 to store client content. -Please read [Securing Studio IP in AWS: Cloud-based VFX Project Management with Autodesk Shotgun](https://aws.amazon.com/blogs/media/securing-studio-ip-in-aws-cloud-based-vfx-project-management-with-autodesk-shotgun/) for more details about the architecture. +Please read [Securing Studio IP in AWS: Cloud-based VFX Project Management with Autodesk {% include product %}](https://aws.amazon.com/blogs/media/securing-studio-ip-in-aws-cloud-based-vfx-project-management-with-autodesk-shotgun/) for more details about the architecture. ## Ephemeral compute and memory isolation -Even if clients share the same infrastructure, Shotgun guarantees a complete memory isolation, both in transit and at rest, of client data. This makes Shotgun less prone to data leaking due to architecture flaws or software vulnerabilities exploiting memory, like buffer overflow. +Even if clients share the same infrastructure, {% include product %} guarantees a complete memory isolation, both in transit and at rest, of client data. This makes {% include product %} less prone to data leaking due to architecture flaws or software vulnerabilities exploiting memory, like buffer overflow. ## Ephemeral transcoding ![tier1-transcoding](../images/tier1-about-transcoding.png) -Everytime media is uploaded to Shotgun, the transcoding service is invoked to create a web friendly versions of your assets. That process happens only once, after the initial upload. The media is directly uploaded from the client to S3, from where it is fetched by the Shotgun Transcoding Service. Each transcoding job is handled by a single container, which is killed after that unique job. The only place the media temporarily lives is in the container memory. The Shotgun Transcoding service doesn't store permanently a copy of your media. +Everytime media is uploaded to {% include product %}, the transcoding service is invoked to create a web friendly versions of your assets. That process happens only once, after the initial upload. The media is directly uploaded from the client to S3, from where it is fetched by the {% include product %} Transcoding Service. Each transcoding job is handled by a single container, which is killed after that unique job. The only place the media temporarily lives is in the container memory. The {% include product %} Transcoding service doesn't store permanently a copy of your media. diff --git a/docs/en/trusted-solutions/tier1/getting_started/onboarding.md b/docs/en/trusted-solutions/tier1/getting_started/onboarding.md index c5066dfa9..0b21a5580 100644 --- a/docs/en/trusted-solutions/tier1/getting_started/onboarding.md +++ b/docs/en/trusted-solutions/tier1/getting_started/onboarding.md @@ -11,7 +11,7 @@ Leveraging the isolation features requires adopters to become AWS users. In orde Autodesk and Amazon will provide dedicated resources during the onboarding process to help you on this journey. -To start the on-boarding process for any of the Isolation features, please open a [Shotgun Support ticket](https://support.shotgunsoftware.com/hc/en-us/requests/new), before proceeding with [your setup](../setup/setup.md) +To start the on-boarding process for any of the Isolation features, please open a [{% include product %} Support ticket](https://support.shotgunsoftware.com/hc/en-us/requests/new), before proceeding with [your setup](../setup/setup.md) ## Onboarding Process Overview @@ -23,19 +23,19 @@ During the onboarding process, you'll have direct access to Autodesk and AWS Lea **Tech Deep Dive:** OPTIONAL. Deeper technical dive into isolation features. This meeting can be combined with the Tech Briefing. -**Kickoff Meeting:** AWS and Shotgun Leaders review the setup process with the you. +**Kickoff Meeting:** AWS and {% include product %} Leaders review the setup process with the you. -**Setup / Test / Validation:** Iterative installation process where you connect your AWS resources to Shotgun, and activate the isolation features. +**Setup / Test / Validation:** Iterative installation process where you connect your AWS resources to {% include product %}, and activate the isolation features. -**Training:** OPTIONAL. Help sessions, if needed, as you ramp up on the AWS/Shotgun technologies required to securely set-up the isolation features for your site. +**Training:** OPTIONAL. Help sessions, if needed, as you ramp up on the AWS/{% include product %} technologies required to securely set-up the isolation features for your site. ## Onboarding Resources -**Shotgun Community:** The [Shotgun Isolation Community](https://community.shotgunsoftware.com/c/trusted-solutions/isolation/34) forum can be used to ask questions that can be answered by either Shotgun Experts or other isolation features users. This should be your first stop when asking general questions about isolation features, during setup and beyond. +**{% include product %} Community:** The [{% include product %} Isolation Community](https://community.shotgunsoftware.com/c/trusted-solutions/isolation/34) forum can be used to ask questions that can be answered by either {% include product %} Experts or other isolation features users. This should be your first stop when asking general questions about isolation features, during setup and beyond. -**Private Slack Channel:** During the onboarding, you will be given access to a dedicated Autodesk Slack Channel. Your Shotgun and AWS Leaders will be available for quick feedback, answers, and ad-hoc meetings to help you progress as fast as possible with your Shotgun Isolation setup. This channel will be available only for the onboarding period. +**Private Slack Channel:** During the onboarding, you will be given access to a dedicated Autodesk Slack Channel. Your {% include product %} and AWS Leaders will be available for quick feedback, answers, and ad-hoc meetings to help you progress as fast as possible with your {% include product %} Isolation setup. This channel will be available only for the onboarding period. -**Shotgun Support:** A [Shotgun Support](https://support.shotgunsoftware.com/hc/en-us/requests/new) ticket will be used to track your onboarding at a higher level. Once your Shotgun Isolation setup is complete, follow-up support tickets can be opened with the support team as needed. +**{% include product %} Support:** A [{% include product %} Support](https://support.shotgunsoftware.com/hc/en-us/requests/new) ticket will be used to track your onboarding at a higher level. Once your {% include product %} Isolation setup is complete, follow-up support tickets can be opened with the support team as needed. ## Next Steps diff --git a/docs/en/trusted-solutions/tier1/getting_started/responsibilities.md b/docs/en/trusted-solutions/tier1/getting_started/responsibilities.md index 3558aec14..6459b59cc 100644 --- a/docs/en/trusted-solutions/tier1/getting_started/responsibilities.md +++ b/docs/en/trusted-solutions/tier1/getting_started/responsibilities.md @@ -15,7 +15,7 @@ You are entirely responsible for the validity, security, and execution of the Is Autodesk is available during the process for assistance, but the configuration of Isolation features in Your AWS Account is to be executed by You on Your own. -Isolation feature set activation requires the Shotgun Support team's intervention. Activation delays are to be expected and will depend on demand. You understand that an estimated period of 2-8 weeks is usually required to complete the setup necessary to implement the isolation feature set. The setup time is highly dependent on your cooperation, so please plan to dedicate resources for the setup before beginning the onboarding process. +Isolation feature set activation requires the {% include product %} Support team's intervention. Activation delays are to be expected and will depend on demand. You understand that an estimated period of 2-8 weeks is usually required to complete the setup necessary to implement the isolation feature set. The setup time is highly dependent on your cooperation, so please plan to dedicate resources for the setup before beginning the onboarding process. Autodesk does not guarantee any timeline for setup completion. @@ -24,13 +24,13 @@ Autodesk does not guarantee any timeline for setup completion. |Type| Description / Agreement | Responsibility | Available for Assistance| |--------|-----|----------|---------| |AWS Knowledge | Acquiring the AWS-specific knowledge required to set up the isolation features. |You |N/A| -|S3|Setting up the S3 Bucket that will host Your media Securing access to the S3 Bucket. Additional high-availability measures (versioning, bucket replication, etc.) |You |Shotgun and *AWS| +|S3|Setting up the S3 Bucket that will host Your media Securing access to the S3 Bucket. Additional high-availability measures (versioning, bucket replication, etc.) |You |{% include product %} and *AWS| |Closed VPC |Setting up DirectConnect/VPN, etc. to allow closed access to the VPC. Securing the VPC by putting the correct Security Groups in place. |You |*AWS | -|Media Isolation |Creating the S3 end-points. Deploying the S3 Proxy. |You| Shotgun and *AWS | -|Traffic Isolation |Creating VPCs. Creating Subnets.| You|Shotgun| -|Private Access Point|Checking that the access point is only available from Your network.| Shotgun| N/A| -|Monitoring and Reliability|Maintaining uptime up to Autodesk standards. High availability and redundancy of Cloud Services. Metadata and database resiliency and redundancy. Maintaining Recovery Point Objective (RPO) for metadata and database. |Shotgun|N/A| -|Service Level Objective|Maintaining Shotgun target RPO and RTO (See [Shotgun Security White Paper](https://support.shotgunsoftware.com/hc/en-us/articles/114094526153-Shotgun-security-white-paper) for more details).|Shotgun| N/A| -|Security and Governance |Maintaining the Shotgun Cloud Services that Isolation clients are interfacing with, so that they are meeting expectations in terms of security, vulnerability patching, scanning, auditing, etc. (See [Shotgun Security White Paper](https://support.shotgunsoftware.com/hc/en-us/articles/114094526153-Shotgun-security-white-paper) for more details).| Shotgun |N/A| +|Media Isolation |Creating the S3 end-points. Deploying the S3 Proxy. |You| {% include product %} and *AWS | +|Traffic Isolation |Creating VPCs. Creating Subnets.| You|{% include product %}| +|Private Access Point|Checking that the access point is only available from Your network.| {% include product %}| N/A| +|Monitoring and Reliability|Maintaining uptime up to Autodesk standards. High availability and redundancy of Cloud Services. Metadata and database resiliency and redundancy. Maintaining Recovery Point Objective (RPO) for metadata and database. |{% include product %}|N/A| +|Service Level Objective|Maintaining {% include product %} target RPO and RTO (See [{% include product %} Security White Paper](https://support.shotgunsoftware.com/hc/en-us/articles/114094526153-Shotgun-security-white-paper) for more details).|{% include product %}| N/A| +|Security and Governance |Maintaining the {% include product %} Cloud Services that Isolation clients are interfacing with, so that they are meeting expectations in terms of security, vulnerability patching, scanning, auditing, etc. (See [{% include product %} Security White Paper](https://support.shotgunsoftware.com/hc/en-us/articles/114094526153-Shotgun-security-white-paper) for more details).| {% include product %} |N/A| *You are solely responsible to seek or obtain any support services AWS may provide under any existing relationship between You and AWS. Autodesk teams are not parties to Your relationship with AWS and therefore not responsible or liable for any services or lack thereof provided by AWS to You. diff --git a/docs/en/trusted-solutions/tier1/knowledge/direct_connect_onboarding.md b/docs/en/trusted-solutions/tier1/knowledge/direct_connect_onboarding.md index a98d19fb8..eaf39a0eb 100644 --- a/docs/en/trusted-solutions/tier1/knowledge/direct_connect_onboarding.md +++ b/docs/en/trusted-solutions/tier1/knowledge/direct_connect_onboarding.md @@ -4,7 +4,7 @@ title: Shotgun AWS Direct Connect Onboarding pagename: tier1-knowledge-direct_connect_onboarding --- -# Shotgun AWS Direct Connect Onboarding +# {% include product %} AWS Direct Connect Onboarding ## Introduction @@ -40,7 +40,7 @@ If you answer “yes” to the following, then request a dedicated Direct Connec If you answer “yes” to the following, then request a dedicated Direct Connect connection through the AWS Console and select a Partner to assist (Option 1b): -- Are you planning to use AWS Direct Connect to connect to other AWS resources outside of Shotgun? +- Are you planning to use AWS Direct Connect to connect to other AWS resources outside of {% include product %}? - Do you have the time and resources to complete the setup? - Are you looking for any one of the following - 1Gbps, 10Gbps port, or a dedicated connection? diff --git a/docs/en/trusted-solutions/tier1/knowledge/knowledge.md b/docs/en/trusted-solutions/tier1/knowledge/knowledge.md index 29f709183..6eaae7b9d 100644 --- a/docs/en/trusted-solutions/tier1/knowledge/knowledge.md +++ b/docs/en/trusted-solutions/tier1/knowledge/knowledge.md @@ -10,7 +10,7 @@ lang: en ## In This Section * [Connecting Your Studio With Your AWS VPC](./connecting.md) -* [Shotgun AWS Direct Connect Onboarding](./direct_connect_onboarding.md) +* [{% include product %} AWS Direct Connect Onboarding](./direct_connect_onboarding.md) * [S3](./s3.md) * [VPC / IAM / Security Group](./vpc_iam_sec.md) * [Direct Connect](./direct_connect.md) diff --git a/docs/en/trusted-solutions/tier1/knowledge/private_link.md b/docs/en/trusted-solutions/tier1/knowledge/private_link.md index 096aaaeb2..daa50aa49 100644 --- a/docs/en/trusted-solutions/tier1/knowledge/private_link.md +++ b/docs/en/trusted-solutions/tier1/knowledge/private_link.md @@ -9,4 +9,4 @@ lang: en [AWS PrivateLink](https://aws.amazon.com/privatelink/) is an AWS service that connects different AWS VPCs without going through the public internet. -In conjunction with [AWS Direct Connect](./direct_connect.md), PrivateLink helps create a dedicated connection between your studio and Shotgun's infrastructure. +In conjunction with [AWS Direct Connect](./direct_connect.md), PrivateLink helps create a dedicated connection between your studio and {% include product %}'s infrastructure. diff --git a/docs/en/trusted-solutions/tier1/knowledge/s3.md b/docs/en/trusted-solutions/tier1/knowledge/s3.md index 55295b164..3caac5bbf 100644 --- a/docs/en/trusted-solutions/tier1/knowledge/s3.md +++ b/docs/en/trusted-solutions/tier1/knowledge/s3.md @@ -7,6 +7,6 @@ lang: en # S3 -[Amazon S3](https://aws.amazon.com/s3/) is an object storage service offered by AWS. It can be thought of as a highly durable storage space in the cloud. Shotgun uses S3 to store uploaded media and files. +[Amazon S3](https://aws.amazon.com/s3/) is an object storage service offered by AWS. It can be thought of as a highly durable storage space in the cloud. {% include product %} uses S3 to store uploaded media and files. -In order to use Shotgun isolation features, you will bring your own S3 bucket and configure Shotgun to use it for storage. Please refer to our [S3 Bucket Setup article](../setup/s3_bucket.md) for details on how to do this. +In order to use {% include product %} isolation features, you will bring your own S3 bucket and configure {% include product %} to use it for storage. Please refer to our [S3 Bucket Setup article](../setup/s3_bucket.md) for details on how to do this. diff --git a/docs/en/trusted-solutions/tier1/knowledge/vpc_iam_sec.md b/docs/en/trusted-solutions/tier1/knowledge/vpc_iam_sec.md index 84967e0a2..effbe85bf 100644 --- a/docs/en/trusted-solutions/tier1/knowledge/vpc_iam_sec.md +++ b/docs/en/trusted-solutions/tier1/knowledge/vpc_iam_sec.md @@ -11,6 +11,6 @@ lang: en Within a VPC, [security groups](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) act as a basic firewall and control what inbound and outbound connections are permitted to each given resource. For example, a security group can allow inbound **HTTPS** traffic to a proxy server but block all other inbound traffic. -With [AWS Identity and Access Management (IAM)](https://aws.amazon.com/iam/), access to AWS resources and services can be controlled at a more fine-grained level. For example, IAM can be leveraged to control who or which resources can access S3 buckets used by Shotgun. +With [AWS Identity and Access Management (IAM)](https://aws.amazon.com/iam/), access to AWS resources and services can be controlled at a more fine-grained level. For example, IAM can be leveraged to control who or which resources can access S3 buckets used by {% include product %}. -All three of the above features are used in the Shotgun isolation features implementation to ensure that you securely connect your closed VPC to Shotgun and allow access to the [media S3 buckets](../setup/s3_bucket.md). +All three of the above features are used in the {% include product %} isolation features implementation to ensure that you securely connect your closed VPC to {% include product %} and allow access to the [media S3 buckets](../setup/s3_bucket.md). diff --git a/docs/en/trusted-solutions/tier1/learn/learn.md b/docs/en/trusted-solutions/tier1/learn/learn.md index 2bd8e16cf..fc1364ac6 100644 --- a/docs/en/trusted-solutions/tier1/learn/learn.md +++ b/docs/en/trusted-solutions/tier1/learn/learn.md @@ -5,6 +5,6 @@ pagename: tier1-learn lang: en --- -# Shotgun Isolation - Learn +# {% include product %} Isolation - Learn -This section will host a learning curriculum for Shotgun Isolation features n the near future. \ No newline at end of file +This section will host a learning curriculum for {% include product %} Isolation features n the near future. \ No newline at end of file diff --git a/docs/en/trusted-solutions/tier1/setup/media_segregation.md b/docs/en/trusted-solutions/tier1/setup/media_segregation.md index 3fd5b3d27..d5713187e 100644 --- a/docs/en/trusted-solutions/tier1/setup/media_segregation.md +++ b/docs/en/trusted-solutions/tier1/setup/media_segregation.md @@ -9,7 +9,7 @@ lang: en {% include info title="Disclaimer" content="This documentation is provided solely as an example. It explains how to set up your Shotgun Isolation environment so that it can be connected to Shotgun cloud infrastructure. Please adapt it to your studio security requirements as needed. As Shotgun has no visibility on your AWS Account, ensuring that this account is secure is a client responsibility." %} -The media traffic isolation feature allows your users to access media in your AWS S3 bucket privately (not transiting over the public Internet). Please note that if you have a multi-region setup and that leverages the Shotgun Transcoding service there may still be instances where media transits across the public Internet. Reach out to our support team for more details. +The media traffic isolation feature allows your users to access media in your AWS S3 bucket privately (not transiting over the public Internet). Please note that if you have a multi-region setup and that leverages the {% include product %} Transcoding service there may still be instances where media transits across the public Internet. Reach out to our support team for more details. Media Isolation activation is a pre-requisite to enable this feature. If you haven't done so already, see [Media Isolation](./s3_bucket.md). @@ -27,7 +27,7 @@ You will need to deploy a VPC with the required VPC endpoints. We provide both [ * Public VPC: [`https://sg-shotgunsoftware.s3-us-west-2.amazonaws.com/tier1/cloudformation_templates/sg-public-vpc.yml`](https://sg-shotgunsoftware.s3-us-west-2.amazonaws.com/tier1/cloudformation_templates/sg-public-vpc.yml) * Click Next -* Set a stack name. Eg. `shotgun-vpc` +* Set a stack name. Eg. `{% include product %}-vpc` * Choose network ranges that doesn't conflict with your studio network and set subnet CIDR values accordingly * Set your S3 bucket name * Click Next @@ -79,7 +79,7 @@ Create a new stack in AWS Console using either the [private](https://sg-shotguns * Public S3 proxy: [`https://sg-shotgunsoftware.s3-us-west-2.amazonaws.com/tier1/cloudformation_templates/sg-s3-proxy-public.yml`](https://sg-shotgunsoftware.s3-us-west-2.amazonaws.com/tier1/cloudformation_templates/sg-s3-proxy-public.yml) * Click Next -* Set a stack name up to 32 characters in length. Eg. `shotgun-s3-proxy` +* Set a stack name up to 32 characters in length. Eg. `{% include product %}-s3-proxy` * Set the parameters that do not have default values with those used when creating the ECR repository, VPC and S3 bucket previously * Click Next * Accept `I acknowledge that AWS CloudFormation might create IAM resources` @@ -87,7 +87,7 @@ Create a new stack in AWS Console using either the [private](https://sg-shotguns ### Configure HTTPS -Shotgun requires that the S3 proxy be accessed via HTTPS, therefore the AWS ALB handling requests for your newly created S3 proxy stack must be configured to accept HTTPS requests. +{% include product %} requires that the S3 proxy be accessed via HTTPS, therefore the AWS ALB handling requests for your newly created S3 proxy stack must be configured to accept HTTPS requests. * Create a DNS entry pointing to your S3 proxy, depending upon whether public or private * Private S3 proxy (default): @@ -121,7 +121,7 @@ Try to access your S3 proxy using the ping route. Eg. `https://s3-proxy.mystudio ### Configure your test site to use the S3 proxy -* Navigate to the Site Preferences menu within Shotgun and expand the Isolation section +* Navigate to the Site Preferences menu within {% include product %} and expand the Isolation section * Set S3 Proxy Host Address to the S3 proxy url. Eg. `https://s3-proxy.mystudio.com` then click Save changes * Confirm that you are still able to access existing media * Attempt to upload new media diff --git a/docs/en/trusted-solutions/tier1/setup/migration.md b/docs/en/trusted-solutions/tier1/setup/migration.md index c6e312da2..fcada3bf8 100644 --- a/docs/en/trusted-solutions/tier1/setup/migration.md +++ b/docs/en/trusted-solutions/tier1/setup/migration.md @@ -11,17 +11,17 @@ Once everything is configured and properly tested with the migration test site, ## Test migration -Ask the Shotgun team to start the migration process in support ticket/slack. +Ask the {% include product %} team to start the migration process in support ticket/slack. - * Shotgun will clone your production site database to your migration test site. - * You will do a first sync of the media from Shotgun's S3 bucket to your bucket. Shotgun will provide the exact instructions. + * {% include product %} will clone your production site database to your migration test site. + * You will do a first sync of the media from {% include product %}'s S3 bucket to your bucket. {% include product %} will provide the exact instructions. * You can now test your site to be sure your existing media is available. ## Final migration The second test is to definitly migrate your site to use your own S3 bucket. - * You will do a second sync of the media from Shotgun's S3 bucket to your bucket. - * Shotgun will reconfigure your hosted site with media isolation. Some media will be missing until the final media sync is completed. + * You will do a second sync of the media from {% include product %}'s S3 bucket to your bucket. + * {% include product %} will reconfigure your hosted site with media isolation. Some media will be missing until the final media sync is completed. * You will do a final media sync. diff --git a/docs/en/trusted-solutions/tier1/setup/planning.md b/docs/en/trusted-solutions/tier1/setup/planning.md index 8ded6f474..e365d92b6 100644 --- a/docs/en/trusted-solutions/tier1/setup/planning.md +++ b/docs/en/trusted-solutions/tier1/setup/planning.md @@ -45,7 +45,7 @@ If you plan to activate any of the Traffic Isolation feature, you will need a wa * AWS Direct Connect * Other VPN solution -We highly recommand you to leverage Direct Connect. Direct Connect guarantees the lowest latency possible to the Shotgun services, a consistent network experience, and allow you to leverage the optimization AWS is relying on to guarantee an optimal performance across the globe. +We highly recommand you to leverage Direct Connect. Direct Connect guarantees the lowest latency possible to the {% include product %} services, a consistent network experience, and allow you to leverage the optimization AWS is relying on to guarantee an optimal performance across the globe. ## Next Step diff --git a/docs/en/trusted-solutions/tier1/setup/s3_bucket.md b/docs/en/trusted-solutions/tier1/setup/s3_bucket.md index 714fa7149..1f3b0fd2b 100644 --- a/docs/en/trusted-solutions/tier1/setup/s3_bucket.md +++ b/docs/en/trusted-solutions/tier1/setup/s3_bucket.md @@ -24,8 +24,8 @@ It's possible to start from the [Private S3 bucket AWS CloudFormation template]( * Select Template is ready * Set Amazon S3 URL to https://sg-shotgunsoftware.s3-us-west-2.amazonaws.com/tier1/cloudformation_templates/sg-private-s3-bucket.yml * Next - * Set a stack name like shotgun-s3-bucket - * Set your S3 bucket name and your Shotgun site name + * Set a stack name like {% include product %}-s3-bucket + * Set your S3 bucket name and your {% include product %} site name * Next * Accept `I acknowledge that AWS CloudFormation might create IAM resources` * Next @@ -38,21 +38,21 @@ CORS policy on your S3 bucket will be minimally configured, allowing only the re The template will create an AWS Role with the following permissions on your bucket: -* Allow Shotgun to access your S3 bucket. -* Allow the Shotgun account to assume the role by setting the role Trust Relationship. +* Allow {% include product %} to access your S3 bucket. +* Allow the {% include product %} account to assume the role by setting the role Trust Relationship. ## Media Isolation Activation -Please contact Shotgun support via the dedicated Slack channel and provide the following information: +Please contact {% include product %} support via the dedicated Slack channel and provide the following information: * S3 bucket name * AWS Region - * Shotgun Role ARN + * {% include product %} Role ARN -Shotgun will configure your test site to use your own S3 bucket. +{% include product %} will configure your test site to use your own S3 bucket. ## Validation -At this stage, you should be able to upload and download media. The Shotgun Transcoding Service should also be able to read, transcode and write back the thumbnails, filmstrip and web friendly versions of your media back to your S3 Bucket. To validate this: +At this stage, you should be able to upload and download media. The {% include product %} Transcoding Service should also be able to read, transcode and write back the thumbnails, filmstrip and web friendly versions of your media back to your S3 Bucket. To validate this: 1. Log in your Migration Test Site. 2. From the Navigation Bar, go the the Media app diff --git a/docs/en/trusted-solutions/tier1/setup/s3_replication.md b/docs/en/trusted-solutions/tier1/setup/s3_replication.md index 1ad484fa5..20b465ada 100644 --- a/docs/en/trusted-solutions/tier1/setup/s3_replication.md +++ b/docs/en/trusted-solutions/tier1/setup/s3_replication.md @@ -9,7 +9,7 @@ lang: en ## Description -It's possible to add S3 replication between two S3 buckets in different regions and configure Shotgun to leverage it for faster access to media. +It's possible to add S3 replication between two S3 buckets in different regions and configure {% include product %} to leverage it for faster access to media. ![S3 Replication Diagram](../images/tier1-s3-replication.png) @@ -40,10 +40,10 @@ The `IP Adresses for S3 replication` preference can be edited in Site Preference # Setup steps * Create the replica S3 bucket in a new AWS region. See [Media Isolation](./s3_bucket.md) - * Update your existing Shotgun role policy to allow Shotgun to also access the replica bucket + * Update your existing {% include product %} role policy to allow {% include product %} to also access the replica bucket * Setup the replication rules on the primary S3 bucket. See [How do I add a replication rule to an S3 bucket?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/enable-replication.html#enable-replication-add-rule) * Setup a VPC + Direct Connect + S3 proxy in the new AWS region. See [Media Traffic Isolation](./media_segregation.md) - * Contact Shotgun Support to configure your site to use the new S3 replica bucket, providing the following information: + * Contact {% include product %} Support to configure your site to use the new S3 replica bucket, providing the following information: * Replica Bucket Name * Replica Bucket Region * Replica S3 proxy URL diff --git a/docs/en/trusted-solutions/tier1/setup/setup.md b/docs/en/trusted-solutions/tier1/setup/setup.md index 61cab9ab0..759f5637f 100644 --- a/docs/en/trusted-solutions/tier1/setup/setup.md +++ b/docs/en/trusted-solutions/tier1/setup/setup.md @@ -5,7 +5,7 @@ pagename: tier1-setup lang: en --- -# Shotgun Isolation Feature Set - Setup +# {% include product %} Isolation Feature Set - Setup Isolation the isolation features are independent of each other, and can be activated independently of each other. Media replication have as pre-requisite for Media Isolation to be implemented. @@ -40,7 +40,7 @@ Before you start working on your setup, [put a plan in place](./planning.md). Ch ## [Migration Test Site](./shotgun_poc_site.md) -To help you setting up the Isolation features without breaking your production environment and to helping smooting the migration to your isolated environment, Shotgun propose to use a test site on which to test your setup before applying the result to production. +To help you setting up the Isolation features without breaking your production environment and to helping smooting the migration to your isolated environment, {% include product %} propose to use a test site on which to test your setup before applying the result to production. ## [Media Isolation](./s3_bucket.md) diff --git a/docs/en/trusted-solutions/tier1/setup/shotgun_poc_site.md b/docs/en/trusted-solutions/tier1/setup/shotgun_poc_site.md index fa2e053ab..18a4cfd1d 100644 --- a/docs/en/trusted-solutions/tier1/setup/shotgun_poc_site.md +++ b/docs/en/trusted-solutions/tier1/setup/shotgun_poc_site.md @@ -5,11 +5,11 @@ pagename: tier1-setup-shotgun_poc_site lang: en --- -# Shotgun Migration Test Site +# {% include product %} Migration Test Site Activating the isolation feature set is an intrusive procedure that can have an impact on the usability of your site. To prevent a production stopping event, we require clients to follow an approach where the configuration is first validated on a test site, before being applied to the production site. -The Shotgun team will create a temporary site to be used as a Proof of Concept for your Shotgun Isolation deployment. Upon the successful completion of the setup process, your existing Shotgun site can be migrated to your Shotgun Isolation environment. +The {% include product %} team will create a temporary site to be used as a Proof of Concept for your {% include product %} Isolation deployment. Upon the successful completion of the setup process, your existing {% include product %} site can be migrated to your {% include product %} Isolation environment. If your Migration Test Site has not been created yet, please reach out to our Support team through your Zendesk ticket or your dedicated on-boarding Slack Channel. diff --git a/docs/en/trusted-solutions/tier1/setup/traffic_segregation.md b/docs/en/trusted-solutions/tier1/setup/traffic_segregation.md index 52054eeab..8498b4bd7 100644 --- a/docs/en/trusted-solutions/tier1/setup/traffic_segregation.md +++ b/docs/en/trusted-solutions/tier1/setup/traffic_segregation.md @@ -7,26 +7,26 @@ lang: en # Web Traffic Isolation -The goal is to set up an AWS PrivateLink to privately access your Shotgun site. +The goal is to set up an AWS PrivateLink to privately access your {% include product %} site. ## Set up PrivateLink to Shotgun - * Ask Shotgun support to provide you with the Shotgun PrivateLink service name for your AWS region. + * Ask {% include product %} support to provide you with the {% include product %} PrivateLink service name for your AWS region. - * Update the private VPC CloudFormation stack you created earlier and set ShotgunPrivateServiceName parameter. + * Update the private VPC CloudFormation stack you created earlier and set {% include product %}PrivateServiceName parameter. ### Manual steps if needed * Add a new VPC Endpoint in your VPC - * For the security group, Shotgun service only requires the inbound port tcp/443 to be open. + * For the security group, {% include product %} service only requires the inbound port tcp/443 to be open. ![Create endpoint](../images/tier1-endpoint-create_privatelink.png) ## DNS Configuration -Provide your PrivateLink DNS name to Shotgun support. We will setup a new private URL for your site that will look like `mystudio-staging.priv.shotgunstudio.com`. +Provide your PrivateLink DNS name to {% include product %} support. We will setup a new private URL for your site that will look like `mystudio-staging.priv.shotgunstudio.com`. ## Validation diff --git a/docs/en/trusted-solutions/tier1/setup/tuning.md b/docs/en/trusted-solutions/tier1/setup/tuning.md index 7aabe2f78..da4fa3a2a 100644 --- a/docs/en/trusted-solutions/tier1/setup/tuning.md +++ b/docs/en/trusted-solutions/tier1/setup/tuning.md @@ -11,17 +11,17 @@ lang: en ### S3 Infrequent Access -We recommend enabling S3 Infrequent Access to easily reduce costs without impacting performance. For the Shotgun Cloud hosted offering, we apply a policy for all objects older than one month. +We recommend enabling S3 Infrequent Access to easily reduce costs without impacting performance. For the {% include product %} Cloud hosted offering, we apply a policy for all objects older than one month. -With Infrequent Access, objects are stored at a lower cost. However, if they are accessed, it will involve an additional cost. Shotgun has observed that one month was the right policy to use globally, but you may want to adapt that policy to your studio workflows as needed. +With Infrequent Access, objects are stored at a lower cost. However, if they are accessed, it will involve an additional cost. {% include product %} has observed that one month was the right policy to use globally, but you may want to adapt that policy to your studio workflows as needed. Read more about S3 Infrequent Access and other storage classes [here](https://aws.amazon.com/s3/storage-classes/). ## S3 Bucket policy -We recommend you restrict access to your S3 bucket to only your VPC and Shotgun transcoding services IPs. There is an example policy, replace `your_vpc_id` and `your_s3_bucket` by your values. +We recommend you restrict access to your S3 bucket to only your VPC and {% include product %} transcoding services IPs. There is an example policy, replace `your_vpc_id` and `your_s3_bucket` by your values. -We strongly recommend you test media access and media transcoding in your migration test site right after applying the bucket policy changes to be sure your S3 bucket is still accessible from your VPC and from Shotgun transcoders. +We strongly recommend you test media access and media transcoding in your migration test site right after applying the bucket policy changes to be sure your S3 bucket is still accessible from your VPC and from {% include product %} transcoders. ``` { diff --git a/docs/ja/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md b/docs/ja/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md index 5a49e3c57..ac81fb052 100644 --- a/docs/ja/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md +++ b/docs/ja/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md @@ -10,19 +10,19 @@ lang: ja ## Auto updates ### What parts auto update? -By default Shotgun Desktop will automatically check for updates, and install them to the local machine if it finds any. +By default {% include product %} Desktop will automatically check for updates, and install them to the local machine if it finds any. It checks for updates on two components: -- `tk-framework-desktopstartup` - A frame work which aids the launch of Shotgun Desktop. +- `tk-framework-desktopstartup` - A frame work which aids the launch of {% include product %} Desktop. - `tk-config-basic` - The default site config. -The configuration acts as a manifest for the versions of the apps, engines, frameworks, and core version that should be used by Shotgun Desktop. +The configuration acts as a manifest for the versions of the apps, engines, frameworks, and core version that should be used by {% include product %} Desktop. By updating the config, you are potentially updating any of these components as well. -Any updates that are found are downloaded and stored in the user's local cache, rather than modifying the original Shotgun Desktop installed files. +Any updates that are found are downloaded and stored in the user's local cache, rather than modifying the original {% include product %} Desktop installed files. -Shotgun Create as an application has it's own update mechanism separate from Shotgun Desktop which is not covered here. -However the integration features provided in Shotgun Create work in a similar way, and will also auto update `tk-config-basic` into the same user cache. +{% include product %} Create as an application has it's own update mechanism separate from {% include product %} Desktop which is not covered here. +However the integration features provided in {% include product %} Create work in a similar way, and will also auto update `tk-config-basic` into the same user cache. ### What doesn't auto update? @@ -44,15 +44,15 @@ The following sections describes how to address each of these scenarios. ### Initial Setup If your studio has restricted internet access or no internet access then you will need to ensure that you have all the required parts cached locally. -You will still need one machine that can connect to the internet in order to download Shotgun Create or Shotgun Desktop. +You will still need one machine that can connect to the internet in order to download {% include product %} Create or {% include product %} Desktop. -Shotgun Create and Shotgun Desktop come prepackaged with all the dependencies required to run the basic integrations. -When you start either of them up, it will automatically try to look for updates, but if it cannot connect to the Shotgun App Store, it will simply run the most recent version that exists locally. +{% include product %} Create and {% include product %} Desktop come prepackaged with all the dependencies required to run the basic integrations. +When you start either of them up, it will automatically try to look for updates, but if it cannot connect to the {% include product %} App Store, it will simply run the most recent version that exists locally. -It is recommended that you follow the "Managing updates" steps bellow after installing Shotgun Desktop, as the components bundled with the installer may not be the latest. +It is recommended that you follow the "Managing updates" steps bellow after installing {% include product %} Desktop, as the components bundled with the installer may not be the latest. {% include info title="Note" content="Depending on your network setup, it can sometimes get stuck looking for updates online even though it won't be able to access them. -In this situation you can set the environment variable `SHOTGUN_DISABLE_APPSTORE_ACCESS` to `\"1\"` to stop it from trying." %} +In this situation you can set the environment variable `shotgun_DISABLE_APPSTORE_ACCESS` to `\"1\"` to stop it from trying." %} {% include info title="Note" content="You will still need to be able to connect to your Shotgun site. When we say offline we are talking about not being able to connect to our app store to download updates." %} @@ -63,7 +63,7 @@ To update the `tk-framework-desktopstartup` component, you will need to [downloa For the `tk-config-basic` component it's a bit more tricky, due to all its dependencies. -1. Run Shotgun Desktop on a workstation connected to the internet. When it starts up, the latest upgrades will be automatically downloaded. +1. Run {% include product %} Desktop on a workstation connected to the internet. When it starts up, the latest upgrades will be automatically downloaded. (Ensure `SHOTGUN_DISABLE_APPSTORE_ACCESS` is not set on this machine.) 2. Copy the bundle cache to a shared location where all machines can access it. 3. Set the `SHOTGUN_BUNDLE_CACHE_FALLBACK_PATHS` environment variable on offline machines to point to this location. @@ -79,14 +79,14 @@ In this situation you can set the environment variable `SHOTGUN_DISABLE_APPSTORE ### Disabling updates for a single project 1. Determine the version you want to lock your project to. You can find the integration releases [here](https://support.shotgunsoftware.com/hc/en-us/sections/115000020494-Integrations). -2. In Shotgun, create a Pipeline Configuration entity for the project you want to lock down, with the following fields populated (In this example, we are locking down the config to use v1.0.36 of the integrations): +2. In {% include product %}, create a Pipeline Configuration entity for the project you want to lock down, with the following fields populated (In this example, we are locking down the config to use v1.0.36 of the integrations): - Name: `Primary` - Project: The project you want to lock down - Plugin ids: `basic.*` - Descriptor: `sgtk:descriptor:app_store?name=tk-config-basic&version=v1.0.36` ![Pipeline Configuration entity with a setup for a project with disabled updates.](images/offline-and-disabled-auto-updates/freeze_single_project.png) -3. Anyone starting Shotgun Desktop on the project will now always use `v1.0.36`. Any new users starting to work on the project will also get `v1.0.36`. +3. Anyone starting {% include product %} Desktop on the project will now always use `v1.0.36`. Any new users starting to work on the project will also get `v1.0.36`. #### Good to know @@ -141,7 +141,7 @@ Note that you’ve omitted the version number from the Descriptor field for the Scenario: We’re locked down to v1.0.0, and we’d like to upgrade to v2.0.0, but first I want to test out the new version before deploying it to the studio.* Solution -Duplicate the Pipeline Configuration entity in Shotgun by right-clicking on it and selecting "Duplicate Selected". +Duplicate the Pipeline Configuration entity in {% include product %} by right-clicking on it and selecting "Duplicate Selected". Name the cloned config “update test”, and assign yourself to the User Restrictions field. You will now begin to use this Pipeline Configuration. Change the descriptor to point to the version you wish to test. diff --git a/docs/ja/guides/pipeline-integrations/getting-started/advanced_config.md b/docs/ja/guides/pipeline-integrations/getting-started/advanced_config.md index 4703931e5..a98a441e9 100644 --- a/docs/ja/guides/pipeline-integrations/getting-started/advanced_config.md +++ b/docs/ja/guides/pipeline-integrations/getting-started/advanced_config.md @@ -11,35 +11,35 @@ lang: ja ## このガイドについて -このガイドでは、Shotgun Desktop の**[Advanced Project Setup]ウィザード**を使用して、デジタル コンテンツ作成パイプラインの設定を作成する方法について説明します。短時間で設定ツールを習得し、ウィザードの使用方法を学習して、さらに知識を広げることできます。ウィザードを使用することにより、プロジェクトのパイプライン設定を作成でき、パイプラインの各ステップに対応するように編集、拡張する準備が整います。設定により、プロダクション パイプラインをサポートするために必要なユーザ インタフェース、Shotgun アプリ、およびさまざまなツールの特性がコントロールされます。ウィザードを使用することは、設定を拡張するための 1 つの方法にすぎません。ウィザードによってパイプラインの各ステップに具体的な設定が追加されるだけでなく、ソフトウェア アプリケーションとの統合も追加されます。このガイドでは、プロジェクトの設定のベースとして Toolkit の既定の設定を使用します。 +このガイドでは、{% include product %} Desktop の**[Advanced Project Setup]ウィザード**を使用して、デジタル コンテンツ作成パイプラインの設定を作成する方法について説明します。短時間で設定ツールを習得し、ウィザードの使用方法を学習して、さらに知識を広げることできます。ウィザードを使用することにより、プロジェクトのパイプライン設定を作成でき、パイプラインの各ステップに対応するように編集、拡張する準備が整います。設定により、プロダクション パイプラインをサポートするために必要なユーザ インタフェース、{% include product %} アプリ、およびさまざまなツールの特性がコントロールされます。ウィザードを使用することは、設定を拡張するための 1 つの方法にすぎません。ウィザードによってパイプラインの各ステップに具体的な設定が追加されるだけでなく、ソフトウェア アプリケーションとの統合も追加されます。このガイドでは、プロジェクトの設定のベースとして Toolkit の既定の設定を使用します。 このガイドでは、次のユーザを対象としています。 1. [Advanced Project Setup]ウィザードを使用したことがないユーザ -2. Shotgun の使用方法に関する基本知識を持っているユーザ -3. Shotgun Toolkit を新たに使用するユーザ +2. {% include product %} の使用方法に関する基本知識を持っているユーザ +3. {% include product %} Toolkit を新たに使用するユーザ ### このドキュメントの使い方 このガイドを使用してカスタマイズ可能なプロジェクトの設定を作成するには、以下が必要になります。 -1. アクティブな Shotgun サイト。[こちら](https://www.shotgunsoftware.com/jp/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management)から Shotgun に登録し、30 日間の無償体験版を取得して試してみることができます。 -2. Shotgun Desktop。Desktop がインストールされていない場合は、[こちらのリンク](https://support.shotgunsoftware.com/hc/ja/articles/115000068574-Integrations-user-guide#Installation%20of%20Desktop)に従ってインストールを開始できます。 +1. アクティブな {% include product %} サイト。[こちら](https://www.shotgunsoftware.com/jp/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management)から {% include product %} に登録し、30 日間の無償体験版を取得して試してみることができます。 +2. {% include product %} Desktop。Desktop がインストールされていない場合は、[こちらのリンク](https://support.shotgunsoftware.com/hc/ja/articles/115000068574-Integrations-user-guide#Installation%20of%20Desktop)に従ってインストールを開始できます。 3. プロジェクト ファイルおよびパイプライン設定を保存できるファイルシステムへのアクセス権。ファイルシステム上に `Shotgun` というフォルダを作成し、その中に `projects` と `configs` という 2 つのフォルダを作成します。 ## [Advanced Project Setup]ウィザードについて -Shotgun Desktop の[Advanced Project Setup]ウィザードは、既定の設定に基づいてパイプライン設定を生成します。既定の設定により、パイプライン プロセスをサポートするカスタマイズ可能な設定、アプリ、UI 要素を備えた、構築のための強固な基盤が提供されます。ユーザはプロジェクトのパイプラインに関するニーズに合わせて、このウィザードで作成される設定を編集したり、拡張したりできます。 +{% include product %} Desktop の[Advanced Project Setup]ウィザードは、既定の設定に基づいてパイプライン設定を生成します。既定の設定により、パイプライン プロセスをサポートするカスタマイズ可能な設定、アプリ、UI 要素を備えた、構築のための強固な基盤が提供されます。ユーザはプロジェクトのパイプラインに関するニーズに合わせて、このウィザードで作成される設定を編集したり、拡張したりできます。 既定の設定は、次のとおりです。 * ディスク上のファイルの配置場所を決定する、ファイルシステムの基本的なスキーマおよびテンプレート -* ユーザのソフトウェア アプリケーション内から Shotgun およびパイプラインの機能を直接操作できる、サポート対象のすべての[ソフトウェア統合](https://support.shotgunsoftware.com/hc/ja/articles/219039798-Integrations-Apps-and-Engines) +* ユーザのソフトウェア アプリケーション内から {% include product %} およびパイプラインの機能を直接操作できる、サポート対象のすべての[ソフトウェア統合](https://support.shotgunsoftware.com/hc/ja/articles/219039798-Integrations-Apps-and-Engines) -カスタマイズするには、想像力、賢さ、プログラミング上の知識の他に、Shotgun コミュニティ内の他のユーザが作成した作品から借用する能力が必要です。 +カスタマイズするには、想像力、賢さ、プログラミング上の知識の他に、{% include product %} コミュニティ内の他のユーザが作成した作品から借用する能力が必要です。 ### 設定を作成する -設定はプロジェクトごとに必要です。Shotgun Desktop を介してプロジェクトに初めてアクセスするときに、基本設定がダウンロードされて、設定されます。この基本設定により、ユーザがシステムにインストールしているサポート対象のコンテンツ作成ソフトウェアが自動的に検出され、その設定がプロジェクトに関連付けられます。サポート対象ソフトウェア アプリケーション内の統合は、パイプライン設定内の設定値によって管理されます。[Panel](https://support.shotgunsoftware.com/hc/ja/articles/219033098-Shotgun-Panel) アプリには Shotgun のプロジェクト情報が表示されるため、アーティストは作業セッションから移動しなくてもノートに返信し、バージョンを確認することができます。[Publisher](https://support.shotgunsoftware.com/hc/ja/articles/219032998-Publishing-your-work) アプリを使用すると、アーティストはチーム内の他のメンバーに自分の作品を公開することができます。また、[Loader](https://support.shotgunsoftware.com/hc/ja/articles/219033078-Load-Published-Files-) アプリを使用すると、アーティストはチームメイトがパブリッシュしたファイルをロードすることができます。基本設定には、ファイルシステムの管理に関する設定や、ディスク上のファイルおよびフォルダの命名方法を指定するためのテンプレートの開発は含まれていません。また、既定の設定を行ったときに追加された多数のアプリも含まれていません。基本設定は、設定ファイルを手動で編集しなくても Toolkit で実行できるシンプルな設定です。ウィザードを使用すると、基本設定が既定の設定に置き換わります。また、作業中のユーザをサポートするアプリおよびソフトウェアが幅広く統合されます。基本設定を編集することもできますが、プロジェクトを設定してカスタマイズするには、高度な設定を行うことが必要になります。 +設定はプロジェクトごとに必要です。{% include product %} Desktop を介してプロジェクトに初めてアクセスするときに、基本設定がダウンロードされて、設定されます。この基本設定により、ユーザがシステムにインストールしているサポート対象のコンテンツ作成ソフトウェアが自動的に検出され、その設定がプロジェクトに関連付けられます。サポート対象ソフトウェア アプリケーション内の統合は、パイプライン設定内の設定値によって管理されます。[Panel](https://support.shotgunsoftware.com/hc/ja/articles/219033098-Shotgun-Panel) アプリには {% include product %} のプロジェクト情報が表示されるため、アーティストは作業セッションから移動しなくてもノートに返信し、バージョンを確認することができます。[Publisher](https://support.shotgunsoftware.com/hc/ja/articles/219032998-Publishing-your-work) アプリを使用すると、アーティストはチーム内の他のメンバーに自分の作品を公開することができます。また、[Loader](https://support.shotgunsoftware.com/hc/ja/articles/219033078-Load-Published-Files-) アプリを使用すると、アーティストはチームメイトがパブリッシュしたファイルをロードすることができます。基本設定には、ファイルシステムの管理に関する設定や、ディスク上のファイルおよびフォルダの命名方法を指定するためのテンプレートの開発は含まれていません。また、既定の設定を行ったときに追加された多数のアプリも含まれていません。基本設定は、設定ファイルを手動で編集しなくても Toolkit で実行できるシンプルな設定です。ウィザードを使用すると、基本設定が既定の設定に置き換わります。また、作業中のユーザをサポートするアプリおよびソフトウェアが幅広く統合されます。基本設定を編集することもできますが、プロジェクトを設定してカスタマイズするには、高度な設定を行うことが必要になります。 ### 基本設定と既定の設定の違い @@ -51,19 +51,19 @@ Shotgun Desktop の[Advanced Project Setup]ウィザードは、既定の設定 | 更新 | 自動的に更新 | 手動で更新 | | ファイルシステムのサポート | ファイルシステム スキーマはサポートされない | フォルダ構造とファイルの命名基準をサポートするためのツールが付属 | | ソフトウェア統合 | 3ds Max、Houdini、Maya、Nuke、Photoshop、Flame | 基本設定に加えて、Hiero、Motionbulder、Mari | -| Toolkit アプリ | Shotgun Panel、Publisher、Loader | 基本設定に加えて、Workfiles、Snapshot、Scene Breakdown、Nuke 書き込みノード、Houdini Mantra ノードなど | +| Toolkit アプリ | {% include product %} Panel、Publisher、Loader | 基本設定に加えて、Workfiles、Snapshot、Scene Breakdown、Nuke 書き込みノード、Houdini Mantra ノードなど | -このガイドでは、Shotgun Desktop のウィザードを使用し、既定の設定に基づいてプロジェクトのパイプライン設定を生成します。この設定を生成すると、独自のプロダクション パイプラインをサポートするために必要なカスタマイズを実行できるようになります。 +このガイドでは、{% include product %} Desktop のウィザードを使用し、既定の設定に基づいてプロジェクトのパイプライン設定を生成します。この設定を生成すると、独自のプロダクション パイプラインをサポートするために必要なカスタマイズを実行できるようになります。 ## 実習を開始 ### 既定の設定の作成準備を行う -**手順 1:** Shotgun で「the_other_side」という新しいプロジェクトを作成します。 +**手順 1:** {% include product %} で「the_other_side」という新しいプロジェクトを作成します。 ![新しいプロジェクト](./images/advanced_config/2_new_project.png) -**手順 2:** Shotgun Desktop アプリを起動し、ユーザ名およびパスワードを使用して Shotgun サイトからログインします。 +**手順 2:** {% include product %} Desktop アプリを起動し、ユーザ名およびパスワードを使用して {% include product %} サイトからログインします。 ![ログイン](./images/advanced_config/3_login.png) @@ -77,21 +77,21 @@ Shotgun Desktop の[Advanced Project Setup]ウィザードは、既定の設定 ### 既定の設定にアクセスする -プロジェクトにアクセスし、基本設定をダウンロードして設定しました。また、Publish アプリおよびサポート対象のソフトウェア パッケージが検出されて、Shotgun Desktop の**[Apps]**ペインに自動的に追加されました。 +プロジェクトにアクセスし、基本設定をダウンロードして設定しました。また、Publish アプリおよびサポート対象のソフトウェア パッケージが検出されて、{% include product %} Desktop の**[Apps]**ペインに自動的に追加されました。 **手順 4:** プロジェクトがロードされたら、画面の右下にあるプロファイルの**アバター**を選択します。ポップアップメニューで、**[Advanced project setup...]**を選択して、ウィザードを開始します。 ![高度なプロジェクトを設定](./images/advanced_config/6_advanced_project_setup.png) -ダイアログ ボックスが開き、[Shotgun Default]が選択された状態で 4 つのオプションが表示されます。この時点で、プロジェクトのパイプライン設定のベースを既存のプロジェクトの設定にするのか、GIT リポジトリの設定にするのか、それともディスクのパスにするのかを選択できます。 +ダイアログ ボックスが開き、[{% include product %} Default]が選択された状態で 4 つのオプションが表示されます。この時点で、プロジェクトのパイプライン設定のベースを既存のプロジェクトの設定にするのか、GIT リポジトリの設定にするのか、それともディスクのパスにするのかを選択できます。 -この演習では**[Shotgun Default]**を選択します。このオプションを使用すると、Shotgun の既定の設定に基づいてプロジェクトのパイプライン設定が作成されます。 +この演習では**[{% include product %} Default]**を選択します。このオプションを使用すると、{% include product %} の既定の設定に基づいてプロジェクトのパイプライン設定が作成されます。 ![設定を選択](./images/advanced_config/7_select_config.png) **手順 5:** **[Continue]**を選択します。 -ダイアログ ボックスが開き、**[Default]**が選択された状態で 2 つのオプションが表示されます。この時点で、[Legacy Default]設定オプションを選択することができます。この設定は、まだ以前のバージョンの Shotgun を使用しているスタジオのために、以前のバージョンの Shotgun の設定を継承しています。この演習では[Default]を使用します。 +ダイアログ ボックスが開き、**[Default]**が選択された状態で 2 つのオプションが表示されます。この時点で、[Legacy Default]設定オプションを選択することができます。この設定は、まだ以前のバージョンの {% include product %} を使用しているスタジオのために、以前のバージョンの {% include product %} の設定を継承しています。この演習では[Default]を使用します。 ![設定を選択](./images/advanced_config/8_select_config.png) @@ -107,13 +107,13 @@ Shotgun Desktop の[Advanced Project Setup]ウィザードは、既定の設定 ![保存場所を定義](./images/advanced_config/10_define_storage2.png) -Shotgun Toolkit では、Linux、Mac、Windows の 3 つのオペレーティング システムをサポートしています。 +{% include product %} Toolkit では、Linux、Mac、Windows の 3 つのオペレーティング システムをサポートしています。 **手順 8:** プロジェクト データを保存するのに利用するオペレーティング システムの横にあるフィールドを選択します。フォルダ アイコンを選択し、この演習の前にファイルシステム上に作成したプロジェクト フォルダにナビゲートします。 ![ストレージのルート フォルダ](./images/advanced_config/11_storage_root_folder.png) -この設定の場合、Shotgun からアクセスできるのは、プロダクション データを保存するために識別されたフォルダに限定されます。この演習の準備中に、Shotgun のルート ディレクトリ内に `projects/` ディレクトリを追加しました。`projects/` ディレクトリには、プロジェクトに関連するローカルな情報が格納されます。 +この設定の場合、{% include product %} からアクセスできるのは、プロダクション データを保存するために識別されたフォルダに限定されます。この演習の準備中に、{% include product %} のルート ディレクトリ内に `projects/` ディレクトリを追加しました。`projects/` ディレクトリには、プロジェクトに関連するローカルな情報が格納されます。 ![保存場所を定義](./images/advanced_config/12_define_Storage3.png) @@ -131,7 +131,7 @@ Shotgun Toolkit では、Linux、Mac、Windows の 3 つのオペレーティン ![プロジェクト フォルダ](./images/advanced_config/14_project_folder_name.png) -Toolkit は、2 つのいずれかの設定で機能します。パイプライン設定が Shotgun にアップロードされ、ユーザごとにローカルにキャッシュされる分散設定(Distributed Setup)と、ディスク上の共有場所に保管された単一の設定にユーザがアクセスする中央設定(Centralized Setup)です。この演習では分散設定を使用します。分散設定の詳細については、[こちら](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)を参照してください。 +Toolkit は、2 つのいずれかの設定で機能します。パイプライン設定が {% include product %} にアップロードされ、ユーザごとにローカルにキャッシュされる分散設定(Distributed Setup)と、ディスク上の共有場所に保管された単一の設定にユーザがアクセスする中央設定(Centralized Setup)です。この演習では分散設定を使用します。分散設定の詳細については、[こちら](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)を参照してください。 最後の手順では、該当するフォルダ、ファイル、およびプロジェクトに固有の設定を作成するために必要なデータを生成します。 @@ -145,7 +145,7 @@ Toolkit は、2 つのいずれかの設定で機能します。パイプライ ![セットアップ完了](./images/advanced_config/17_project_setup_complete.png) -**ヒント:** アプリをメニュー バーに固定すると、Shotgun Desktop にすばやくアクセスできるようになります。**アバター**を選択して、**[Pin to Menu]**を選択します。 +**ヒント:** アプリをメニュー バーに固定すると、{% include product %} Desktop にすばやくアクセスできるようになります。**アバター**を選択して、**[Pin to Menu]**を選択します。 これでプロジェクトの設定は完了です。指定した場所にプロジェクトの Toolkit パイプライン設定が保存され、カスタマイズを開始できるようになりました。 @@ -157,7 +157,7 @@ Toolkit は、2 つのいずれかの設定で機能します。パイプライ ## 高度なトピック -Shotgun Toolkit では、さまざまな方法で設定の編集、クローン作成、またはやり直しを行うことができます。既存の設定を拡張することにより、作業時間を短縮し、ネットワーク内の他のユーザが作成したすべての便利なツールにアクセスできます。広大な Shotgun の[コミュニティ](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups&hl=ja#!forum/shotgun-dev)を利用して、必要な設定を取得することができます。Shotgun のコミュニティは共有コミュニティです。そのため、他のユーザに対して親切に対応し、感謝を示し、あなたのジョブに役立つ設定を作成してくれたユーザに賞賛の念を示すことが大切です。そして「お返し」をすることを忘れてはいけません。それこそが Shotgun の仲間をサポートし、このコミュニティへの参加が特別なことであることを示す理由なのです。 +{% include product %} Toolkit では、さまざまな方法で設定の編集、クローン作成、またはやり直しを行うことができます。既存の設定を拡張することにより、作業時間を短縮し、ネットワーク内の他のユーザが作成したすべての便利なツールにアクセスできます。広大な {% include product %} の[コミュニティ](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups&hl=ja#!forum/shotgun-dev)を利用して、必要な設定を取得することができます。{% include product %} のコミュニティは共有コミュニティです。そのため、他のユーザに対して親切に対応し、感謝を示し、あなたのジョブに役立つ設定を作成してくれたユーザに賞賛の念を示すことが大切です。そして「お返し」をすることを忘れてはいけません。それこそが {% include product %} の仲間をサポートし、このコミュニティへの参加が特別なことであることを示す理由なのです。 次に、設定による楽しみ方の例をいくつかを示します。 @@ -167,7 +167,7 @@ Shotgun Toolkit では、さまざまな方法で設定の編集、クローン ### プロダクション中に設定を編集する -現在プロダクションで使用している設定を変更する必要があっても、アーティストが使用している間は編集したくない場合があります。Shotgun には、コマンドをいくつか実行するだけで既存の設定をコピーできる機能があります。この機能を使用すると、プロダクション環境に送信する前に変更内容について安全にテストすることができます。このプロセスを行うと、プロダクションの設定が新しい設定に置き換えられ、古い設定が自動的にバックアップされます。 +現在プロダクションで使用している設定を変更する必要があっても、アーティストが使用している間は編集したくない場合があります。{% include product %} には、コマンドをいくつか実行するだけで既存の設定をコピーできる機能があります。この機能を使用すると、プロダクション環境に送信する前に変更内容について安全にテストすることができます。このプロセスを行うと、プロダクションの設定が新しい設定に置き換えられ、古い設定が自動的にバックアップされます。 設定のコピーを操作する必要があるのは、次の理由からです。 @@ -181,7 +181,7 @@ Shotgun Toolkit では、さまざまな方法で設定の編集、クローン ### パイプライン設定のクラウドへの分散 -このガイドでは、**中央設定**の作成方法について説明します。中央設定とは、ネットワーク上の共有場所に配置されていて、すべてのユーザがアクセスできるパイプライン設定の単一コピーのことです。従業員が複数の場所およびネットワークに分散している場合は、パイプライン設定の単一コピーを共有できないことがあります。Toolkit は**分散設定**オプションを提供することによってこのシナリオを可能にします。すなわち、パイプライン設定を Shotgun にアップロードして、ユーザがプロジェクトにアクセスするたびに設定がダウンロードされ、ローカルにキャッシュされます。分散設定の詳細については、[Core API 開発者向けドキュメント](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)を参照してください。 +このガイドでは、**中央設定**の作成方法について説明します。中央設定とは、ネットワーク上の共有場所に配置されていて、すべてのユーザがアクセスできるパイプライン設定の単一コピーのことです。従業員が複数の場所およびネットワークに分散している場合は、パイプライン設定の単一コピーを共有できないことがあります。Toolkit は**分散設定**オプションを提供することによってこのシナリオを可能にします。すなわち、パイプライン設定を {% include product %} にアップロードして、ユーザがプロジェクトにアクセスするたびに設定がダウンロードされ、ローカルにキャッシュされます。分散設定の詳細については、[Core API 開発者向けドキュメント](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)を参照してください。 ### 複数のルート フォルダを操作する diff --git a/docs/ja/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md b/docs/ja/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md index 9ec88a6e6..2b579077e 100644 --- a/docs/ja/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md +++ b/docs/ja/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md @@ -11,9 +11,9 @@ lang: ja ## このガイドについて -パイプラインを管理する上で最も難しいことの 1 つは、作成される無数のファイルをトラックすることです。Toolkit のパイプラインはファイルシステム管理を自動化します。すなわち、Shotgun のデータおよび設定されたフォルダ構造に基づいてフォルダを作成し、標準の命名規則に従って正しい場所に自動的にファイルを書き込みます。そのためアーティストはコンテンツ作成に集中できます。パイプライン設定には、既定のフォルダのセットとファイル命名規則がありますが、プロダクションではそれらをカスタマイズすることがよくあります。このガイドは、それらのカスタマイズに必要な知識を提供します。 +パイプラインを管理する上で最も難しいことの 1 つは、作成される無数のファイルをトラックすることです。Toolkit のパイプラインはファイルシステム管理を自動化します。すなわち、{% include product %} のデータおよび設定されたフォルダ構造に基づいてフォルダを作成し、標準の命名規則に従って正しい場所に自動的にファイルを書き込みます。そのためアーティストはコンテンツ作成に集中できます。パイプライン設定には、既定のフォルダのセットとファイル命名規則がありますが、プロダクションではそれらをカスタマイズすることがよくあります。このガイドは、それらのカスタマイズに必要な知識を提供します。 -既定の設定では、アセットは `asset_type/asset/pipeline_step` のようなフォルダ構造で管理されます。このガイドでは、「Set」と呼ばれるカスタム エンティティを使用して、各アセットが使用されるプロダクション セット別にアセットを整理します。最初に Shotgun でカスタム エンティティを設定し、それを使用して特定のセット用に作成されたアセットを管理します。その結果、フォルダ構造は `set/asset_type/asset/pipeline_step` のようになります。 +既定の設定では、アセットは `asset_type/asset/pipeline_step` のようなフォルダ構造で管理されます。このガイドでは、「Set」と呼ばれるカスタム エンティティを使用して、各アセットが使用されるプロダクション セット別にアセットを整理します。最初に {% include product %} でカスタム エンティティを設定し、それを使用して特定のセット用に作成されたアセットを管理します。その結果、フォルダ構造は `set/asset_type/asset/pipeline_step` のようになります。 セットによってアセットを整理することの背景にある考え方を、例を挙げて説明してみましょう。たとえば、いくつかのシーンがガレージで発生し、別のシーンがダイニング ルームで発生するプロジェクトがあるとします。このセットアップでは、「wrench」、「oilcan」、「workbench」などのアセットのファイルは「garage」フォルダに整理され、「plate」、「winebottle」、または「tablecloth」は「dining_room」フォルダに整理されます。この例では、ダイニング ルームに肉汁たっぷりの「filet」アセットが適切に配置されていることを確認します。 @@ -21,7 +21,7 @@ lang: ja ### このガイドの次の 3 つの手順 -* Shotgun で、「Set」とよばれる**カスタム エンティティ**を作成します。これは、アーティストが作成しているダイニング ルームの要素と関連付けるために使用します。 +* {% include product %} で、「Set」とよばれる**カスタム エンティティ**を作成します。これは、アーティストが作成しているダイニング ルームの要素と関連付けるために使用します。 * フォルダの**スキーマ**を編集します。これによって、Toolkit はフォルダ構造内の現在のセットに基づいて動的に名前が付けられたフォルダを含めることができます。 * アセット ワーク ファイルの命名に使用される**テンプレート**を編集します。これによって、Toolkit はファイル名に関連付けられたセットの名前を含めることができます。 @@ -29,9 +29,9 @@ lang: ja このガイドを使用するには、以下が必要です。 -1. アクティブな [Shotgun](https://www.shotgunsoftware.com/jp/signup/) サイト。 少なくとも 1 つのアセットが作成されたプロジェクトが必要です。アセットにはモデル タスクが必要です。 -2. Shotgun サイトを使用してアセットを管理する方法の基本的な理解。 -3. システムにインストールされた[Shotgun Desktop](https://support.shotgunsoftware.com/hc/ja/articles/115000068574-Integrations-user-guide#Installation%20of%20Desktop)。 +1. アクティブな [{% include product %}](https://www.shotgunsoftware.com/jp/signup/) サイト。 少なくとも 1 つのアセットが作成されたプロジェクトが必要です。アセットにはモデル タスクが必要です。 +2. {% include product %} サイトを使用してアセットを管理する方法の基本的な理解。 +3. システムにインストールされた[{% include product %} Desktop](https://support.shotgunsoftware.com/hc/ja/articles/115000068574-Integrations-user-guide#Installation%20of%20Desktop)。 4. 指定したプロジェクトのクローン作成されたパイプライン設定。この設定がない場合は、「[設定の基本操作](./advanced_config.md)」ガイドを参照し、その演習で作成した設定のクローンを作成します。 5. YAML の基本的な知識。 6. パイプライン設定を保存するファイルシステムに最適になるように設定された読み取りおよび書き込み権限。 @@ -42,11 +42,11 @@ lang: ja ### ファイル スキーマとテンプレートについて -Toolkit パイプライン設定のスキーマとテンプレートを使用すると、Shotgun データを利用してディスク上のプロダクション ファイルを管理できます。既定の設定のスキーマには、**Shot**、**Sequence**、**Asset**、**Asset Type** などのエンティティが含まれています。その他の **Level**、**Episode**、**Season** などのエンティティ、または今回使用する **Set** などのカスタム エンティティを追加できます。 +Toolkit パイプライン設定のスキーマとテンプレートを使用すると、{% include product %} データを利用してディスク上のプロダクション ファイルを管理できます。既定の設定のスキーマには、**Shot**、**Sequence**、**Asset**、**Asset Type** などのエンティティが含まれています。その他の **Level**、**Episode**、**Season** などのエンティティ、または今回使用する **Set** などのカスタム エンティティを追加できます。 Toolkit プラットフォームでは**スキーマ**を使用してフォルダ構造を動的に構築できます。これは、実際のプロダクション ファイルシステムを構築するときのテンプレートとして使用されるプロダクション フォルダ構造のミニチュア バージョンです。スキーマはフォルダの動的作成のための明示的なガイドで、YAML ファイルを使用して動的に作成されるフォルダのルールを定義します。既定の設定には、アセットとショットの両方のパイプラインのフォルダ作成をサポートする事前設定されたスキーマが含まれています。作成している新しい **Set** エンティティのサポートを追加するために、アセット フォルダ構造の作成をサポートするスキーマの部分 `/assets///` を変更します。 -**テンプレート**を使用すると、Shotgun データとスキーマ構造の情報を使用して作成したファイルに動的に名前を付けて保存することができます。既定の設定には、パイプラインのニーズに合わせて編集できる一連のスタータ テンプレートが用意されています。 +**テンプレート**を使用すると、{% include product %} データとスキーマ構造の情報を使用して作成したファイルに動的に名前を付けて保存することができます。既定の設定には、パイプラインのニーズに合わせて編集できる一連のスタータ テンプレートが用意されています。 {% include info title="注" content="Shotgun 統合の基本セットアップにはファイルシステム管理は含まれていません。プロジェクトのファイルシステム管理を設定するには、プロジェクトに高度な設定が必要です。最初のガイドの『[設定の基本操作](./advanced_config.md)』で、高度なセットアップ プロセスについて説明しています。" %} @@ -56,11 +56,11 @@ Toolkit プラットフォームでは**スキーマ**を使用してフォル ### カスタム エンティティを有効にする -**手順 1:** ブラウザで Shotgun サイトを開きます。アバターをクリックして、[管理者]（ADMIN）> [サイト基本設定]（Site Preferences）の順にクリックします。結果のページで**[エンティティ]（Entities）**セクションを展開します。 +**手順 1:** ブラウザで {% include product %} サイトを開きます。アバターをクリックして、[管理者]（ADMIN）> [サイト基本設定]（Site Preferences）の順にクリックします。結果のページで**[エンティティ]（Entities）**セクションを展開します。 ![Python アプリ](./images/dynamic_filesystem_configuration/1_site_preferences.png) -Shotgun で利用可能なエンティティのタイプのリストが表示されます。下図のリストの一番上には、現在の Shotgun サイト用に構成されているいくつかのエンティティ タイプが示されています。これらのエンティティ タイプの下には、設定も有効化もされていないいくつかの**カスタム エンティティ**があります。 +{% include product %} で利用可能なエンティティのタイプのリストが表示されます。下図のリストの一番上には、現在の {% include product %} サイト用に構成されているいくつかのエンティティ タイプが示されています。これらのエンティティ タイプの下には、設定も有効化もされていないいくつかの**カスタム エンティティ**があります。 ### カスタム エンティティ タイプをどれか選択して設定し、有効にします。 @@ -70,7 +70,7 @@ Shotgun で利用可能なエンティティのタイプのリストが表示さ ![Python アプリ](./images/dynamic_filesystem_configuration/4_enable_entity.png) -これによって、カスタム エンティティが Shotgun でアクティブになり、表示名が *Set* になります。エンティティのシステム名は `CustomEntity01` のままなので、基本的にここではカスタム エンティティの別名を作成していることになります。この例では、`CustomEntity01` を使用していますが、別のカスタム エンティティを使用することもできます。 +これによって、カスタム エンティティが {% include product %} でアクティブになり、表示名が *Set* になります。エンティティのシステム名は `CustomEntity01` のままなので、基本的にここではカスタム エンティティの別名を作成していることになります。この例では、`CustomEntity01` を使用していますが、別のカスタム エンティティを使用することもできます。 {% include info title="注" content="選択したカスタム エンティティのシステム名はメモしておきます。" %} @@ -98,7 +98,7 @@ Shotgun で利用可能なエンティティのタイプのリストが表示さ このガイドでは、**[現在のプロジェクトのみ]（Only the current project）**に適用し、**[フィールドを作成]（Create Field）**を選択します。 -Shotgun は新しいフィールドを設定します。 +{% include product %} は新しいフィールドを設定します。 ![Python アプリ](./images/dynamic_filesystem_configuration/8_only_current_project.png) @@ -124,7 +124,7 @@ Shotgun は新しいフィールドを設定します。 ### スキーマを設定する -これで、Set カスタム エンティティが有効になり、「Dining Room」と呼ばれる Set エンティティが作成され、Asset エンティティがダイニング ルームのセットにリンクされました。Shotgun サイトにすべての要素が配置されたので、フォルダ構造の変更を開始できます。アーティストがタスクでの作業を開始すると、Toolkit は関連付けられた Shotgun データを使用してファイルシステムに作成するフォルダを決定します。パイプライン設定のスキーマに基づいて、新しいフォルダが作成され、自動的に名前が付けられます。 +これで、Set カスタム エンティティが有効になり、「Dining Room」と呼ばれる Set エンティティが作成され、Asset エンティティがダイニング ルームのセットにリンクされました。{% include product %} サイトにすべての要素が配置されたので、フォルダ構造の変更を開始できます。アーティストがタスクでの作業を開始すると、Toolkit は関連付けられた {% include product %} データを使用してファイルシステムに作成するフォルダを決定します。パイプライン設定のスキーマに基づいて、新しいフォルダが作成され、自動的に名前が付けられます。 次に、アーティストがプロダクション パイプラインを実行する際に Toolkit が動的に生成するフォルダ構造を定義します。これは、スキーマを編集することで実行されます。 @@ -150,7 +150,7 @@ Shotgun は新しいフィールドを設定します。 `/assets////` -Set エンティティは `CustomEntity01` として表されます。Shotgun で CustomEntity01 に Set という*表示名*を付けましたが、この構成では常にそのシステム名 `CustomEntity01` でこれを参照します。 +Set エンティティは `CustomEntity01` として表されます。{% include product %} で CustomEntity01 に Set という*表示名*を付けましたが、この構成では常にそのシステム名 `CustomEntity01` でこれを参照します。 ### スキーマが YAML ファイルを使用する方法 @@ -158,7 +158,7 @@ Set エンティティは `CustomEntity01` として表されます。Shotgun ### Set エンティティの新しいフォルダと YAML ファイルを作成します。 -スキーマには、Shotgun が追跡するさまざまなエンティティに関連するフォルダを含む `project` フォルダがあります。Shotgun が Set 内のアイテムをトラックできるようにするために、新しいアセット エンティティ CustomEntity01 を追加します。これらのアイテムはアセットなので、アセットの下のフォルダと YAML ファイルを編集します。 +スキーマには、{% include product %} が追跡するさまざまなエンティティに関連するフォルダを含む `project` フォルダがあります。{% include product %} が Set 内のアイテムをトラックできるようにするために、新しいアセット エンティティ CustomEntity01 を追加します。これらのアイテムはアセットなので、アセットの下のフォルダと YAML ファイルを編集します。 繰り返しますが、目標は `asset_type/asset/step` フォルダ構造から `set/asset_type/asset/step` に移動することです。そこで、スキーマ内のセットを表すフォルダを、対応する YAML ファイルと共に追加します。カスタム エンティティにはシステム名を使用する必要があるので、`CustomEntity01/` フォルダと `CustomEntity01.yml` を作成します。 @@ -180,7 +180,7 @@ filters: - { "path": "project", "relation": "is", "values": [ "$project" ] } ``` -YAML ファイルは、`CustomEntity01` フォルダに付ける名前を Toolkit に指示します。この場合は、タイプ `shotgun_entity` のフォルダを作成しています。これは、Shotgun クエリに対応していることを意味します。`entity_type` フィールドは Shotgun の `CustomEntity01` エンティティをクエリするように指示し、`name` フィールドはエンティティのどの*フィールド*をクエリするのかを指示します。この場合は `CustomEntity01` から `code` フィールドを取得します。 +YAML ファイルは、`CustomEntity01` フォルダに付ける名前を Toolkit に指示します。この場合は、タイプ `{% include product %}_entity` のフォルダを作成しています。これは、{% include product %} クエリに対応していることを意味します。`entity_type` フィールドは {% include product %} の `CustomEntity01` エンティティをクエリするように指示し、`name` フィールドはエンティティのどの*フィールド*をクエリするのかを指示します。この場合は `CustomEntity01` から `code` フィールドを取得します。 `filters` フィールドは、この動的フォルダを作成する必要があるケースを制限します。 @@ -225,10 +225,10 @@ filters: フォルダは、Toolkit パイプライン ワークフローのいくつかの時点で作成されます。 -* **アプリケーション ランチャー**： ユーザがタスクの DCC を起動するたびに、Toolkit はそのタスクのディレクトリを作成します(まだ作成されていない場合)。Toolkit ではまず最初に DCC の起動を行う傾向があるので、通常はこの方法でディレクトリが作成されます。これは、Shotgun の右クリック メニュー、または Shotgun Desktop あるいは Create アプリで実行できます。 -* **Shotgun メニュー**: タスク用のフォルダを作成する最も直接的な方法は、Shotgun で右クリックして[フォルダを作成]（Create Folders）メニュー項目を選択することです。 -* **Toolkit API**: Toolkit API を介して直接ディレクトリ作成ロジックを起動できます。この方法によって、Toolkit をカスタム ランチャーにプラグインしたり、Shotgun で作成される Shot のディレクトリを自動的に作成するためのワークフローのイベント トリガとして使用することができます。 -* **tank コマンド**: Shotgun のメニュー項目と同様、`tank folders` 端末コマンドからもタスク用のフォルダを作成できます。 +* **アプリケーション ランチャー**： ユーザがタスクの DCC を起動するたびに、Toolkit はそのタスクのディレクトリを作成します(まだ作成されていない場合)。Toolkit ではまず最初に DCC の起動を行う傾向があるので、通常はこの方法でディレクトリが作成されます。これは、{% include product %} の右クリック メニュー、または {% include product %} Desktop あるいは Create アプリで実行できます。 +* **{% include product %} メニュー**: タスク用のフォルダを作成する最も直接的な方法は、{% include product %} で右クリックして[フォルダを作成]（Create Folders）メニュー項目を選択することです。 +* **Toolkit API**: Toolkit API を介して直接ディレクトリ作成ロジックを起動できます。この方法によって、Toolkit をカスタム ランチャーにプラグインしたり、{% include product %} で作成される Shot のディレクトリを自動的に作成するためのワークフローのイベント トリガとして使用することができます。 +* **tank コマンド**: {% include product %} のメニュー項目と同様、`tank folders` 端末コマンドからもタスク用のフォルダを作成できます。 `tank` コマンドでテストします。 @@ -274,7 +274,7 @@ In total, 23 folders were processed. ### Toolkit アプリがテンプレートを使用する方法 -まず、Shotgun でアセットをセットに関連付ける方法を作成しました。すなわち CustomEntity01 がセットを表すようにして、Asset エンティティにアセットとセットの間のリンクを表すリンク フィールドを追加しました。アセットとセット間の関係を確立したら、その関連付けを使用するようにフォルダ スキーマを設定し、すべてのアセットの*フォルダ*をその関連付けられたセットのフォルダ内に配置します。次に、*ファイル*に動的に名前を付ける方法を作成し、Toolkitアプリ でファイルを自動的に管理できるようにします。 +まず、{% include product %} でアセットをセットに関連付ける方法を作成しました。すなわち CustomEntity01 がセットを表すようにして、Asset エンティティにアセットとセットの間のリンクを表すリンク フィールドを追加しました。アセットとセット間の関係を確立したら、その関連付けを使用するようにフォルダ スキーマを設定し、すべてのアセットの*フォルダ*をその関連付けられたセットのフォルダ内に配置します。次に、*ファイル*に動的に名前を付ける方法を作成し、Toolkitアプリ でファイルを自動的に管理できるようにします。 アーティストがプロジェクト内のタスクを実行し始めると、必要なフォルダ構造が生成されます。その後、Workfiles アプリの**[File Save]**アクションを開始すると、ファイルに自動的に名前が付けられます。Toolkit の Workfiles アプリを通じてアクセスされるテンプレートは、そのファイルに名前を付けるために使用されます。Nuke Write ノードや Houdini Mantra ノードなどのレンダリング アプリは、パブリッシュ ファイル用のパブリッシャー アプリと同様に、テンプレートを使用してレンダリングされたファイルに名前を付けて保存します。 @@ -357,17 +357,17 @@ Toolkit がファイルを読み書きする場所はテンプレートが定義 ### テストの実行 -**手順 18:** Shotgun Desktop から Maya を起動します。 +**手順 18:** {% include product %} Desktop から Maya を起動します。 ![Python アプリ](images/dynamic_filesystem_configuration/23_test_file_creation.png) -Maya で、**[Shotgun] > [File Open]（ファイルを開く）**に移動し、表示されるダイアログで、Shotgun で Set を指定したアセットのタスクを選択します。 +Maya で、**[{% include product %}] > [File Open]（ファイルを開く）**に移動し、表示されるダイアログで、{% include product %} で Set を指定したアセットのタスクを選択します。 ![Python アプリ](images/dynamic_filesystem_configuration/24_test_new_file.png) **[+ 新しいファイル]（+New File）**を選択します。 -単純な 3D オブジェクトを作成するか、**[Shotgun] > [Save File]（ファイルを保存）**を使用してファイルを保存することができます。 +単純な 3D オブジェクトを作成するか、**[{% include product %}] > [Save File]（ファイルを保存）**を使用してファイルを保存することができます。 ![Python アプリ](images/dynamic_filesystem_configuration/file_save.png) @@ -375,17 +375,17 @@ Maya で、**[Shotgun] > [File Open]（ファイルを開く）**に移動し、 テンプレートの新しい設定を使用して、**[File Save]**ダイアログボックスに**プレビュー：Dining-Room_scene.v001.ma **が表示されていることに注意してください。 -**Work Area**: Workfiles がファイルを保存するパスとして **.../Shotgun/projects/the_other_side/assets/Dining-Room/Prop/Filet/model/work/maya** を表示します。 +**Work Area**: Workfiles がファイルを保存するパスとして **.../{% include product %}/projects/the_other_side/assets/Dining-Room/Prop/Filet/model/work/maya** を表示します。 ## 高度なトピック ### 例を拡張する -この例では 1 つのテンプレートを変更しましたが、ファイルシステムの設定については他にもさまざまな操作を実行できます。現実の例では、*すべての*アセット関連のファイルを同じファイル命名規則に従うように変更します。他のエンティティ(Season、Episode、Level など)に基づいて変更を加えたり、ユーザ フォルダを作成したり、正規表現で操作した Shotgun のデータに基づいてフォルダに名前を付けたりすることができます。Toolkit のすべてのフォルダおよびスキーマ オプションについては、『[ファイル システム設定リファレンス]( https://support.shotgunsoftware.com/hc/ja/articles/219039868 )』を参照してください。 +この例では 1 つのテンプレートを変更しましたが、ファイルシステムの設定については他にもさまざまな操作を実行できます。現実の例では、*すべての*アセット関連のファイルを同じファイル命名規則に従うように変更します。他のエンティティ(Season、Episode、Level など)に基づいて変更を加えたり、ユーザ フォルダを作成したり、正規表現で操作した {% include product %} のデータに基づいてフォルダに名前を付けたりすることができます。Toolkit のすべてのフォルダおよびスキーマ オプションについては、『[ファイル システム設定リファレンス]( https://support.shotgunsoftware.com/hc/ja/articles/219039868 )』を参照してください。 ### パス キャッシュ -フォルダ作成時に、ディスク上のフォルダと Shotgun エンティティの間にマッピングが作成されます。これらのマッピングは Shotgun の FilesystemLocation エンティティとして保存され、ユーザのマシンの SQLite データベースにキャッシュされます。パス キャッシュの仕組みと、その使用方法の詳細については、[このドキュメント](../../../quick-answers/administering/what-is-path-cache.md)を参照してください。 +フォルダ作成時に、ディスク上のフォルダと {% include product %} エンティティの間にマッピングが作成されます。これらのマッピングは {% include product %} の FilesystemLocation エンティティとして保存され、ユーザのマシンの SQLite データベースにキャッシュされます。パス キャッシュの仕組みと、その使用方法の詳細については、[このドキュメント](../../../quick-answers/administering/what-is-path-cache.md)を参照してください。 ### その他のリソース diff --git a/docs/ja/guides/pipeline-integrations/getting-started/editing_app_setting.md b/docs/ja/guides/pipeline-integrations/getting-started/editing_app_setting.md index a414167db..99005d426 100644 --- a/docs/ja/guides/pipeline-integrations/getting-started/editing_app_setting.md +++ b/docs/ja/guides/pipeline-integrations/getting-started/editing_app_setting.md @@ -16,38 +16,38 @@ lang: ja このガイドでは、プロジェクト パイプラインの要求に応じて、既存のパイプライン設定内の設定を編集する方法について説明します。最初のガイドの『**[設定の基本操作](./advanced_config.md)**』では、パイプライン設定を編集するための準備方法について説明しました。プロジェクトに対して編集可能な設定を作成する方法を理解していない場合は、「**設定の基本操作**」を参照してから、先へ進んでください。 -Shotgun Toolkit では、既定の設定を拡張することにより、パイプラインのワークフロー内のタスクをカスタマイズできます。カスタマイズの例としては、ユーザが Toolkit の機能を操作する方法を変更するために、いくつかのソフトウェア パッケージに含まれている Toolkit アプリのボタンを有効または無効に切り替えるだけという簡単なものがあります。Toolkit には独自の設定を行う機能があるため、カスタム ワークフローの作成、反復タスクや日常的なタスクの自動化、フックの変更、および Toolkit プラットフォーム上に構築されたカスタム ツールの追加といった作業を、スマートに、かつ短時間で行うことができます。ただし、Toolkit にアクセスするには Shotgun ソフトウェアの統合が必要であり、衣服を洗うなどの日常的なタスク向けのリリースはまだ実現していません。 +{% include product %} Toolkit では、既定の設定を拡張することにより、パイプラインのワークフロー内のタスクをカスタマイズできます。カスタマイズの例としては、ユーザが Toolkit の機能を操作する方法を変更するために、いくつかのソフトウェア パッケージに含まれている Toolkit アプリのボタンを有効または無効に切り替えるだけという簡単なものがあります。Toolkit には独自の設定を行う機能があるため、カスタム ワークフローの作成、反復タスクや日常的なタスクの自動化、フックの変更、および Toolkit プラットフォーム上に構築されたカスタム ツールの追加といった作業を、スマートに、かつ短時間で行うことができます。ただし、Toolkit にアクセスするには {% include product %} ソフトウェアの統合が必要であり、衣服を洗うなどの日常的なタスク向けのリリースはまだ実現していません。 -このガイドの演習では、Shotgun ソフトウェア統合内のアクションをコントロールする構成設定の見つけ方、設定の配置場所、および設定の編集方法について説明します。具体的には、**[+New Task]**ボタンの動作を管理する Workfiles アプリの設定を編集することにより、アーティストが Maya 内のプロジェクトで作業しているときに新しいタスクを作成できないようにします。 +このガイドの演習では、{% include product %} ソフトウェア統合内のアクションをコントロールする構成設定の見つけ方、設定の配置場所、および設定の編集方法について説明します。具体的には、**[+New Task]**ボタンの動作を管理する Workfiles アプリの設定を編集することにより、アーティストが Maya 内のプロジェクトで作業しているときに新しいタスクを作成できないようにします。 ## このドキュメントの使い方 このガイドを使用してパイプライン設定を編集するには、以下が必要です。 -1. アクティブな [Shotgun](https://www.shotgunsoftware.com/jp/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management) サイト。 +1. アクティブな [{% include product %}](https://www.shotgunsoftware.com/jp/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management) サイト。 2. 1 つ以上のアセットを含むプロジェクト。最初のガイドで作成した the_other_side プロジェクトにアセットを追加できます。プロジェクトのアセットを作成する方法については、「[設定の基本操作](./advanced_config.md)」ガイドを確認してください。 3. 指定したプロジェクトのパイプライン設定。この設定がない場合は、「[設定の基本操作](./advanced_config.md)」ガイドを参照し、その演習で作成した設定を使用します。 4. パイプライン設定を保存するファイルシステムに最適になるように設定された読み取りおよび書き込み権限。 -5. システムにインストールされた Shotgun Desktop。 +5. システムにインストールされた {% include product %} Desktop。 6. Maya の有効なサブスクリプション。Maya の 30 日間無償体験版は[こちら](https://www.autodesk.co.jp/products/maya/free-trial)から取得してください。 {% include info title="注" content="このガイドは `tk-config-default2` パイプライン設定をベースにしています。 設定が変更されている場合は、YAML 設定のファイル、フォルダ、およびブロックの場所がここに記載されている内容と異なる可能性があります。"%} ## Workfiles アプリについて -Workfiles アプリは、Shotgun ソフトウェア統合のファイル管理を行い、作業ファイルの参照、オープン、および保存機能へのアクセスをコントロールします。**[+New Task]**ボタンをクリックすると Workfiles アプリのアクションが実行され、Shotgun に移動しなくてもタスクを追加することができます。設定は環境単位のファイルに分割されています。これにより、ユーザはパイプライン内のステージごとに機能を管理して、ユーザがファイルを作成、命名、保存する、タスクを実行する、または特定の機能を実行するタイミングをコントロールすることができます。これは Workfiles アプリのすべての機能に関係し、任意のアプリまたはエンジンの設定を変更する場合にも適用されます。詳細については、このドキュメントの末尾にある「[高度なトピック](#advanced-topics)」を参照してください。 +Workfiles アプリは、{% include product %} ソフトウェア統合のファイル管理を行い、作業ファイルの参照、オープン、および保存機能へのアクセスをコントロールします。**[+New Task]**ボタンをクリックすると Workfiles アプリのアクションが実行され、{% include product %} に移動しなくてもタスクを追加することができます。設定は環境単位のファイルに分割されています。これにより、ユーザはパイプライン内のステージごとに機能を管理して、ユーザがファイルを作成、命名、保存する、タスクを実行する、または特定の機能を実行するタイミングをコントロールすることができます。これは Workfiles アプリのすべての機能に関係し、任意のアプリまたはエンジンの設定を変更する場合にも適用されます。詳細については、このドキュメントの末尾にある「[高度なトピック](#advanced-topics)」を参照してください。 ## 設定ファイルの概要 -作業しているプロジェクトのパイプライン設定が保存されている場所を見つけるには、Shotgun のパイプライン設定リストを使用します。保存場所がわかっている場合は、手順 5 に進みます。 +作業しているプロジェクトのパイプライン設定が保存されている場所を見つけるには、{% include product %} のパイプライン設定リストを使用します。保存場所がわかっている場合は、手順 5 に進みます。 ## パイプライン設定を見つける -**手順 1:** この演習で使用するプロジェクトを管理している **Shotgun サイト**を開きます。 +**手順 1:** この演習で使用するプロジェクトを管理している **{% include product %} サイト**を開きます。 -**手順 2:** **Shotgun サイト**の **[プロジェクト]（Projects）ページ**でプロジェクトを選択して、Shotgun サイトのプロジェクトにアクセスします。 +**手順 2:** **{% include product %} サイト**の **[プロジェクト]（Projects）ページ**でプロジェクトを選択して、{% include product %} サイトのプロジェクトにアクセスします。 -![Shotgun プロジェクト](./images/editing_app_setting/1_shotgun_project.png) +![{% include product %} プロジェクト](./images/editing_app_setting/1_shotgun_project.png) **手順 3:** 右上にある**アバター**を選択して、**[管理者]（ADMIN）**メニューを表示し、下にスクロールして**[既定のレイアウト]（Default Layouts）> [パイプラインの設定]（Pipeline Configuration）> [パイプライン設定リスト]（Pipeline Configuration List）**を選択します。 @@ -75,23 +75,23 @@ Toolkit は YAML ファイルを使用して機能を設定します。YAML が ## 設定ファイルを編集する -Shotgun Toolkit を使用すると、さまざまなソフトウェア パッケージ内に統合されたアプリを変更できます。Workfiles アプリの機能の例としては、**[+New Task]** ボタンがあります。ユーザはこのボタンをクリックして、**[File Open]**ダイアログ ボックスに新しいタスクを追加できます。既定では、この機能はプロジェクトのすべてのフェーズで、すべてのユーザに対して有効になっています。ただし、スタジオでこの機能を制限したい場合があります。たとえば、特定の命名規則がある場合や、タスクの作成をプロジェクトのプロダクション管理チームに限定する場合などです。この場合は、アーティストが Maya で作業するパイプライン内のすべてのポイントで、**[+New Task]**ボタンを無効にします。 +{% include product %} Toolkit を使用すると、さまざまなソフトウェア パッケージ内に統合されたアプリを変更できます。Workfiles アプリの機能の例としては、**[+New Task]** ボタンがあります。ユーザはこのボタンをクリックして、**[File Open]**ダイアログ ボックスに新しいタスクを追加できます。既定では、この機能はプロジェクトのすべてのフェーズで、すべてのユーザに対して有効になっています。ただし、スタジオでこの機能を制限したい場合があります。たとえば、特定の命名規則がある場合や、タスクの作成をプロジェクトのプロダクション管理チームに限定する場合などです。この場合は、アーティストが Maya で作業するパイプライン内のすべてのポイントで、**[+New Task]**ボタンを無効にします。 ## Maya のプロジェクトに対して[+New Task]ボタンを無効にする -**手順 7:** **Shotgun Desktop** を開きます。 +**手順 7:** **{% include product %} Desktop** を開きます。 **手順 8:** 設定を編集するプロジェクトを選択します。 ![プロジェクトをロード](./images/editing_app_setting/6_load_project.png) -**手順 9:** Shotgun Desktop から Maya を起動します。 +**手順 9:** {% include product %} Desktop から Maya を起動します。 ![プロジェクトをロード](./images/editing_app_setting/7_view_project.png) -**Shotgun** メニューが完全にロードされるまで待ちます。インターネット接続速度が遅い場合は、この間に設定を行いましょう。つまり、適度な量のクリームを入れて一杯の完璧なエスプレッソを作るようなものです。 +**{% include product %}** メニューが完全にロードされるまで待ちます。インターネット接続速度が遅い場合は、この間に設定を行いましょう。つまり、適度な量のクリームを入れて一杯の完璧なエスプレッソを作るようなものです。 -Maya および Shotgun が完全にロードされると、**[File Open]**ダイアログ ボックスが自動的に開きます。Shotgun Desktop から Maya を起動すると、Maya は **project** 環境になり、Toolkit ワークフローの設定はファイル `config/env/project.yml` によって制御されます。既定の設定で識別される環境は、`project`、`sequence`、`shot`、`shot_step`、`asset`、`asset_step` です。 +Maya および {% include product %} が完全にロードされると、**[File Open]**ダイアログ ボックスが自動的に開きます。{% include product %} Desktop から Maya を起動すると、Maya は **project** 環境になり、Toolkit ワークフローの設定はファイル `config/env/project.yml` によって制御されます。既定の設定で識別される環境は、`project`、`sequence`、`shot`、`shot_step`、`asset`、`asset_step` です。 **手順 10:** **[File Open]**ダイアログ ボックスの左側のペインで**[Assets]**タブを選択します。検索結果に表示されたフォルダ内のいずれかのアセットを選択します。 @@ -101,11 +101,11 @@ Maya および Shotgun が完全にロードされると、**[File Open]**ダイ ## [+New Task]ボタンをコントロールする設定を特定する -Toolkit のパイプライン設定は、パイプラインに対するユーザのニーズに合わせて環境をカスタマイズする場合に使用します。パイプライン設定では、プロジェクトのパイプラインに対するニーズに合わせて、既定の Shotgun の統合の設定を必要なだけオーバーライドできます。この構造により、設定は軽量化され、Shotgun の主要コード内の既定値と異なる設定のみを追加することができます。この演習では、Workfiles アプリの**[+New Task]**ボタンをオフにしますが、その前にこのボタンをコントロールする構成設定を特定する必要があります。 +Toolkit のパイプライン設定は、パイプラインに対するユーザのニーズに合わせて環境をカスタマイズする場合に使用します。パイプライン設定では、プロジェクトのパイプラインに対するニーズに合わせて、既定の {% include product %} の統合の設定を必要なだけオーバーライドできます。この構造により、設定は軽量化され、{% include product %} の主要コード内の既定値と異なる設定のみを追加することができます。この演習では、Workfiles アプリの**[+New Task]**ボタンをオフにしますが、その前にこのボタンをコントロールする構成設定を特定する必要があります。 **手順 11:** **[Project (プロジェクト名)]**の横にある**[File Open]**ウィンドウの上部にある **[>]** を選択します。 -この参照ボックスには、**[File Open]**ウィンドウの機能をコントロールする構成設定の詳細が表示されます。Toolkit の一部のアプリには、アプリに使用される設定と、既定の設定を表示する参照ボックスがあります。**[Location:]**に注目してください。識別子は **tk-multi-workfiles2** です。これは、Workfiles アプリを作成するコードのバンドルの識別子です。パイプライン設定を検索する場合、この名前でアプリの設定の配置場所を識別します。Shotgun の統合で使用可能な機能に関するすべての構成設定、アプリ、エンジンがリストされた「[アプリとエンジンの概要](https://support.shotgunsoftware.com/hc/ja/articles/219039798-Integrations-Apps-and-Engines)」ページがあります。 +この参照ボックスには、**[File Open]**ウィンドウの機能をコントロールする構成設定の詳細が表示されます。Toolkit の一部のアプリには、アプリに使用される設定と、既定の設定を表示する参照ボックスがあります。**[Location:]**に注目してください。識別子は **tk-multi-workfiles2** です。これは、Workfiles アプリを作成するコードのバンドルの識別子です。パイプライン設定を検索する場合、この名前でアプリの設定の配置場所を識別します。{% include product %} の統合で使用可能な機能に関するすべての構成設定、アプリ、エンジンがリストされた「[アプリとエンジンの概要](https://support.shotgunsoftware.com/hc/ja/articles/219039798-Integrations-Apps-and-Engines)」ページがあります。 ![Current_work_area](./images/editing_app_setting/9_current_work_area.png) @@ -135,13 +135,13 @@ Toolkit のパイプライン設定は、パイプラインに対するユーザ **手順 12:** メインの Maya ウィンドウを前面に表示します。 -**手順 13:** Maya ウィンドウの右上にある**[Shotgun]** メニュー項目を特定します。 +**手順 13:** Maya ウィンドウの右上にある**[{% include product %}]** メニュー項目を特定します。 -![Maya shotgun2](./images/editing_app_setting/12_Maya_Shotgun2.png) +![Maya {% include product %}2](./images/editing_app_setting/12_Maya_Shotgun2.png) -**ヒント:** メニューが表示されない場合は、一部のメニュー項目が非表示になっていることを示す**[>>]**が表示されています。**[>>]**を選択して Shotgun メニューを表示するか、Maya ウィンドウの幅を広げます。 +**ヒント:** メニューが表示されない場合は、一部のメニュー項目が非表示になっていることを示す**[>>]**が表示されています。**[>>]**を選択して {% include product %} メニューを表示するか、Maya ウィンドウの幅を広げます。 -**手順 14:** **メニューの右上にある[Shotgun] > プロジェクト the_other_side > [Work Area Info...]**を選択します。 +**手順 14:** **メニューの右上にある[{% include product %}] > プロジェクト the_other_side > [Work Area Info...]**を選択します。 ![Work Area Info](./images/editing_app_setting/13_work_area_info.png) @@ -149,7 +149,7 @@ Toolkit のパイプライン設定は、パイプラインに対するユーザ **手順 15:** **[Your Current Work Area]**ダイアログ ボックスの下部にある**[Environment]**タブを選択します。 -最初の項目は、使用されているエンジンを識別します。このエンジンは、特定のソフトウェア アプリケーションに Shotgun ツールを統合する機能を制御します。このエンジンには、各ソフトウェア統合に固有のロジックが保持されています。ウィンドウに表示される 2 番目の項目は、現在のプロジェクト環境の配置場所のパスを示します。 +最初の項目は、使用されているエンジンを識別します。このエンジンは、特定のソフトウェア アプリケーションに {% include product %} ツールを統合する機能を制御します。このエンジンには、各ソフトウェア統合に固有のロジックが保持されています。ウィンドウに表示される 2 番目の項目は、現在のプロジェクト環境の配置場所のパスを示します。 ![Work area info environment](./images/editing_app_setting/14_shotgun_work_area_info_Environment.png) @@ -219,7 +219,7 @@ frameworks: "@frameworks" この行全体は、インクルードされたファイル内の `settings.tk-maya.project` ブロックを探して、Maya エンジン `tk-maya` の構成設定を探すようユーザに指示しています。 -Shotgun Toolkit は YAML ファイル内で単純な用語を使用して、設定の名前や、設定に到達するためのパスを示します。Maya の**[File Open]**参照ボックスを調べて気づいたように、**[+New Task]**ボタンの実行方法をコントロールするコード バンドルは `tk-multi-workfiles2` で識別されます。Toolkit のバンドルは、YAML ファイル内でこれらの識別子を使用して参照されています。「tk-multi-workfiles2」は、Workfiles アプリのコード バンドルの識別子です。**[+New Task]**ボタンは、Workfiles アプリの機能です。 +{% include product %} Toolkit は YAML ファイル内で単純な用語を使用して、設定の名前や、設定に到達するためのパスを示します。Maya の**[File Open]**参照ボックスを調べて気づいたように、**[+New Task]**ボタンの実行方法をコントロールするコード バンドルは `tk-multi-workfiles2` で識別されます。Toolkit のバンドルは、YAML ファイル内でこれらの識別子を使用して参照されています。「tk-multi-workfiles2」は、Workfiles アプリのコード バンドルの識別子です。**[+New Task]**ボタンは、Workfiles アプリの機能です。 tk-maya.yml での Workfiles アプリの検索 @@ -318,7 +318,7 @@ settings.tk-multi-workfiles2.launch_at_startup: ## 作業している環境を見つける -**手順 26:** Maya メニューの右上で**[Shotgun]**を選択します。 +**手順 26:** Maya メニューの右上で**[{% include product %}]**を選択します。 ![Art、Asset 環境](./images/editing_app_setting/23_Art_Asset.png) @@ -334,7 +334,7 @@ settings.tk-multi-workfiles2.launch_at_startup: 注: 各環境は独立していて、プロジェクトには専用の設定があります。また、プロジェクトがロードされるときにソフトウェアの統合によってパイプライン設定から読み取られるのは、特定のソフトウェアの設定のみです。 -これでパイプライン設定の編集と、アプリの設定の変更が完了しました。ここから先は、楽しみながら作業できます。Shotgun Toolkit 環境で実行できるすべての機能について学習しましょう。次に、これから調べる高度なトピックをいくつか示します。 +これでパイプライン設定の編集と、アプリの設定の変更が完了しました。ここから先は、楽しみながら作業できます。{% include product %} Toolkit 環境で実行できるすべての機能について学習しましょう。次に、これから調べる高度なトピックをいくつか示します。 ## 高度なトピック diff --git a/docs/ja/guides/pipeline-integrations/getting-started/installing_app.md b/docs/ja/guides/pipeline-integrations/getting-started/installing_app.md index 559d554a9..6b7f7c3f8 100644 --- a/docs/ja/guides/pipeline-integrations/getting-started/installing_app.md +++ b/docs/ja/guides/pipeline-integrations/getting-started/installing_app.md @@ -16,9 +16,9 @@ lang: ja ## このガイドについて -このガイドでは、既存のパイプライン設定に Shotgun Toolkit アプリを追加する方法について説明します。設定管理ツールに関する知識を短時間で得ることができます。 +このガイドでは、既存のパイプライン設定に {% include product %} Toolkit アプリを追加する方法について説明します。設定管理ツールに関する知識を短時間で得ることができます。 -ここで追加するアプリは、Shotgun Python コンソール アプリです。Maya には独自の Python コンソールがありますが、Toolkit アプリには Maya コンソールにない機能がいくつか用意されています。 +ここで追加するアプリは、{% include product %} Python コンソール アプリです。Maya には独自の Python コンソールがありますが、Toolkit アプリには Maya コンソールにない機能がいくつか用意されています。 このガイドでは、「[パイプライン設定を編集する](./editing_app_setting.md)」ガイドで作成したパイプライン設定を利用します。 このガイドをまだ完了していない場合は、既存のパイプライン設定を使用してアプリを追加してください。 @@ -26,36 +26,36 @@ lang: ja このガイドを使用して Toolkit アプリをインストールするには、以下が必要です。 -1. アクティブな [Shotgun](https://www.shotgunsoftware.com/jp/signup/) サイト。 +1. アクティブな [{% include product %}](https://www.shotgunsoftware.com/jp/signup/) サイト。 2. 指定したプロジェクトのパイプライン設定。この設定がない場合は、「[設定の基本操作](./advanced_config.md)」ガイドの手順を完了し、その演習で作成した設定を使用します。 3. パイプライン設定の保存先のファイルシステムに最適になるように設定された読み取りおよび書き込み権限。 -4. システムにインストールされた Shotgun Desktop。 +4. システムにインストールされた {% include product %} Desktop。 5. Maya の有効なサブスクリプション。Maya の 30 日間無償体験版は[こちら](https://www.autodesk.co.jp/products/maya/free-trial)から取得してください。 {% include info title="注" content="このガイドは tk-config-default2 パイプライン設定をベースにしています。 設定が変更されている場合は、YAML 設定のファイル、フォルダ、およびブロックの場所がここに記載されている内容と異なる可能性があります。"%} -## Shotgun Toolkit アプリについて +## {% include product %} Toolkit アプリについて ### Toolkit アプリの仕組み -パイプライン設定で参照されているアプリは、さまざまな場所から取得できます。既定の設定の標準アプリは、Shotgun アプリ ストアから取得されています。パイプライン設定内のファイルを使って、Shotgun 統合からアプリにアクセスする方法を指定します。これはたとえば Toolkit に、「アドレス帳にある Python コンソール アプリのアドレスを調べることはできますか」と尋ねるようなものです。パイプライン設定ファイルは Toolkit に、特定のアプリで利用されているコードのバンドルの検索場所を指示します。 +パイプライン設定で参照されているアプリは、さまざまな場所から取得できます。既定の設定の標準アプリは、{% include product %} アプリ ストアから取得されています。パイプライン設定内のファイルを使って、{% include product %} 統合からアプリにアクセスする方法を指定します。これはたとえば Toolkit に、「アドレス帳にある Python コンソール アプリのアドレスを調べることはできますか」と尋ねるようなものです。パイプライン設定ファイルは Toolkit に、特定のアプリで利用されているコードのバンドルの検索場所を指示します。 -Toolkit アプリの「アドレス」は既定の設定の `config/env/includes/app_locations.yml` ファイルにリストされていて、コードの検索方法を指定します。これらの「アドレス」は[記述子](https://developer.shotgunsoftware.com/tk-core/descriptor.html)といいます。Shotgun の統合には、アプリのコード バンドルの検索方法だけでなく、アプリの使用環境も指示する必要があります。 +Toolkit アプリの「アドレス」は既定の設定の `config/env/includes/app_locations.yml` ファイルにリストされていて、コードの検索方法を指定します。これらの「アドレス」は[記述子](https://developer.shotgunsoftware.com/tk-core/descriptor.html)といいます。{% include product %} の統合には、アプリのコード バンドルの検索方法だけでなく、アプリの使用環境も指示する必要があります。 -以下に、アプリのインストール方法と、Shotgun の統合にアプリの使用場所を指示する方法について、概念を示します。また、設定を拡張し、記述子を検索するよう Toolkit に要求して、アプリの使用場所を Shotgun に指示する手順についても説明します。このガイドでは、次の手順について詳細に説明します。 +以下に、アプリのインストール方法と、{% include product %} の統合にアプリの使用場所を指示する方法について、概念を示します。また、設定を拡張し、記述子を検索するよう Toolkit に要求して、アプリの使用場所を {% include product %} に指示する手順についても説明します。このガイドでは、次の手順について詳細に説明します。 1. 追加するアプリの記述子を判別します。 2. アプリの記述子の追加先となるアクティブなパイプライン設定をコピーします。 3. アプリの記述子が設定に含まれているかどうかを確認して、含まれていない場合は追加します。 4. YAML ファイルを正しくフォーマットします(インデントにはタブでなく、スペースを使用します)。 5. アプリの使用環境を判別します。 -6. これらの環境内で、Shotgun にアプリの使用を許可する設定を追加します。 +6. これらの環境内で、{% include product %} にアプリの使用を許可する設定を追加します。 7. 新しい設定をテストします。 8. 拡張した設定を有効にします。 ### Python コンソール アプリの場所の記述子を見つける -**手順 1:** 「[アプリとエンジンの概要](https://support.shotgunsoftware.com/hc/ja/articles/219039798#tk-maya)」ページを開いて、Maya の Shotgun Python コンソールの情報を検索します。タイトルを選択します。 +**手順 1:** 「[アプリとエンジンの概要](https://support.shotgunsoftware.com/hc/ja/articles/219039798#tk-maya)」ページを開いて、Maya の {% include product %} Python コンソールの情報を検索します。タイトルを選択します。 ![Python アプリ](./images/installing_app/1_python_app.png) @@ -67,7 +67,7 @@ Toolkit アプリの「アドレス」は既定の設定の `config/env/includes ### Maya のプロジェクト環境内に Python コンソール アプリが含まれていないことを確認する -**手順 2:** Maya を起動し、Shotgun メニューを選択して(**[Shotgun] > プロジェクト the_other_side**)、プロジェクト環境内にある、このプロジェクトで使用可能なアプリのリストを表示します。 +**手順 2:** Maya を起動し、{% include product %} メニューを選択して(**[{% include product %}] > プロジェクト the_other_side**)、プロジェクト環境内にある、このプロジェクトで使用可能なアプリのリストを表示します。 ![アプリのリスト](./images/installing_app/3_list_of_apps.png) @@ -81,11 +81,11 @@ Toolkit アプリの「アドレス」は既定の設定の `config/env/includes ### [パイプラインの設定]（Pipeline Configuration）リストに移動します。 -**手順 3**: Shotgun を開き、右上にある**[管理者]（Admin）メニュー（アバター） > [既定のレイアウト]（Default Layouts） > [パイプラインの設定]（Pipeline Configuration） > [パイプライン設定リスト]（Pipeline Configuration List）**を選択します。 +**手順 3**: {% include product %} を開き、右上にある**[管理者]（Admin）メニュー（アバター） > [既定のレイアウト]（Default Layouts） > [パイプラインの設定]（Pipeline Configuration） > [パイプライン設定リスト]（Pipeline Configuration List）**を選択します。 ![パイプライン設定リスト](./images/installing_app/4_REPLACE_pipeline_configuration_list.png) -この操作を行うと、Shotgun サイトのすべてのパイプライン設定の詳細なリストが表示されます。 +この操作を行うと、{% include product %} サイトのすべてのパイプライン設定の詳細なリストが表示されます。 **手順 4:** [パイプライン設定リスト]（Pipeline Configuration List）が表示されたら、列見出しの右端にある**[+]**記号を選択して、**[プロジェクト]（Projects）**列を追加します。 @@ -109,7 +109,7 @@ Toolkit アプリの「アドレス」は既定の設定の `config/env/includes ![クローンに名前を付ける](./images/installing_app/9_name_clone.png) -Shotgun によって設定内のすべてのファイルおよびフォルダがコピーされ、アプリのキャッシュが作成されるまで待ちます。この時間を利用して、エスプレッソの完璧なショットと一緒に、軽く、ふわっとした、口の中でとろけるクロワッサンを作成するアプリを使用しましょう。 +{% include product %} によって設定内のすべてのファイルおよびフォルダがコピーされ、アプリのキャッシュが作成されるまで待ちます。この時間を利用して、エスプレッソの完璧なショットと一緒に、軽く、ふわっとした、口の中でとろけるクロワッサンを作成するアプリを使用しましょう。 ![クローン作成完了](./images/installing_app/10_clone_complete.png) @@ -119,11 +119,11 @@ Shotgun によって設定内のすべてのファイルおよびフォルダが ## クローン作成された設定にプロジェクトを関連付ける -**手順 8:** Shotgun Desktop を開いて、クローン作成した設定を作成する対象となったプロジェクトを選択します。右上にある**下矢印**を選択して、このプロジェクトに関連付けられた設定を表示し、直前に作成した**[Primary Clone Config 2]**を選択します。 +**手順 8:** {% include product %} Desktop を開いて、クローン作成した設定を作成する対象となったプロジェクトを選択します。右上にある**下矢印**を選択して、このプロジェクトに関連付けられた設定を表示し、直前に作成した**[Primary Clone Config 2]**を選択します。 ![クローンを選択](./images/installing_app/11_select_clone.png) -これで、Shotgun Desktop がこのプロジェクトでクローン作成した設定を使用するようになりました。 +これで、{% include product %} Desktop がこのプロジェクトでクローン作成した設定を使用するようになりました。 ## パイプライン設定を編集する @@ -181,7 +181,7 @@ engines: ### YAML ファイル -Shotgun Toolkit パイプライン設定は [YAML](https://yaml.org/spec/1.2/spec.html) ファイル内で単純な用語を使用して、アプリやエンジンの場所、およびこれらの設定を識別します。 +{% include product %} Toolkit パイプライン設定は [YAML](https://yaml.org/spec/1.2/spec.html) ファイル内で単純な用語を使用して、アプリやエンジンの場所、およびこれらの設定を識別します。 この特定のブロックの各要素は、次のとおりです。 @@ -190,11 +190,11 @@ Shotgun Toolkit パイプライン設定は [YAML](https://yaml.org/spec/1.2/spe * `tk-maya` は、Maya 用の Toolkit エンジンの識別子です。 * `@` は、設定値がインクルードされたファイルから取得されたことを示すために使用される Toolkit 用語です。 -YAML ファイルは Shotgun の統合の窓口であり、パイプラインの要求を満たす作業環境を簡単に設定できるようにします。 +YAML ファイルは {% include product %} の統合の窓口であり、パイプラインの要求を満たす作業環境を簡単に設定できるようにします。 ### 設定における Toolkit バンドルの参照方法 -Shotgun の統合のコードは、アプリ、エンジン、およびフレームワークのバンドルに整理されています。これらのバンドルは、`tk-maya`、`tk-multi-pythonconsole` のような記述子を使用して、Toolkit の YAML ファイル内で参照されています。YAML の各バンドルに対応するブロックには、識別されたバンドルへのアクセス方法や利用方法をコントロールする設定が含まれています。 +{% include product %} の統合のコードは、アプリ、エンジン、およびフレームワークのバンドルに整理されています。これらのバンドルは、`tk-maya`、`tk-multi-pythonconsole` のような記述子を使用して、Toolkit の YAML ファイル内で参照されています。YAML の各バンドルに対応するブロックには、識別されたバンドルへのアクセス方法や利用方法をコントロールする設定が含まれています。 ## Python コンソールの設定の配置場所 @@ -232,7 +232,7 @@ settings.tk-maya.project: tk-multi-workfiles2: "@settings.tk-multi-workfiles2.launch_at_startup" ``` -**Screening Room、Shotgun Panel、および Workfiles2** アプリの場所識別子は別のインクルードされたファイルにリストされていて、**About** アプリとアクセス方法が異なります。これらのアプリには追加設定があるため、情報整理しておくために、これらのアプリはインクルードされた設定フォルダに分割して配置されています。 +**Screening Room、{% include product %} Panel、および Workfiles2** アプリの場所識別子は別のインクルードされたファイルにリストされていて、**About** アプリとアクセス方法が異なります。これらのアプリには追加設定があるため、情報整理しておくために、これらのアプリはインクルードされた設定フォルダに分割して配置されています。 {% include info title="注" content="python コンソール アプリは既に既定の設定に存在しますが、これまでに設定に追加したことがないアプリを追加する場合、またはアプリのバージョンを変更し、[中央設定](https://developer.shotgunsoftware.com/tk-core/initializing.html#centralized-configurations)を使用している場合は、追加の手順が必要になります。端末を開いて、クローン作成した設定の保存場所を参照します。クローン作成した設定のルート フォルダから、次のコマンドを実行します。
@@ -248,7 +248,7 @@ Windows の場合: ## Maya で変更内容を表示する -**手順 16:** Shotgun Desktop を開いて、作業しているプロジェクトを選択し、クローン作成された設定を使用していることを確認します。 +**手順 16:** {% include product %} Desktop を開いて、作業しているプロジェクトを選択し、クローン作成された設定を使用していることを確認します。 青いバーが表示され、プロジェクトの名前の下に、作成したクローンの名前が示されます。 @@ -256,7 +256,7 @@ Windows の場合: ![Maya のクローン作成された設定](./images/installing_app/14_maya_cloned_config.png) -**手順 17:** Desktop から Maya を起動して、メニュー **[Shotgun] > [プロジェクト]（Project） > […]**を選択します。 +**手順 17:** Desktop から Maya を起動して、メニュー **[{% include product %}] > [プロジェクト]（Project） > […]**を選択します。 次の場合: @@ -264,7 +264,7 @@ Windows の場合: * クローン作成した設定が正しく拡張された場合 * 拡張したファイルを保存した場合 * プロジェクトにクローン作成した設定を関連付けるよう選択した場合 -* Shotgun Desktop から Maya を再起動した場合 +* {% include product %} Desktop から Maya を再起動した場合 Maya で Python コンソール アプリを使用できるようになります。 @@ -328,7 +328,7 @@ Please type in the id of the configuration to push to (ENTER to exit): ![ID 列](./images/installing_app/17_id_column.png) -ID を入力した後、Shotgun は以下の処理を行います。 +ID を入力した後、{% include product %} は以下の処理を行います。 * プライマリ設定をバックアップする * クローン作成した設定をコピーする @@ -348,11 +348,11 @@ Push Complete! ## プライマリ設定で行った変更を表示する -**手順 19:** Shotgun Desktop の右上にある矢印をクリックして、**[CONFIGURATION]**リスト内の**[Primary]**を選択します。 +**手順 19:** {% include product %} Desktop の右上にある矢印をクリックして、**[CONFIGURATION]**リスト内の**[Primary]**を選択します。 ![Maya の設定の変更](./images/installing_app/18_change_config_maya.png) -**手順 20:** Desktop から Maya を起動して、メニュー**[Shotgun] > [プロジェクト]（Project） > […]**を参照して、Shotgun Python コンソールを検索します。 +**手順 20:** Desktop から Maya を起動して、メニュー**[{% include product %}] > [プロジェクト]（Project） > […]**を参照して、{% include product %} Python コンソールを検索します。 ![Maya のアプリ](./images/installing_app/19_app_in_maya.png) @@ -360,15 +360,15 @@ Python コンソール アプリが、選択されたプロジェクトのプロ ## 高度なトピック -### Shotgun 開発者のコミュニティ +### {% include product %} 開発者のコミュニティ -Toolkit の素晴らしい点の 1 つに、Toolkit アプリを誰でも作成できることがあります。また、アプリの所有権を維持したり、[Shotgun コミュニティ](https://support.shotgunsoftware.com/hc/ja/articles/219039828)内でアプリを共有して Shotgun ツールに追加したりできます。非常に便利なアプリを作成したため、Shotgun コミュニティ ページで共有したい場合は、[support@shotgunsoftware.com](mailto:support@shotgunsoftware.com) にメールでお問い合わせください。 +Toolkit の素晴らしい点の 1 つに、Toolkit アプリを誰でも作成できることがあります。また、アプリの所有権を維持したり、[{% include product %} コミュニティ](https://support.shotgunsoftware.com/hc/ja/articles/219039828)内でアプリを共有して {% include product %} ツールに追加したりできます。非常に便利なアプリを作成したため、{% include product %} コミュニティ ページで共有したい場合は、[support@shotgunsoftware.com](mailto:support@shotgunsoftware.com) にメールでお問い合わせください。 -標準的な Toolkit アプリや、愛情のこもった Shotgun コミュニティで作成されたアプリについては、**[shotgun-dev Google グループ](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups&hl=ja#!forum/shotgun-dev)**で活発に議論されています。Shotgun コミュニティの貢献度が高まるにつれて、知識やツールの基盤も拡大しています。 +標準的な Toolkit アプリや、愛情のこもった {% include product %} コミュニティで作成されたアプリについては、**[{% include product %}-dev Google グループ](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups&hl=ja#!forum/shotgun-dev)**で活発に議論されています。{% include product %} コミュニティの貢献度が高まるにつれて、知識やツールの基盤も拡大しています。 ### 設定の拡張方法を調べる -プロジェクトで使用する設定を選択するときにおわかりになったように、Python コンソール アプリは Shotgun Desktop のドロップダウンから使用できます。 +プロジェクトで使用する設定を選択するときにおわかりになったように、Python コンソール アプリは {% include product %} Desktop のドロップダウンから使用できます。 ![Desktop の Python コンソール](./images/installing_app/20_desktop_python_console.png) diff --git a/docs/ja/guides/pipeline-integrations/getting_started.md b/docs/ja/guides/pipeline-integrations/getting_started.md index c2e006a7a..4a92f6f49 100644 --- a/docs/ja/guides/pipeline-integrations/getting_started.md +++ b/docs/ja/guides/pipeline-integrations/getting_started.md @@ -7,4 +7,4 @@ lang: ja # Getting Started -Shotgun Toolkit には、スタジオのパイプラインを作成するための高度にカスタマイズ可能な一連のツールが用意されています。アーティストは、コンテンツ作成ソフトウェアから移動しなくても、Shotgun から情報にアクセスし、他のユーザと作品を共有できます。これらのガイドは、実践的な演習を通して、独自の Toolkit パイプラインを設定できるように設計されています。Shotgun Desktop アプリを使用すると、プロジェクト用の編集可能な設定を生成したり、既存のアプリの設定を変更したり、さまざまなアーティストの環境に Toolkit アプリを追加してカスタム パイプラインを設計したりできます。各ガイドは以前のガイドを基に作成されていますが、記載されている手順はどこから読み進めてもかまいません。 +{% include product %} Toolkit には、スタジオのパイプラインを作成するための高度にカスタマイズ可能な一連のツールが用意されています。アーティストは、コンテンツ作成ソフトウェアから移動しなくても、{% include product %} から情報にアクセスし、他のユーザと作品を共有できます。これらのガイドは、実践的な演習を通して、独自の Toolkit パイプラインを設定できるように設計されています。{% include product %} Desktop アプリを使用すると、プロジェクト用の編集可能な設定を生成したり、既存のアプリの設定を変更したり、さまざまなアーティストの環境に Toolkit アプリを追加してカスタム パイプラインを設計したりできます。各ガイドは以前のガイドを基に作成されていますが、記載されている手順はどこから読み進めてもかまいません。 diff --git a/docs/ja/guides/pipeline-integrations/workflows/pipeline-tutorial.md b/docs/ja/guides/pipeline-integrations/workflows/pipeline-tutorial.md index 092315b30..19d6dd381 100644 --- a/docs/ja/guides/pipeline-integrations/workflows/pipeline-tutorial.md +++ b/docs/ja/guides/pipeline-integrations/workflows/pipeline-tutorial.md @@ -9,7 +9,7 @@ lang: ja このチュートリアルは、アニメーションや視覚効果用のシンプルで一般的なパイプラインの作成について説明します。このチュートリアルに従うと、外観加工を介してモデリングのアセットをプロダクション シーンに転送するのに必要なすべての処理を提供するパイプラインを作成できます。 -このパイプラインの対象となるワークフローの大部分は、Shotgun に組み込まれた統合機能を使用して、設定なしですぐに作業することができます。パイプラインの中の、スタジオがカスタム ソリューションを作成する頻度が高い部分については、このチュートリアルで、Toolkit プラットフォームを使用してアーティスト ワークフローをカスタマイズするプロセスを紹介します。 +このパイプラインの対象となるワークフローの大部分は、{% include product %} に組み込まれた統合機能を使用して、設定なしですぐに作業することができます。パイプラインの中の、スタジオがカスタム ソリューションを作成する頻度が高い部分については、このチュートリアルで、Toolkit プラットフォームを使用してアーティスト ワークフローをカスタマイズするプロセスを紹介します。 次に、このチュートリアルで作成されるパイプラインの概要を示します。 @@ -23,21 +23,21 @@ lang: ja ## 前提条件 -* **作業用の Shotgun プロジェクト** - このチュートリアルでは、Shotgun を使用してプロダクション データのトラッキングや管理を行った経験があることが前提となります。 +* **作業用の {% include product %} プロジェクト** - このチュートリアルでは、{% include product %} を使用してプロダクション データのトラッキングや管理を行った経験があることが前提となります。 -* **Shotgun 統合の概要** - Shotgun には統合機能が付属していて、手動設定が不要な、単純なプロダクション ワークフローがいくつか用意されています。このチュートリアルで説明されている手動設定やカスタマイズについて調べる前に、これらのワークフローの機能や範囲について理解する必要があります。Shotgun 統合の詳細については、[こちら](https://support.shotgunsoftware.com/hc/ja/articles/115000068574)を参照してください。 +* **{% include product %} 統合の概要** - {% include product %} には統合機能が付属していて、手動設定が不要な、単純なプロダクション ワークフローがいくつか用意されています。このチュートリアルで説明されている手動設定やカスタマイズについて調べる前に、これらのワークフローの機能や範囲について理解する必要があります。{% include product %} 統合の詳細については、[こちら](https://support.shotgunsoftware.com/hc/ja/articles/115000068574)を参照してください。 -* **Maya と Nuke の経験** - このチュートリアルは、Maya および Nuke を使用して単純なパイプラインを作成することを目的としています。Shotgun の統合機能をカスタマイズするには、これらのパッケージの基本について理解する必要があります。 +* **Maya と Nuke の経験** - このチュートリアルは、Maya および Nuke を使用して単純なパイプラインを作成することを目的としています。{% include product %} の統合機能をカスタマイズするには、これらのパッケージの基本について理解する必要があります。 -* **Python の操作に関する知識** - このチュートリアルでは、Python で記述された「フック」を使用して、Shotgun 統合の機能を変更する必要があります。 +* **Python の操作に関する知識** - このチュートリアルでは、Python で記述された「フック」を使用して、{% include product %} 統合の機能を変更する必要があります。 * **YAML に対する知識** - 作成しているパイプラインの設定のほとんどは、YAML ファイルを変更して処理されます。 ## その他のリソース -* [Shotgun サポート サイト](https://support.shotgunsoftware.com/hc/ja) +* [{% include product %} サポート サイト](https://support.shotgunsoftware.com/hc/ja) -* [Shotgun 統合](https://www.shotgunsoftware.com/jp/integrations/) +* [{% include product %} 統合](https://www.shotgunsoftware.com/jp/integrations/) * [ユーザ ガイド](https://support.shotgunsoftware.com/hc/ja/articles/115000068574) @@ -47,7 +47,7 @@ lang: ja # プロジェクトの作成とセットアップ -このチュートリアルでは、Shotgun で新しいプロジェクトを作成して、プロダクション開始の準備に合わせて設定する必要があります。ここで、すべての必要な Shotgun エンティティが所定の場所にあり、正しくリンクされていることを確認します。このチュートリアルの場合、アセット、シーケンス、ショット、およびタスクの各エンティティが必要で、既定で新しいプロジェクトで使用できる必要があります。作成する項目は次のとおりです。 +このチュートリアルでは、{% include product %} で新しいプロジェクトを作成して、プロダクション開始の準備に合わせて設定する必要があります。ここで、すべての必要な {% include product %} エンティティが所定の場所にあり、正しくリンクされていることを確認します。このチュートリアルの場合、アセット、シーケンス、ショット、およびタスクの各エンティティが必要で、既定で新しいプロジェクトで使用できる必要があります。作成する項目は次のとおりです。 * 2 つの**アセット**: @@ -61,7 +61,7 @@ lang: ja * パイプラインの手順ごとの**タスク** -次に、Shotgun で設定したプロジェクト エンティティのスクリーンショットを示します。 +次に、{% include product %} で設定したプロジェクト エンティティのスクリーンショットを示します。 {% include figure src="./images/tutorial/image_1.png" caption="ティーポットとテーブル アセット" %} @@ -71,25 +71,25 @@ lang: ja ## ソフトウェア ランチャー -次に、Maya および Nuke を Shotgun Desktop 内で起動できることを確認する必要があります。Desktop で、これらの各パッケージのアイコンをクリックして起動できることを確認します。各パッケージの適切なバージョンが起動していることを確認します。 +次に、Maya および Nuke を {% include product %} Desktop 内で起動できることを確認する必要があります。Desktop で、これらの各パッケージのアイコンをクリックして起動できることを確認します。各パッケージの適切なバージョンが起動していることを確認します。 -Desktop にアプリケーションが表示されない場合、または予期したバージョンが起動しない場合は、ソフトウェア エンティティを使用して Shotgun で起動を手動で設定しなければならない可能性があります。 +Desktop にアプリケーションが表示されない場合、または予期したバージョンが起動しない場合は、ソフトウェア エンティティを使用して {% include product %} で起動を手動で設定しなければならない可能性があります。 {% include figure src="./images/tutorial/image_4.png" caption="Shotgun で定義された規定のソフトウェア エンティティ" %} -ソフトウェア エンティティは、プロダクションで使用する DCC パッケージを操作する場合に使用されます。既定では、標準のインストール場所でこれらのパッケージが検索され、Desktop を使用して起動できるようになります。複数のバージョンがインストールされている場合、または標準以外の場所にインストールされている場合は、Shotgun の対応するソフトウェア エンティティのエントリを更新して、アーティストの起動環境を整理しなければならない可能性があります。 +ソフトウェア エンティティは、プロダクションで使用する DCC パッケージを操作する場合に使用されます。既定では、標準のインストール場所でこれらのパッケージが検索され、Desktop を使用して起動できるようになります。複数のバージョンがインストールされている場合、または標準以外の場所にインストールされている場合は、{% include product %} の対応するソフトウェア エンティティのエントリを更新して、アーティストの起動環境を整理しなければならない可能性があります。 ソフトウェア エンティティおよび適切な設定方法の詳細については、「[統合管理者ガイド](https://support.shotgunsoftware.com/hc/ja/articles/115000067493#Configuring%20software%20launches)」を参照してください。DCC が予期した方法で起動した場合は、次のセクションに進んでください。 # 環境設定 -環境設定(設定)は、プロジェクトに関するアーティスト ワークフローを定義します。このワークフローでは、アーティストが起動している DCC に含める Shotgun 統合、プロジェクトのフォルダ構造の定義方法、およびアーティストがデータを共有するときに作成されるファイルやフォルダの命名規則を指定します。 +環境設定(設定)は、プロジェクトに関するアーティスト ワークフローを定義します。このワークフローでは、アーティストが起動している DCC に含める {% include product %} 統合、プロジェクトのフォルダ構造の定義方法、およびアーティストがデータを共有するときに作成されるファイルやフォルダの命名規則を指定します。 -既定では、すべての新しいプロジェクトは基本的な [Shotgun 統合](https://support.shotgunsoftware.com/hc/ja/articles/115000068574)を使用するように設定されています。この統合は、多数の既製のソフトウェア パッケージを使用してアーティスト間でファイルを共有するための基本的なワークフローを提供します。 次のセクションでは、プロジェクトのパイプライン環境設定(設定)を引き継いで、スタジオに合わせてカスタマイズする方法の概要を示します。 +既定では、すべての新しいプロジェクトは基本的な [{% include product %} 統合](https://support.shotgunsoftware.com/hc/ja/articles/115000068574)を使用するように設定されています。この統合は、多数の既製のソフトウェア パッケージを使用してアーティスト間でファイルを共有するための基本的なワークフローを提供します。 次のセクションでは、プロジェクトのパイプライン環境設定(設定)を引き継いで、スタジオに合わせてカスタマイズする方法の概要を示します。 ## プロジェクトの設定を引き継ぐ -Shotgun Desktop (以下、「Desktop」)を使用して、プロジェクトの設定を引き継ぎます。Desktop 内で右マウス ボタンをクリックするか、または右下のユーザ アイコンをクリックして、ポップアップ メニューを表示します。**[Advanced project setup...]** オプションを選択し、ウィザードに従ってプロジェクトの設定をローカルにインストールします。次の図に、必要な手順を示します。『統合管理者ガイド』の「[パイプラインの設定を引き継ぐ](https://support.shotgunsoftware.com/hc/ja/articles/115000067493#Taking%20over%20a%20Pipeline%20Configuration)」に示されている手順に従うこともできます。 +{% include product %} Desktop (以下、「Desktop」)を使用して、プロジェクトの設定を引き継ぎます。Desktop 内で右マウス ボタンをクリックするか、または右下のユーザ アイコンをクリックして、ポップアップ メニューを表示します。**[Advanced project setup...]** オプションを選択し、ウィザードに従ってプロジェクトの設定をローカルにインストールします。次の図に、必要な手順を示します。『統合管理者ガイド』の「[パイプラインの設定を引き継ぐ](https://support.shotgunsoftware.com/hc/ja/articles/115000067493#Taking%20over%20a%20Pipeline%20Configuration)」に示されている手順に従うこともできます。 {% include figure src="./images/tutorial/image_5.png" caption="Desktop のポップアップ メニューで**[Advanced project setup...]**を選択する" %} @@ -97,7 +97,7 @@ Shotgun Desktop (以下、「Desktop」)を使用して、プロジェクトの {% include figure src="./images/tutorial/wizard_02.png" caption="**[Default configuration]（既定の設定）**を選択する" %} -初めて Shotgun プロジェクトをセットアップする場合は、プロジェクト データのストレージ場所を定義するためのプロンプトも表示されます。それ以外の場合は、既存の格納場所を選択することができます。 +初めて {% include product %} プロジェクトをセットアップする場合は、プロジェクト データのストレージ場所を定義するためのプロンプトも表示されます。それ以外の場合は、既存の格納場所を選択することができます。 {% include figure src="./images/tutorial/wizard_03.png" caption="新しいストレージを作成します。"%} @@ -105,7 +105,7 @@ Shotgun Desktop (以下、「Desktop」)を使用して、プロジェクトの {% include figure src="./images/tutorial/wizard_05.png" caption="使用するオペレーティング システム上でこのストレージにアクセスするパスを設定します。" %} -**[サイト基本設定]（Site Preferences）**の**[ファイル管理]（File Management）**セクションで、Shotgun サイトのストレージを表示および編集できます。これらの設定について詳しくは、[こちら](https://support.shotgunsoftware.com/hc/ja/articles/219030938)を参照してください。 +**[サイト基本設定]（Site Preferences）**の**[ファイル管理]（File Management）**セクションで、{% include product %} サイトのストレージを表示および編集できます。これらの設定について詳しくは、[こちら](https://support.shotgunsoftware.com/hc/ja/articles/219030938)を参照してください。 格納場所が選択されたので、その場所にある新しいプロジェクトのディレクトリ名を選択します。 @@ -121,7 +121,7 @@ Shotgun Desktop (以下、「Desktop」)を使用して、プロジェクトの 上記の画面で**[Run Setup]**をクリックすると、Desktop は設定に必要なすべてのコンポーネントのダウンロードおよびインストールを開始します。このインストール処理には数分かかる場合があります。完了したら、プロジェクト全体の設定のローカル コピーが作成されます。次の手順では、このローカル コピーを変更します。 -Desktop インストールのチュートリアルで指定された設定場所は、Shotgun のプロジェクトの[パイプラインの設定]（Pipeline Configurations）ページに記録されています。 +Desktop インストールのチュートリアルで指定された設定場所は、{% include product %} のプロジェクトの[パイプラインの設定]（Pipeline Configurations）ページに記録されています。 {% include figure src="./images/tutorial/image_10.png" caption="Shotgun のパイプラインの設定エンティティ" %} @@ -157,9 +157,9 @@ Desktop インストールのチュートリアルで指定された設定場所 # パイプラインを作成する -この時点で、パイプラインの作成を開始する準備ができています。Shotgun にプロジェクトが設定されていて、Desktop を介して Maya および Nuke を起動することや、プロジェクトの設定をコントロールすることができます。また、設定の構造の基本を理解していて、アーティスト ワークフローを具体的に作成する作業を開始することができます。 +この時点で、パイプラインの作成を開始する準備ができています。{% include product %} にプロジェクトが設定されていて、Desktop を介して Maya および Nuke を起動することや、プロジェクトの設定をコントロールすることができます。また、設定の構造の基本を理解していて、アーティスト ワークフローを具体的に作成する作業を開始することができます。 -次のセクションでは、パイプラインの各手順について説明します。すぐに使用できる機能を示し、Shotgun 統合のカスタマイズ プロセスを紹介します。これらのセクションが終了するころには、単純な、機能をすべて備えた、エンドツーエンドのプロダクション パイプラインが作成されています。また、アーティストがプロダクション作業で行う必要のある手順についても理解できるでしょう。 +次のセクションでは、パイプラインの各手順について説明します。すぐに使用できる機能を示し、{% include product %} 統合のカスタマイズ プロセスを紹介します。これらのセクションが終了するころには、単純な、機能をすべて備えた、エンドツーエンドのプロダクション パイプラインが作成されています。また、アーティストがプロダクション作業で行う必要のある手順についても理解できるでしょう。 {% include info title="注" content="このチュートリアルのすべてのコードおよび設定は、[**`tk-config-default2`** リポジトリ](https://github.com/shotgunsoftware/tk-config-default2/tree/pipeline_tutorial/)の **`pipeline_tutorial`**ブランチ内にあります。ファイルの保管場所や、コードの追加場所などについてのヒントが必要な場合は、このブランチを参照してください。" %} @@ -167,9 +167,9 @@ Desktop インストールのチュートリアルで指定された設定場所 シンプルなパイプラインの最初の手順はモデリングです。このセクションでは、プロジェクト内でティーポット アセットの最初の繰り返しを作成します。作成した繰り返しは、ディスクのプロジェクトのフォルダ構造内に保存してからパブリッシュします。 -最初に Shotgun Desktop から Maya を起動します。 +最初に {% include product %} Desktop から Maya を起動します。 -Maya が完全にロードされると、[ファイルを開く]（File Open）ダイアログ ボックスが表示されます。このダイアログ ボックスで、プロジェクト内にある既存の Maya ファイルを参照できます。また、Shotgun 統合で認識される新しいファイルを作成することができます。 +Maya が完全にロードされると、[ファイルを開く]（File Open）ダイアログ ボックスが表示されます。このダイアログ ボックスで、プロジェクト内にある既存の Maya ファイルを参照できます。また、{% include product %} 統合で認識される新しいファイルを作成することができます。 [アセット]（Assets）タブを選択して、ティーポットのモデリング タスクにドリル ダウンします。このタスクのアーティスト作業ファイルはまだないため、**[+ New File]**ボタンをクリックします。 @@ -183,7 +183,7 @@ Maya が完全にロードされると、[ファイルを開く]（File Open） {% include figure src="./images/tutorial/image_14.png" %} -ティーポット モデルに問題がなければ、**[Shotgun] > [File Save...]**メニュー アクションを選択します。 このダイアログ ボックスで、ファイルを指定した名前、バージョン、タイプで保存するように求められます。 +ティーポット モデルに問題がなければ、**[{% include product %}] > [File Save...]**メニュー アクションを選択します。 このダイアログ ボックスで、ファイルを指定した名前、バージョン、タイプで保存するように求められます。 {% include figure src="./images/tutorial/image_15.png" %} @@ -201,19 +201,19 @@ Maya が完全にロードされると、[ファイルを開く]（File Open） **[Save]**ボタンをクリックして、ティーポット モデルを保存します。 -この時点において重要なのは、アーティストがワークフローを開く手順、および保存する手順は、パイプラインのどの段階においても、ここで完了したのと同じ手順になることです。[File Open]および[File Save]ダイアログ ボックスは、Workfiles アプリに含まれています。この「マルチ」アプリは、Shotgun 統合でサポートされているすべての DCC で実行され、すべてのアーティストに一貫性のあるワークフローを提供します。 +この時点において重要なのは、アーティストがワークフローを開く手順、および保存する手順は、パイプラインのどの段階においても、ここで完了したのと同じ手順になることです。[File Open]および[File Save]ダイアログ ボックスは、Workfiles アプリに含まれています。この「マルチ」アプリは、{% include product %} 統合でサポートされているすべての DCC で実行され、すべてのアーティストに一貫性のあるワークフローを提供します。 次の手順では、ティーポットにいくつかの変更を行います。ふたのジオメトリはモデルの残りの部分から独立しているため、後でリギングすることができます。 {% include figure src="./images/tutorial/image_16.png" %} -作業内容に問題がなければ、**[Shotgun] > [File Save...]**メニュー アクションをもう一度実行します。今度は、ダイアログ ボックスのバージョン番号が既定の 2 になります。ファイルのバージョンは自動的に増分するため、アーティストは完了した作業の完全な履歴を維持することができます。[Save]ボタンをクリックします。 +作業内容に問題がなければ、**[{% include product %}] > [File Save...]**メニュー アクションをもう一度実行します。今度は、ダイアログ ボックスのバージョン番号が既定の 2 になります。ファイルのバージョンは自動的に増分するため、アーティストは完了した作業の完全な履歴を維持することができます。[Save]ボタンをクリックします。 {% include figure src="./images/tutorial/image_17.png" %} ティーポット モデルをバージョン 2 に保存したら、チュートリアルのこのセクションの最後の手順に進むことができます。 -ティーポット モデルの準備ができたので、モデルをパブリッシュして、サーフェスの作成やリギングを実行できるようにする必要があります。パブリッシュするには、**[Shotgun] > [Publish...]**メニュー アクションをクリックします。[Publish App]ダイアログ ボックスが表示されます。 +ティーポット モデルの準備ができたので、モデルをパブリッシュして、サーフェスの作成やリギングを実行できるようにする必要があります。パブリッシュするには、**[{% include product %}] > [Publish...]**メニュー アクションをクリックします。[Publish App]ダイアログ ボックスが表示されます。 {% include figure src="./images/tutorial/image_18.png" %} @@ -225,7 +225,7 @@ Maya が完全にロードされると、[ファイルを開く]（File Open） ツリーの左側の項目をクリックして、Publish アプリを調べます。操作を行う項目を選択すると、パブリッシュする内容の説明を入力できます。また、右側のカメラ アイコンをクリックして、項目に関連付けられるスクリーンショットを作成することもできます。 -準備ができたら、右下の**[Publish]**ボタンをクリックして、現在の作業ファイルおよびティーポット ジオメトリをパブリッシュします。完了したら、Shotgun でティーポット アセットを参照し、パブリッシュが正常に完了したことを確認できます。 +準備ができたら、右下の**[Publish]**ボタンをクリックして、現在の作業ファイルおよびティーポット ジオメトリをパブリッシュします。完了したら、{% include product %} でティーポット アセットを参照し、パブリッシュが正常に完了したことを確認できます。 {% include figure src="./images/tutorial/image_19.png" %} @@ -259,15 +259,15 @@ Maya が完全にロードされると、[ファイルを開く]（File Open） このセクションでは、モデリング セクションで学習した内容を基に作成します。Loader アプリを使用して、前のセクションで作成したティーポット モデルをロードする方法について学習します。また、ティーポットのシェーダをパブリッシュするために Publish アプリをカスタマイズする方法についても学習します。 -Desktop から Maya を起動して開始します。前のセクションの作業を行った後も Maya が開いている場合は、再起動する必要はありません。Maya が開いたら、**[Shotgun] > [File Open...]**を使用して作業ファイル アプリを開きます。モデリング セクションと同様に、[Assets]タブを使用してティーポット アセットのタスクにドリル ダウンします。今回は、サーフェス作成タスクを選択して、**[+ New File]**をクリックします。 +Desktop から Maya を起動して開始します。前のセクションの作業を行った後も Maya が開いている場合は、再起動する必要はありません。Maya が開いたら、**[{% include product %}] > [File Open...]**を使用して作業ファイル アプリを開きます。モデリング セクションと同様に、[Assets]タブを使用してティーポット アセットのタスクにドリル ダウンします。今回は、サーフェス作成タスクを選択して、**[+ New File]**をクリックします。 {% include figure src="./images/tutorial/image_21.png" width="450px" %} -ティーポットのサーフェス作成タスクの作業が開始しました。右側のプロダクション コンテキスト内で作業していることを確認する最も簡単な方法は、Shotgun メニューの最初のエントリを調べることです。 +ティーポットのサーフェス作成タスクの作業が開始しました。右側のプロダクション コンテキスト内で作業していることを確認する最も簡単な方法は、{% include product %} メニューの最初のエントリを調べることです。 {% include figure src="./images/tutorial/image_22.png" %} -次に、ティーポット モデルを新しいサーフェス作成作業ファイルにロードする必要があります。このためには、Maya の **[Shotgun] > [ロード…]（Load…）**メニュー項目を使用して、Loader アプリを起動します。 +次に、ティーポット モデルを新しいサーフェス作成作業ファイルにロードする必要があります。このためには、Maya の **[{% include product %}] > [ロード…]（Load…）**メニュー項目を使用して、Loader アプリを起動します。 {% include figure src="./images/tutorial/image_23.png" %} @@ -283,7 +283,7 @@ Loader アプリのレイアウトは作業ファイル アプリと似ていま パイプライン作成時のシェーダ管理は時間がかかり、複雑な作業になる場合があります。これは通常、スタジオに対して非常に固有な作業になります。付属の Maya 統合で、すぐに使用できるシェーダまたはテクスチャ管理が処理されないのは、このためです。 -**[Shotgun] > [File Save...]**メニュー アクションを使用して、現在のセッションを保存してから続行します。 +**[{% include product %}] > [File Save...]**メニュー アクションを使用して、現在のセッションを保存してから続行します。 ### カスタム シェーダ パブリッシュ @@ -445,9 +445,9 @@ Loader アプリのレイアウトは作業ファイル アプリと似ていま {% include info title="注" content="設定のカスタマイズ中に Maya を終了しても、問題はありません。Maya を単に再起動し、[File Open]ダイアログ ボックスを使用してサーフェス作成作業ファイルを開くことができます。次の再ロード ステップはスキップできます。" %} -##### Shotgun 統合を再ロードする +##### {% include product %} 統合を再ロードする -カスタマイズを試すには、Maya セッション内で統合を再ロードする必要があります。このためには、**[Shotgun] > [[タスク名]] > [Work Area Info...]**メニュー アクションをクリックします。 +カスタマイズを試すには、Maya セッション内で統合を再ロードする必要があります。このためには、**[{% include product %}] > [[タスク名]] > [Work Area Info...]**メニュー アクションをクリックします。 {% include figure src="./images/tutorial/image_30.png" %} @@ -457,14 +457,14 @@ Loader アプリのレイアウトは作業ファイル アプリと似ていま ### シェーダ ネットワークをパブリッシュする -これで、プロジェクトの設定を変更した場合の結果を確認できるようになりました。Shotgun メニューから Publish アプリを起動します。**Publish Shaders** プラグインがアタッチされている、収集されたティーポット メッシュ項目が表示されます。 +これで、プロジェクトの設定を変更した場合の結果を確認できるようになりました。{% include product %} メニューから Publish アプリを起動します。**Publish Shaders** プラグインがアタッチされている、収集されたティーポット メッシュ項目が表示されます。 {% include figure src="./images/tutorial/image_32.png" %} -作業の説明を入力し、サーフェス ティーポットのサムネイルを取り込んで、パブリッシュされたファイルに関連付けます。最後に、パブリッシュをクリックして、ティーポット シェーダをディスクに書き出して、このファイルをパブリッシュとして Shotgun に登録します。完了すると、セッションのパブリッシュ プラグインによって、作業ファイルが次に使用可能なバージョンに自動的に保存されます。これが、Shotgun 統合でサポートされているすべての DCC の既定の動作です。 +作業の説明を入力し、サーフェス ティーポットのサムネイルを取り込んで、パブリッシュされたファイルに関連付けます。最後に、パブリッシュをクリックして、ティーポット シェーダをディスクに書き出して、このファイルをパブリッシュとして {% include product %} に登録します。完了すると、セッションのパブリッシュ プラグインによって、作業ファイルが次に使用可能なバージョンに自動的に保存されます。これが、{% include product %} 統合でサポートされているすべての DCC の既定の動作です。 -これで、Shotgun 内のティーポット アセットを参照して、すべてが予測どおりに機能したことを確認できるようになりました。 +これで、{% include product %} 内のティーポット アセットを参照して、すべてが予測どおりに機能したことを確認できるようになりました。 {% include figure src="./images/tutorial/image_33.png" %} @@ -476,9 +476,9 @@ Loader アプリのレイアウトは作業ファイル アプリと似ていま ## リギング ワークフロー -現在、Shotgun に付属している Workfile アプリおよび Publish アプリを使用すると、作業ファイルを開く(または作成する)、保存する、パブリッシュする操作を極めて快適に行うことができます。また、上流工程からパブリッシュをロードする Loader アプリを使用する機会もありました。学習した内容を使用して、次のタスクを完了します。 +現在、{% include product %} に付属している Workfile アプリおよび Publish アプリを使用すると、作業ファイルを開く(または作成する)、保存する、パブリッシュする操作を極めて快適に行うことができます。また、上流工程からパブリッシュをロードする Loader アプリを使用する機会もありました。学習した内容を使用して、次のタスクを完了します。 -* Shotgun Desktop から Maya を起動する +* {% include product %} Desktop から Maya を起動する * ティーポット アセットのリギング ステップで、新しい作業ファイルを作成する @@ -488,7 +488,7 @@ Loader アプリのレイアウトは作業ファイル アプリと似ていま * ティーポットのふたを保存してパブリッシュする -最終的には、Shotgun で次のようになります。 +最終的には、{% include product %} で次のようになります。 {% include figure src="./images/tutorial/image_35.png" %} @@ -496,7 +496,7 @@ Loader アプリのレイアウトは作業ファイル アプリと似ていま {% include figure src="./images/tutorial/image_36.png" %} -ティーポットのリギング ステップで、作業ファイルを再び開きます(**[Shotgun] > [File Open…]**を使用)。**[Shotgun] > [Scene Breakdown…]**メニュー アクションを起動します。この操作を行うと、Breakdown アプリが起動し、作業ファイル内で参照した上流工程のパブリッシュがすべて表示されます。この場合は、上流工程のティーポット モデルのみがあります。次のように表示されます。 +ティーポットのリギング ステップで、作業ファイルを再び開きます(**[{% include product %}] > [File Open…]**を使用)。**[{% include product %}] > [Scene Breakdown…]**メニュー アクションを起動します。この操作を行うと、Breakdown アプリが起動し、作業ファイル内で参照した上流工程のパブリッシュがすべて表示されます。この場合は、上流工程のティーポット モデルのみがあります。次のように表示されます。 {% include figure src="./images/tutorial/image_37.png" width="400px" %} @@ -518,7 +518,7 @@ Maya 参照がティーポット Alembic キャッシュの最新の繰り返し まず、以前のセクションで学習した内容に基づいて、次のタスクを完了します。 -* Shotgun Desktop から Maya を起動する +* {% include product %} Desktop から Maya を起動する * ショットのレイアウト ステップで新しい作業ファイルを作成する(ヒント: ローダー内の[Shots]タブを使用する) @@ -530,7 +530,7 @@ Maya 参照がティーポット Alembic キャッシュの最新の繰り返し {% include figure src="./images/tutorial/image_41.gif" %} -ショットのレイアウトに問題がなければ、**[Shotgun] > [File Save...]**メニュー アクションを使用してファイルを保存します。先に進んで、この時点でパブリッシュする場合は、Maya セッション全体のみがパブリッシュ可能な項目として表示されます。 +ショットのレイアウトに問題がなければ、**[{% include product %}] > [File Save...]**メニュー アクションを使用してファイルを保存します。先に進んで、この時点でパブリッシュする場合は、Maya セッション全体のみがパブリッシュ可能な項目として表示されます。 簡単なカスタマイズを追加する場合、およびパイプラインの柔軟性を高めるためにカスタマイズする場合は、他のパッケージに簡単に読み込むことができるファイル形式にスタンドアロン カメラをパブリッシュします。これにより、カメラを一度作成すれば(通常はレイアウト内)、アニメーション、ライト、および合成など、他のすべてのパイプラインの手順でこのカメラを直接使用できるようになります。 @@ -628,11 +628,11 @@ Maya 参照がティーポット Alembic キャッシュの最新の繰り返し {% include figure src="./images/tutorial/image_45.png" %} -図に示されているように、新しいカメラ項目が収集されて、パブリッシュ プラグインがアタッチされます。先に進んで、**[Publish]**をクリックしてディスクにカメラを書き込み、Shotgun に登録します。 +図に示されているように、新しいカメラ項目が収集されて、パブリッシュ プラグインがアタッチされます。先に進んで、**[Publish]**をクリックしてディスクにカメラを書き込み、{% include product %} に登録します。 {% include info title="注" content="Alembic 書き出しと同様、カメラのパブリッシュ プラグインには FBX 書き出しプラグインをロードする必要があります。カメラのパブリッシュ プラグイン項目が表示されない場合は、FBX プラグインがロードされていることを確認し、パブリッシャを再起動してください。"%} -Shotgun では次のように表示されます。 +{% include product %} では次のように表示されます。 {% include figure src="./images/tutorial/image_46.png" %} @@ -644,7 +644,7 @@ Shotgun では次のように表示されます。 以前のセクションで学習した内容に基づいて、次の作業を完了します。 -* Shotgun Desktop から Maya を起動する +* {% include product %} Desktop から Maya を起動する * ショットのアニメーション ステップで新しい作業ファイルを作成する @@ -662,7 +662,7 @@ Maya のアプリが設定されているセクションを見つけて、**`act **`FBX Camera: [reference, import]`** -カスタム カメラ パブリッシュ プラグインでは、カメラをディスクに書き込む際に Maya の **`FBXExport`** mel コマンドを使用しました。Shotgun にファイルを登録する際に使用したパブリッシュ タイプは **`FBX Camera`** でした。設定に追加された行は、ローダーに対して、タイプ **`FBX Camera`** の任意のパブリッシュの **`reference`** および **`import`** アクションを表示するように指示します。これらのアクションは、Loader アプリの [tk-maya-actions.py](https://github.com/shotgunsoftware/tk-multi-loader2/blob/master/hooks/tk-maya_actions.py) フックで定義されています。 これらのアクションは、Maya が参照できる、または読み込むことができる任意のファイル タイプを処理するように実装されています。カスタム プラグインによって生成された **`.fbx`** ファイルはこのカテゴリに分類されるため、これが、パブリッシュされたカメラをロードできるようにするために必要な唯一の変更になります。 +カスタム カメラ パブリッシュ プラグインでは、カメラをディスクに書き込む際に Maya の **`FBXExport`** mel コマンドを使用しました。{% include product %} にファイルを登録する際に使用したパブリッシュ タイプは **`FBX Camera`** でした。設定に追加された行は、ローダーに対して、タイプ **`FBX Camera`** の任意のパブリッシュの **`reference`** および **`import`** アクションを表示するように指示します。これらのアクションは、Loader アプリの [tk-maya-actions.py](https://github.com/shotgunsoftware/tk-multi-loader2/blob/master/hooks/tk-maya_actions.py) フックで定義されています。 これらのアクションは、Maya が参照できる、または読み込むことができる任意のファイル タイプを処理するように実装されています。カスタム プラグインによって生成された **`.fbx`** ファイルはこのカテゴリに分類されるため、これが、パブリッシュされたカメラをロードできるようにするために必要な唯一の変更になります。 アプリの設定は次のようになります。 @@ -688,7 +688,7 @@ Maya のアプリが設定されているセクションを見つけて、**`act 最初に、以前のセクションで学習した内容に基づいて、次の作業を完了します。 -* Shotgun Desktop から Maya を起動する +* {% include product %} Desktop から Maya を起動する * ショットの照明ステップで新しい作業ファイルを作成する @@ -783,11 +783,11 @@ Maya のアプリが設定されているセクションを見つけて、**`act {% include info title="注" content="ご覧のとおり、ティーポットとテーブル アセットのサーフェスには共に問題があります。このチュートリアルでは、これらが意図的かつ芸術的な選択肢であると想定します。これらの問題を解決する場合は、これらのアセットのサーフェス作成作業ファイルをロードして、シェーダを調整し、再びパブリッシュしてください。この操作を行う場合は、照明作業ファイル内の参照を忘れずに更新して、再度レンダリングしてください。これらの手順を実行する場合は、参照を再ロードした後に、詳細情報アプリが更新済みのシェーダを再接続しないことがあります。シェーダの参照をフックするようにローダーを変更した経験に基づいて、ユーザは詳細情報アプリのシーン操作フックを更新し、必要なロジックを追加できるようになっています。ヒント: [このファイル](https://github.com/shotgunsoftware/tk-multi-breakdown/blob/master/hooks/tk-maya_scene_operations.py#L69)内の update メソッドを参照してください。" %} -付属の Shotgun 統合は、ファイル内で定義されたレンダリング レイヤを調べて、イメージ シーケンスを収集します。レンダリングが完了したら、パブリッシャーを起動します。レンダリングされたシーケンスがツリー内の項目として表示されます。 +付属の {% include product %} 統合は、ファイル内で定義されたレンダリング レイヤを調べて、イメージ シーケンスを収集します。レンダリングが完了したら、パブリッシャーを起動します。レンダリングされたシーケンスがツリー内の項目として表示されます。 {% include figure src="./images/tutorial/image_55.png" %} -先に進んで、セッションおよびレンダリングされたイメージ ファイル シーケンスをパブリッシュします。Shotgun では次のように表示されます。 +先に進んで、セッションおよびレンダリングされたイメージ ファイル シーケンスをパブリッシュします。{% include product %} では次のように表示されます。 {% include figure src="./images/tutorial/image_56.png" %} @@ -795,13 +795,13 @@ Maya のアプリが設定されているセクションを見つけて、**`act ## コンポジット ワークフロー -チュートリアルのこの最終セクションでは、Nuke が提供する既定の統合をいくつか紹介します。以前のセクションで参照したアプリの他に、Shotgun 対応書き込みノードや、レビューのためにレンダーを他のユーザにすばやく送信するためのアプリについて学習します。 +チュートリアルのこの最終セクションでは、Nuke が提供する既定の統合をいくつか紹介します。以前のセクションで参照したアプリの他に、{% include product %} 対応書き込みノードや、レビューのためにレンダーを他のユーザにすばやく送信するためのアプリについて学習します。 最初に、次に示す手順を行って作業ファイルを準備します。 -* Shotgun Desktop から Nuke を起動する +* {% include product %} Desktop から Nuke を起動する -* Maya と同様に、[Shotgun] > [File Open]メニュー アクションを使用して、ショットのコンポジット ステップ内で新しい作業ファイルを作成します。 +* Maya と同様に、[{% include product %}] > [File Open]メニュー アクションを使用して、ショットのコンポジット ステップ内で新しい作業ファイルを作成します。 Loader アプリを使用して前のセクションでレンダリングおよびパブリッシュしたイメージ シーケンスをロードします。 @@ -814,40 +814,40 @@ Nuke プロジェクト設定の出力フォーマットが、レンダリング {% include figure src="./images/tutorial/image_58.png" %} -コンポジットに問題がなければ、**[Shotgun] > [File Save…]**メニュー アクションを使用して、作業ファイルを保存します。 +コンポジットに問題がなければ、**[{% include product %}] > [File Save…]**メニュー アクションを使用して、作業ファイルを保存します。 -次に、Nuke の左側メニューで Shotgun のロゴをクリックします。このメニューの Shotgun 対応書き込みノードの 1 つをクリックします。 +次に、Nuke の左側メニューで {% include product %} のロゴをクリックします。このメニューの {% include product %} 対応書き込みノードの 1 つをクリックします。 {% include figure src="./images/tutorial/image_59.png" width="400px" %} -Shotgun Write Node アプリは、現在の Shotgun のコンテキストに基づいて出力パスを自動的に評価する組み込みの Nuke 書き込みノードの上に、レイヤを配置します。 +{% include product %} Write Node アプリは、現在の {% include product %} のコンテキストに基づいて出力パスを自動的に評価する組み込みの Nuke 書き込みノードの上に、レイヤを配置します。 {% include figure src="./images/tutorial/image_60.png" %} -ディスクにイメージ フレームをレンダリングします。Nuke セッションをパブリッシュして、レンダリングされたイメージに作業ファイルを関連付けられるようになりました。既定では、パブリッシャーはレンダリングされたフレームを収集し、Shotgun にフレームを登録するプラグインをアタッチします。2 番目のプラグインは、レビュー提出と呼ばれる、バックグラウンドで実行される統合方法を使用して、フレームをアップロードします。このアプリは Nuke を使用して QuickTime を生成します。生成された QuickTime は、アップロードしたり、レビューしたりできます。 +ディスクにイメージ フレームをレンダリングします。Nuke セッションをパブリッシュして、レンダリングされたイメージに作業ファイルを関連付けられるようになりました。既定では、パブリッシャーはレンダリングされたフレームを収集し、{% include product %} にフレームを登録するプラグインをアタッチします。2 番目のプラグインは、レビュー提出と呼ばれる、バックグラウンドで実行される統合方法を使用して、フレームをアップロードします。このアプリは Nuke を使用して QuickTime を生成します。生成された QuickTime は、アップロードしたり、レビューしたりできます。 {% include figure src="./images/tutorial/image_61.png" %} -もう 1 つの便利な統合は、Quick Review アプリです。これは、QuickTime をすばやく生成して、レビューのために Shotgun にアップロードする出力ノードです。このアプリは、左側メニュー内の、Shotgun 書き込みノードの横にあります。 +もう 1 つの便利な統合は、Quick Review アプリです。これは、QuickTime をすばやく生成して、レビューのために {% include product %} にアップロードする出力ノードです。このアプリは、左側メニュー内の、{% include product %} 書き込みノードの横にあります。 {% include figure src="./images/tutorial/image_62.png" width="400px" %} -Quick Review ノードを作成してから、[Upload]ボタンをクリックして、ディスクへの入力のレンダリング、QuickTime の生成、レビューのための Shotgun への結果のアップロードを行います。フレームを提出する前に、いくつかの標準オプションが表示されます。 +Quick Review ノードを作成してから、[Upload]ボタンをクリックして、ディスクへの入力のレンダリング、QuickTime の生成、レビューのための {% include product %} への結果のアップロードを行います。フレームを提出する前に、いくつかの標準オプションが表示されます。 {% include figure src="./images/tutorial/image_63.png" %} -Shotgun の[メディア]（Media）タブを調べて、アップロードされた QuickTime を両方とも確認します。 +{% include product %} の[メディア]（Media）タブを調べて、アップロードされた QuickTime を両方とも確認します。 {% include figure src="./images/tutorial/image_64.png" %} -Shotgun でメディアをレビューする方法の詳細については、[公式のドキュメント](https://support.shotgunsoftware.com/hc/ja/sections/204245448-Review-and-approval)を参照してください。 +{% include product %} でメディアをレビューする方法の詳細については、[公式のドキュメント](https://support.shotgunsoftware.com/hc/ja/sections/204245448-Review-and-approval)を参照してください。 # 結論 -おめでとうございます。これで完了です。このチュートリアルが、Shotgun 統合を使用して独自のカスタム パイプラインを作成する際の第一歩になるはずです。スタジオ固有のニーズに合わせて既存の Shotgun アプリを拡張する方法について理解できたことでしょう。 +おめでとうございます。これで完了です。このチュートリアルが、{% include product %} 統合を使用して独自のカスタム パイプラインを作成する際の第一歩になるはずです。スタジオ固有のニーズに合わせて既存の {% include product %} アプリを拡張する方法について理解できたことでしょう。 Toolkit に関する質問がある場合や、他のスタジオで Toolkit がどのように使用されているかを知りたい場合は、[shotgun-dev Google Group](https://groups.google.com/a/shotgunsoftware.com/forum/#!forum/shotgun-dev) にアクセスしてください。常に最新の投稿を読むことができるよう、サブスクライプすることをお勧めします。 機能やワークフローを既定の統合で実現できないと感じた場合は、独自のアプリをいつでも作成できます。初めてアプリを作成する場合は、[こちら](https://support.shotgunsoftware.com/hc/ja/articles/219033158)を参照してください。 -このチュートリアルの詳細または Shotgun や Toolkit プラットフォームの概要に関して質問がある場合は、[チケットを送信](https://support.shotgunsoftware.com/hc/ja/requests/new)してください。 +このチュートリアルの詳細または {% include product %} や Toolkit プラットフォームの概要に関して質問がある場合は、[チケットを送信](https://support.shotgunsoftware.com/hc/ja/requests/new)してください。 diff --git a/docs/ja/guides/review/integrations.md b/docs/ja/guides/review/integrations.md index ce2453aef..a0790228c 100644 --- a/docs/ja/guides/review/integrations.md +++ b/docs/ja/guides/review/integrations.md @@ -7,6 +7,6 @@ lang: ja # RV の統合 -Shotgun Integration、Screening Room for RV、Shotgun Review など、機能セットに違いがあるいくつかの Shotgun 統合に加え、RV には Nuke および Maya 向けの統合ツールが付属しています。 +{% include product %} Integration、Screening Room for RV、{% include product %} Review など、機能セットに違いがあるいくつかの {% include product %} 統合に加え、RV には Nuke および Maya 向けの統合ツールが付属しています。 -以下の最初の 2 つのドキュメントでは、Nuke と Maya の統合のインストールとワークフローについて説明し、最後の 2 つのドキュメントではさまざまな Shotgun の統合について説明します。どちらを使用するかについてはこれらのドキュメントを参照してください。 +以下の最初の 2 つのドキュメントでは、Nuke と Maya の統合のインストールとワークフローについて説明し、最後の 2 つのドキュメントではさまざまな {% include product %} の統合について説明します。どちらを使用するかについてはこれらのドキュメントを参照してください。 diff --git a/docs/ja/guides/webhooks.md b/docs/ja/guides/webhooks.md index 47c646049..463fbe796 100644 --- a/docs/ja/guides/webhooks.md +++ b/docs/ja/guides/webhooks.md @@ -9,7 +9,7 @@ lang: ja {% include info title="ベータ" content="Web フックは現在ベータ版です。ベータ版への参加をご希望の場合は、次のメール アドレスにお問い合わせください: [webhooks-beta@shotgunsoftware.com](mailto:webhooks-beta@shotgunsoftware.com)" %} -Web フックを使用すると、ユーザがコントロールしているサービスに Shotgun で発生したイベントを通知することができます。Web フックを作成する場合は、対象となるイベントのタイプを指定し、このイベントがトリガされたときにデータを送信する URL を Shotgun に指示します。Shotgun で関連イベントが発生すると、そのイベントを示すデータのペイロードが Web フックの URL に送信されます。これにより、Shotgun との統合が緊密化され、ワークフローの一部を自動化することができます。 +Web フックを使用すると、ユーザがコントロールしているサービスに {% include product %} で発生したイベントを通知することができます。Web フックを作成する場合は、対象となるイベントのタイプを指定し、このイベントがトリガされたときにデータを送信する URL を {% include product %} に指示します。{% include product %} で関連イベントが発生すると、そのイベントを示すデータのペイロードが Web フックの URL に送信されます。これにより、{% include product %} との統合が緊密化され、ワークフローの一部を自動化することができます。 ## Web フックを使用する例 @@ -17,7 +17,7 @@ Web フックには多くの使用事例があります。このドキュメン ### エンティティを作成するときにディスク上にディレクトリ構造を作成する -Shotgun で新しいエンティティを作成するときに何度も繰り返されてきたワークフローの 1 つとして、ディスク上にディレクトリ構造を作成することが挙げられます。Shotgun で新しいショットを作成したら、先へ進んで、アーティストの作業準備が整っていることを自動的に確認できると便利です。 +{% include product %} で新しいエンティティを作成するときに何度も繰り返されてきたワークフローの 1 つとして、ディスク上にディレクトリ構造を作成することが挙げられます。{% include product %} で新しいショットを作成したら、先へ進んで、アーティストの作業準備が整っていることを自動的に確認できると便利です。 ### ステータス管理の自動化 @@ -25,9 +25,9 @@ Shotgun で新しいエンティティを作成するときに何度も繰り返 ステータス管理の自動化が役立つもう 1 つの例は、新しいノートを作成するときに、タスクのステータス変更をトリガすることです。この方法は、アーティスト チームとプロダクション チームに、レビュー セッション後にスーパーバイザーから現在の作品を変更または修正するよう要求されたことを知らせる場合に便利です。 -## Shotgun のイベント デーモンではなく、Web フックを使用する場合 +## {% include product %} のイベント デーモンではなく、Web フックを使用する場合 -Web フックおよび [Shotgun のイベント デーモン](https://github.com/shotgunsoftware/shotgunEvents/wiki)の機能は似ていますが、重要な違いがいくつかあります。イベント デーモンは、ユーザ独自のサービスを実行、監視、メンテナンスする必要があります。すべてのコードを Python で記述する必要があり、これによって Shotgun との独自の接続を開始することが可能となります。対照的に、Web フックは複数の接続に対応し、任意のプログラム言語で記述することができます。Web フックは、[AWS Lambda](https://aws.amazon.com/lambda/) などのサーバレス環境にホストしたり、[Zapier](https://zapier.com) や [IFTTT](https://ifttt.com) など、オンラインで使用可能な任意の自動化プラットフォームをトリガしたりできます。Web フックを使用できるのであれば、Web フックがお勧めのソリューションです。 +Web フックおよび [{% include product %} のイベント デーモン](https://github.com/shotgunsoftware/shotgunEvents/wiki)の機能は似ていますが、重要な違いがいくつかあります。イベント デーモンは、ユーザ独自のサービスを実行、監視、メンテナンスする必要があります。すべてのコードを Python で記述する必要があり、これによって {% include product %} との独自の接続を開始することが可能となります。対照的に、Web フックは複数の接続に対応し、任意のプログラム言語で記述することができます。Web フックは、[AWS Lambda](https://aws.amazon.com/lambda/) などのサーバレス環境にホストしたり、[Zapier](https://zapier.com) や [IFTTT](https://ifttt.com) など、オンラインで使用可能な任意の自動化プラットフォームをトリガしたりできます。Web フックを使用できるのであれば、Web フックがお勧めのソリューションです。 ## Web フックを作成する @@ -66,7 +66,7 @@ True ### SSL 証明書を検証する -SSL 証明書の検証機能はオプションです。Web フックの使用者 URL に対する接続のセキュリティを確保する際に役立ちます。この機能を有効にすると、Web フックの URL に配信された場合、Shotgun は OpenSSL の証明書検証ルーチンを使用して証明書を検証します。 +SSL 証明書の検証機能はオプションです。Web フックの使用者 URL に対する接続のセキュリティを確保する際に役立ちます。この機能を有効にすると、Web フックの URL に配信された場合、{% include product %} は OpenSSL の証明書検証ルーチンを使用して証明書を検証します。 ## Web フックのステータス @@ -77,7 +77,7 @@ Web フックはさまざまなステータスを取ることができます(健 | ステータス | 例 | 説明 | |--------|:-------:|:-----------:| | アクティブ | ![アクティブ](./images/webhooks/webhook_status_active.png) | Web フックの動作は安定しています。過去 24 時間以内に、この Web フックに対する配信が宛先に到達しなかったことはありません。 | -| 不安定 | ![不安定](./images/webhooks/webhook_status_unstable.png) | Web フックの動作は不安定です。過去 24 時間以内に、一部の配信が宛先に到達しませんでしたが、Web フックが停止していると Shotgun が判断するには不十分です。 | +| 不安定 | ![不安定](./images/webhooks/webhook_status_unstable.png) | Web フックの動作は不安定です。過去 24 時間以内に、一部の配信が宛先に到達しませんでしたが、Web フックが停止していると {% include product %} が判断するには不十分です。 | | 失敗 | ![失敗](./images/webhooks/webhook_status_failed.png) | Web フックは停止していると判断されていて、配信はこれ以上試行されません。この原因は、短期間に発生した配信失敗の数が多すぎたことです。システムは、Web フックが使用できなくなったと判断しました。**過去 24 時間以内に配信が 10 回失敗すると、Web フックに障害があると見なされます**。 | | 無効 | ![無効](./images/webhooks/webhook_status_disabled.png) | Web フックは無効な状態です。再度有効になるまで、配信はこれ以上試行されません。 | @@ -101,7 +101,7 @@ Web フック リスト内の Web フックを選択すると、この Web フ #### ペイロード -Web フックの URL に送信されるペイロードには、Shotgun で発生したイベントと、それをトリガしたユーザを示す情報が格納されています。この情報は、JSON 形式で提供されます。 +Web フックの URL に送信されるペイロードには、{% include product %} で発生したイベントと、それをトリガしたユーザを示す情報が格納されています。この情報は、JSON 形式で提供されます。 {% include warning title="ペイロード サイズ" content="配信のペイロードの最大サイズは 1 MB です。Shotgun でトリガされたイベントのうち、ペイロード サイズが 1 MB を超えるものは、`new_value` および `old_value` キーが削除され、発生したイベントの内容と、Shotgun からイベント ログ エントリ全体を取得する理由および方法を示すメッセージが含まれている `warning` キーが追加されます。" %} @@ -144,11 +144,11 @@ Web フックの URL に送信されるペイロードには、Shotgun で発生 ##### セッション UUID -Shotgun でイベントをトリガした `session_uuid` が、イベント ペイロードの一部として提供されます。この値を [Shotgun の Python API](https://developer.shotgunsoftware.com/python-api/reference.html?highlight=session_uuid#shotgun_api3.shotgun.Shotgun.set_session_uuid) に提供して、この session_uuid を持つ、開いている任意のブラウザ セッションに、この API によって生成されたイベントの最新情報を表示することができます。 +{% include product %} でイベントをトリガした `session_uuid` が、イベント ペイロードの一部として提供されます。この値を [{% include product %} の Python API](https://developer.shotgunsoftware.com/python-api/reference.html?highlight=session_uuid#shotgun_api3.shotgun.Shotgun.set_session_uuid) に提供して、この session_uuid を持つ、開いている任意のブラウザ セッションに、この API によって生成されたイベントの最新情報を表示することができます。 ### 確認応答 -配信を更新して確認応答を含めることができます。配信時に、要求の一部としてヘッダが提供されます。これらのヘッダには、`x-sg-delivery-id` キーに格納されている配信レコードの ID が含まれます。この ID を使用すると、[Shotgun REST API](https://developer.shotgunsoftware.com/rest-api) で配信レコードを更新し、確認応答を含めることができます。 +配信を更新して確認応答を含めることができます。配信時に、要求の一部としてヘッダが提供されます。これらのヘッダには、`x-sg-delivery-id` キーに格納されている配信レコードの ID が含まれます。この ID を使用すると、[{% include product %} REST API](https://developer.shotgunsoftware.com/rest-api) で配信レコードを更新し、確認応答を含めることができます。 {% include warning title="確認応答のサイズ" content="確認応答に割り当てられた最大サイズは 4 KB です。" %} @@ -169,7 +169,7 @@ Shotgun でイベントをトリガした `session_uuid` が、イベント ペ #### 確認応答の用途 -確認応答を使用すると、成功または失敗を示す詳細レポートを帯域外で送信し、Web フックの URL で正常に受信された配信を処理することができます。これにより、Shotgun からの配信に関する受信ステータスを成功または失敗から切り離し、この配信に関連付けられているイベントを処理できるようになります。このようにして、正常に配信されたイベントにデバッグに役立つ追加情報を含めることができます。この方法は、アセット作成時にトリガされる Web フックに使用すると便利です。新しいアセットごとにディスク上にディレクトリ構造を 1 つ作成する作業を Web フックで行う場合、Web フックの URL は配信を正常に受信できますが、ディスクまたはネットワークが停止しているため、関連ディレクトリを作成することはできません。配信を受信した後、Web フックは、ディレクトリ構造が作成されなかったことおよびその理由を示す詳細なエラー メッセージを使用して、配信記録を更新することができます。 +確認応答を使用すると、成功または失敗を示す詳細レポートを帯域外で送信し、Web フックの URL で正常に受信された配信を処理することができます。これにより、{% include product %} からの配信に関する受信ステータスを成功または失敗から切り離し、この配信に関連付けられているイベントを処理できるようになります。このようにして、正常に配信されたイベントにデバッグに役立つ追加情報を含めることができます。この方法は、アセット作成時にトリガされる Web フックに使用すると便利です。新しいアセットごとにディスク上にディレクトリ構造を 1 つ作成する作業を Web フックで行う場合、Web フックの URL は配信を正常に受信できますが、ディスクまたはネットワークが停止しているため、関連ディレクトリを作成することはできません。配信を受信した後、Web フックは、ディレクトリ構造が作成されなかったことおよびその理由を示す詳細なエラー メッセージを使用して、配信記録を更新することができます。 ## Web フックのテスト diff --git a/docs/ja/quick-answers/administering.md b/docs/ja/quick-answers/administering.md index 245b82b49..1c76db80d 100644 --- a/docs/ja/quick-answers/administering.md +++ b/docs/ja/quick-answers/administering.md @@ -10,11 +10,11 @@ lang: ja Toolkit セットアップの管理および設定に基づくクイック アンサーのコレクションです。 -#### Shotgun Desktop: -- [Shotgun Desktop を使用して Toolkit プロジェクトを再セットアップするにはどうすればいいですか?](./administering/resetup-project-with-sg-desktop.md) -- [Windows で Shotgun Desktop をサイレント インストールするにはどうすればいいですか?](./administering/install-desktop-silent.md) -- [Linux で Shotgun Desktop のデスクトップ/ランチャー アイコンをセットアップするにはどうすればいいですか?](./administering/create-shotgun-desktop-shortcut.md) -- [Shotgun Desktop のブラウザ統合を無効にするにはどうすればいいですか?](./administering/disable-browser-integration.md) +#### {% include product %} Desktop: +- [{% include product %} Desktop を使用して Toolkit プロジェクトを再セットアップするにはどうすればいいですか?](./administering/resetup-project-with-sg-desktop.md) +- [Windows で {% include product %} Desktop をサイレント インストールするにはどうすればいいですか?](./administering/install-desktop-silent.md) +- [Linux で {% include product %} Desktop のデスクトップ/ランチャー アイコンをセットアップするにはどうすればいいですか?](./administering/create-shotgun-desktop-shortcut.md) +- [{% include product %} Desktop のブラウザ統合を無効にするにはどうすればいいですか?](./administering/disable-browser-integration.md) #### 設定の管理: diff --git a/docs/ja/quick-answers/administering/convert-from-single-root-to-multi.md b/docs/ja/quick-answers/administering/convert-from-single-root-to-multi.md index f8258fde2..c7208ab47 100644 --- a/docs/ja/quick-answers/administering/convert-from-single-root-to-multi.md +++ b/docs/ja/quick-answers/administering/convert-from-single-root-to-multi.md @@ -10,19 +10,19 @@ lang: ja 既定の設定では、単一のローカル ストレージのルートが使用されます(つまり、すべてのプロジェクト ファイルは `/sgtk/projects` のような単一のルート ポイントに保存されます)。プロジェクト ファイルの一部を保存する新しいストレージ ルートを追加することができます。これは、ディスク スペースが不足した場合やストレージ メディアを高速化する場合に一般的な方法です。 「secondary」という名前の別のルートを追加する場合があるとします。必要な手順は次のとおりです。 -## Shotgun でローカル ストレージを追加する +## {% include product %} でローカル ストレージを追加する -- Shotgun で、**[管理者]（Admin）> [サイト基本設定]（Site Preferences）**ページに移動します +- {% include product %} で、**[管理者]（Admin）> [サイト基本設定]（Site Preferences）**ページに移動します - **[ファイル管理]（File Management）**セクションを開きます - **[[+] ローカル ファイル ストレージを追加]（[+] Add Local File Storage）**をクリックします - 名前(「secondary」)と関連するすべてのプラットフォーム上のストレージ ルートへのパスを入力します。*特定のプラットフォームを使用していない場合は、空白のままにすることができます。* - ページの上部または下部にある**[ページを保存]（Save Page）**ボタンをクリックします -![Shotgun ファイル管理の基本設定](images/shotgun-pref-file-management.png) +![{% include product %} ファイル管理の基本設定](images/shotgun-pref-file-management.png) ## 新しいルートをパイプライン設定に追加する -Toolkit は、`config/core/roots.yml` ファイルのパイプライン設定で使用されるローカル ストレージに関する情報をキャッシュします。Shotgun で作成したばかりの新しい **secondary** ストレージ ルートを追加するには、このファイルを次のように編集します。 +Toolkit は、`config/core/roots.yml` ファイルのパイプライン設定で使用されるローカル ストレージに関する情報をキャッシュします。{% include product %} で作成したばかりの新しい **secondary** ストレージ ルートを追加するには、このファイルを次のように編集します。 primary: { linux_path: /mnt/hgfs/sgtk/projects, @@ -88,4 +88,4 @@ Toolkit は、`config/core/roots.yml` ファイルのパイプライン設定で {% include info title="注" content="既定のストレージルートを使用するテンプレートには `root_name` を指定する必要はありません。既定のルートは、`roots.yml` ファイルで `default: true` を指定することによって示されます。`roots.yml` で既定値が明示的に定義されていない場合は、ルート **primary** が既定値と見なされます。"%} -1 *新しい値が設定されると、以前の値を使用して作成された古いファイルに Toolkit からアクセスできなくなるため、パスの更新が最適な方法ではない場合があります(テンプレート パスの変更後は Toolkit で古い作業ファイルは表示されません)。これが問題になる場合は、新しい場所を設定した新しいテンプレート(houdini_shot_publish_v2 など)を作成し、この新しいバージョンを使用するようにアプリをアップグレードすることができます。すべてのアプリがこのようなフォールバックの考え方に対応しているわけではありませんが、古いファイルを認識できるアプリもあります。アプリは Shotgun 内のパブリッシュと常にリンクされているため、これはパブリッシュに影響しません。* +1 *新しい値が設定されると、以前の値を使用して作成された古いファイルに Toolkit からアクセスできなくなるため、パスの更新が最適な方法ではない場合があります(テンプレート パスの変更後は Toolkit で古い作業ファイルは表示されません)。これが問題になる場合は、新しい場所を設定した新しいテンプレート(houdini_shot_publish_v2 など)を作成し、この新しいバージョンを使用するようにアプリをアップグレードすることができます。すべてのアプリがこのようなフォールバックの考え方に対応しているわけではありませんが、古いファイルを認識できるアプリもあります。アプリは {% include product %} 内のパブリッシュと常にリンクされているため、これはパブリッシュに影響しません。* diff --git a/docs/ja/quick-answers/administering/create-shotgun-desktop-shortcut.md b/docs/ja/quick-answers/administering/create-shotgun-desktop-shortcut.md index 0e1e4784e..056342574 100644 --- a/docs/ja/quick-answers/administering/create-shotgun-desktop-shortcut.md +++ b/docs/ja/quick-answers/administering/create-shotgun-desktop-shortcut.md @@ -5,9 +5,9 @@ pagename: create-shotgun-desktop-shortcut lang: ja --- -# Linux で Shotgun Desktop のデスクトップ/ランチャー アイコンをセットアップするにはどうすればいいですか? +# Linux で {% include product %} Desktop のデスクトップ/ランチャー アイコンをセットアップするにはどうすればいいですか? -現在の Shotgun Desktop インストーラはショートカットと起動のエントリを自動的に作成しないため、インストール後に手動で作業する必要があります。手順は簡単ですが、使用する Linux の種類によって手順が異なる場合があります。 +現在の {% include product %} Desktop インストーラはショートカットと起動のエントリを自動的に作成しないため、インストール後に手動で作業する必要があります。手順は簡単ですが、使用する Linux の種類によって手順が異なる場合があります。 -Shotgun Desktop インストーラを実行すると、Shotgun Desktop の実行可能なファイルは `/opt/Shotgun folder` 内に格納されます。実行可能ファイルの名前は Shotgun です。インストーラはアイコンを配置しません。[Shotgun Desktop エンジンの github リポジトリ](https://github.com/shotgunsoftware/tk-desktop/blob/aac6fe004bd003bf26316b9859bd4ebc42eb82dc/resources/default_systray_icon.png)からダウンロードしてください。 +{% include product %} Desktop インストーラを実行すると、{% include product %} Desktop の実行可能なファイルは `/opt/Shotgun folder` 内に格納されます。実行可能ファイルの名前は {% include product %} です。インストーラはアイコンを配置しません。[{% include product %} Desktop エンジンの github リポジトリ](https://github.com/shotgunsoftware/tk-desktop/blob/aac6fe004bd003bf26316b9859bd4ebc42eb82dc/resources/default_systray_icon.png)からダウンロードしてください。 アイコンをダウンロードして、実行可能ファイルのパス(`/opt/Shotgun/Shotgun`)を指定したら、必要なデスクトップまたはメニューのランチャーを手動で作成してください。この操作のプロセスは Linux のバージョンによって異なりますが、通常、Desktop を右クリックして適切なメニュー オプションを選べば、デスクトップ ランチャーを作成できます。 \ No newline at end of file diff --git a/docs/ja/quick-answers/administering/disable-browser-integration.md b/docs/ja/quick-answers/administering/disable-browser-integration.md index 7654a9a1c..ad4813d65 100644 --- a/docs/ja/quick-answers/administering/disable-browser-integration.md +++ b/docs/ja/quick-answers/administering/disable-browser-integration.md @@ -5,15 +5,15 @@ pagename: disable-browser-integration lang: ja --- -# Shotgun Desktop のブラウザ統合を無効にするにはどうすればいいですか? +# {% include product %} Desktop のブラウザ統合を無効にするにはどうすればいいですか? ブラウザの統合を無効にするには、次の簡単な 2 つの手順を実行します。 1. 次のテキスト ファイルを作成または開く - Windows: %APPDATA%\Shotgun\preferences\toolkit.ini - Macosx: ~/Library/Preferences/Shotgun/toolkit.ini - Linux: ~/.shotgun/preferences/toolkit.ini + Windows: %APPDATA%\{% include product %}\preferences\toolkit.ini + Macosx: ~/Library/Preferences/{% include product %}/toolkit.ini + Linux: ~/.{% include product %}/preferences/toolkit.ini 2. 次のセクションを追加する @@ -24,4 +24,4 @@ lang: ja **別の方法** -Toolkit のパイプライン設定を引き継いだ場合は、代わりに [`tk-shotgun` エンジンを環境から削除](https://github.com/shotgunsoftware/tk-config-default2/blob/master/env/project.yml#L48)し、アクションがロードされないようにすることができます。 \ No newline at end of file +Toolkit のパイプライン設定を引き継いだ場合は、代わりに [`tk-{% include product %}` エンジンを環境から削除](https://github.com/shotgunsoftware/tk-config-default2/blob/master/env/project.yml#L48)し、アクションがロードされないようにすることができます。 \ No newline at end of file diff --git a/docs/ja/quick-answers/administering/install-desktop-silent.md b/docs/ja/quick-answers/administering/install-desktop-silent.md index 497d0ad8e..afb05930f 100644 --- a/docs/ja/quick-answers/administering/install-desktop-silent.md +++ b/docs/ja/quick-answers/administering/install-desktop-silent.md @@ -5,9 +5,9 @@ pagename: install-desktop-silent lang: ja --- -# Windows で Shotgun Desktop をサイレント インストールするにはどうすればいいですか? +# Windows で {% include product %} Desktop をサイレント インストールするにはどうすればいいですか? -Shotgun Desktop インストーラをサイレントで実行するには、次の方法で Shotgun Desktop インストーラを起動します。 +{% include product %} Desktop インストーラをサイレントで実行するには、次の方法で {% include product %} Desktop インストーラを起動します。 `ShotgunInstaller_Current.exe /S` diff --git a/docs/ja/quick-answers/administering/move-configuration-location.md b/docs/ja/quick-answers/administering/move-configuration-location.md index dd3a46a3c..7e1200bb6 100644 --- a/docs/ja/quick-answers/administering/move-configuration-location.md +++ b/docs/ja/quick-answers/administering/move-configuration-location.md @@ -9,7 +9,7 @@ lang: ja {% include info title="注" content="このドキュメントのコンテンツは[一元管理設定のセットアップ](https://developer.shotgunsoftware.com/tk-core/initializing.html#centralized-configurations)にのみ適用されます。[分散設定](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)は個々のクライアント マシンにローカルにキャッシュされ、Toolkit によって自動的に管理されます。" %} -パイプライン設定を新しい場所に簡単に移動するには、`tank move_configuration` コマンドを使用します。これにより、ファイルを移動したり、Shotgun を更新したり、新しい場所を指すように設定ファイルを更新したりします。  +パイプライン設定を新しい場所に簡単に移動するには、`tank move_configuration` コマンドを使用します。これにより、ファイルを移動したり、{% include product %} を更新したり、新しい場所を指すように設定ファイルを更新したりします。  またこのコマンドは、1 つのオペレーティング システムで場所を移動するだけの場合や、以前は特定のオペレーティング システムを使用していなかったがこれから追加する場合などにも役立ちます。Toolkit は、移動する項目、追加する項目、またはそれ以外の項目を検出し、適用前に確認できるように実行内容が表示されます。 @@ -27,10 +27,10 @@ lang: ja $ cd /sgtk/software/shotgun/scarlet $ ./tank move_configuration - Welcome to the Shotgun Pipeline Toolkit! + Welcome to the {% include product %} Pipeline Toolkit! For documentation, see https://toolkit.shotgunsoftware.com Starting Toolkit for your current path '/sgtk/software/shotgun/scarlet' - - The path is not associated with any Shotgun object. + - The path is not associated with any {% include product %} object. - Falling back on default project settings. - Using configuration 'Primary' and Core v0.15.22 - Setting the Context to Scarlet. @@ -71,10 +71,10 @@ lang: ja $ cd /sgtk/software/shotgun/scarlet $ ./tank move_configuration "/mnt/hgfs/sgtk/software/shotgun/scarlet_new" "z:\sgtk\software\shotgun\scarlet_new" "/sgtk/software/shotgun/scarlet_new" - Welcome to the Shotgun Pipeline Toolkit! + Welcome to the {% include product %} Pipeline Toolkit! For documentation, see https://toolkit.shotgunsoftware.com Starting toolkit for path '/sgtk/software/shotgun/scarlet' - - The path is not associated with any Shotgun object. + - The path is not associated with any {% include product %} object. - Falling back on default project settings. - Using configuration 'Primary' and Core v0.15.22 - Setting the Context to Scarlet. @@ -129,7 +129,7 @@ lang: ja Copying /sgtk/software/shotgun/scarlet/install/frameworks... Copying /sgtk/software/shotgun/scarlet/install/frameworks/app_store... Updating cached locations in /sgtk/software/shotgun/scarlet_new/config/core/install_location.yml... - Updating Shotgun Configuration Record... + Updating {% include product %} Configuration Record... Deleting original configuration files... All done! Your configuration has been successfully moved. @@ -151,7 +151,7 @@ lang: ja 適用可能なプラットフォームすべてで、パイプライン設定の新しい場所を示すようにこのファイル内のパスを更新します。プラットフォームを使用していない場合は、空の文字列 `''` を入力します。 - # Shotgun Pipeline Toolkit configuration file + # {% include product %} Pipeline Toolkit configuration file # This file was automatically created by setup_project # This file reflects the paths in the primary pipeline @@ -162,9 +162,9 @@ lang: ja # End of file. -3. Shotgun でこのプロジェクトに対応する PipelineConfiguration エンティティを特定し、上記の変更と一致するように、[Mac のパス]（Mac Path）、[Windows のパス]（Windows Path）、[Linux のパス]（Linux Path）の各フィールドの値を修正します。 +3. {% include product %} でこのプロジェクトに対応する PipelineConfiguration エンティティを特定し、上記の変更と一致するように、[Mac のパス]（Mac Path）、[Windows のパス]（Windows Path）、[Linux のパス]（Linux Path）の各フィールドの値を修正します。 -![Shotgun のパイプライン設定の場所。](images/new-pipeline-configuration-locations.png) +![{% include product %} のパイプライン設定の場所。](images/new-pipeline-configuration-locations.png) これでパイプライン設定が新しい場所から予想どおりに機能するようになりました。 diff --git a/docs/ja/quick-answers/administering/move-project-directories.md b/docs/ja/quick-answers/administering/move-project-directories.md index b6fe72cd3..3d04d01c1 100644 --- a/docs/ja/quick-answers/administering/move-project-directories.md +++ b/docs/ja/quick-answers/administering/move-project-directories.md @@ -12,10 +12,10 @@ lang: ja 必要に応じて、プロジェクト ファイル(シーン ファイルやレンダリングなど)を 新しいルート ストレージ場所に移動することがあります(たとえば `/mnt/smalldrive` から `/mnt/bigdrive/foo` へ)。このためには、単一ルート設定またはマルチルート設定を使用します。たとえば、「**asset_storage**」という名前のストレージを移動するとします。 - 古い場所から新しい場所にプロジェクト ファイルをコピー(または移動)します。 -- Shotgun で、**[管理者]（Admin） > [サイト基本設定]（Site Preferences）**ページに移動して、**[ファイル管理]（File Management）**セクションを開きます。![サイト基本設定の Shotgun ストレージのルート セクション。](./images/shotgun-storage-roots.png) +- {% include product %} で、**[管理者]（Admin） > [サイト基本設定]（Site Preferences）**ページに移動して、**[ファイル管理]（File Management）**セクションを開きます。![サイト基本設定の {% include product %} ストレージのルート セクション。](./images/shotgun-storage-roots.png) - 各プラットフォームでプロジェクト ファイルの新しいストレージへのパスを設定して、「primary」と言う名前のローカル ファイル ストレージを更新します。特定のプラットフォームを使用していない場合は、空白のままにします。 - ページの上部または下部にある**[変更を保存]（Save Changes）**ボタンをクリックします。 -- Shotgun で保存したばかりの新しいパスの値と一致するようにプロジェクト設定の `config/core/roots.yml` ファイルを更新します。 +- {% include product %} で保存したばかりの新しいパスの値と一致するようにプロジェクト設定の `config/core/roots.yml` ファイルを更新します。 Toolkit はパブリッシュ パスをストレージ ルートの相対パスとして保存します。そのため、古いストレージ ルートを使用すると、パスはその前提に基づいて展開されていました。 @@ -25,7 +25,7 @@ Toolkit はパブリッシュ パスをストレージ ルートの相対パス [asset-storage]/assets/Character/betty => /mnt/bigdrive/foo/assets/Character/betty -これで、Shotgun や Toolkit 内の他のパブリッシュ情報の更新を心配する必要はありません。 +これで、{% include product %} や Toolkit 内の他のパブリッシュ情報の更新を心配する必要はありません。 {% include warning title="警告" content="上記の手順では、既存のストレージ ルートのパスを変更していると想定しています。既存のストレージを破棄するか、新規のストレージを作成する場合は、すべてのフォルダを再登録して `PublishedFiles` エンティティを再公開する必要があります。"%} @@ -35,4 +35,4 @@ Toolkit はパブリッシュ パスをストレージ ルートの相対パス ## バージョン -この変更の影響を受ける[ムービーのパス]（Path to Movie）フィールドまたは[フレームのパス]（Path to Frames）フィールドに情報を持つバージョン エンティティを Shotgun で使用する場合、これらのフィールドも新しい場所をポイントするように更新する必要があります。これらのフィールドは、メディアへの絶対パスを含む文字列フィールドであるためです。 \ No newline at end of file +この変更の影響を受ける[ムービーのパス]（Path to Movie）フィールドまたは[フレームのパス]（Path to Frames）フィールドに情報を持つバージョン エンティティを {% include product %} で使用する場合、これらのフィールドも新しい場所をポイントするように更新する必要があります。これらのフィールドは、メディアへの絶対パスを含む文字列フィールドであるためです。 \ No newline at end of file diff --git a/docs/ja/quick-answers/administering/resetup-project-with-sg-desktop.md b/docs/ja/quick-answers/administering/resetup-project-with-sg-desktop.md index 5ca8e263a..ccd25cc43 100644 --- a/docs/ja/quick-answers/administering/resetup-project-with-sg-desktop.md +++ b/docs/ja/quick-answers/administering/resetup-project-with-sg-desktop.md @@ -5,16 +5,16 @@ pagename: resetup-project-with-sg-desktop lang: ja --- -# Shotgun Desktop を使用して Toolkit プロジェクトを再セットアップするにはどうすればいいですか? +# {% include product %} Desktop を使用して Toolkit プロジェクトを再セットアップするにはどうすればいいですか? -既にプロジェクト用に Toolkit 構成をセットアップしていて、最初からやり直す必要がある場合、以前のセットアップ構成を削除しない限り Shotgun Desktop の詳細セットアップ ウィザードでプロジェクトを再セットアップすることはできません。 +既にプロジェクト用に Toolkit 構成をセットアップしていて、最初からやり直す必要がある場合、以前のセットアップ構成を削除しない限り {% include product %} Desktop の詳細セットアップ ウィザードでプロジェクトを再セットアップすることはできません。 これらの設定を手動で削除する手順は次のとおりです。 -1. Shotgun でプロジェクトにリンクされているすべての `PipelineConfiguration` エンティティを削除します。

![PipelineConfiguration エンティティ ページへのアクセス](images/pipeline-configuration-entity-page.png)

-2. Shotgun の `Project` エンティティの `Tank Name` フィールドを空白の値に設定します。

![プロジェクト タンク名フィールドをクリア](images/clear-project-tank-name.png)

+1. {% include product %} でプロジェクトにリンクされているすべての `PipelineConfiguration` エンティティを削除します。

![PipelineConfiguration エンティティ ページへのアクセス](images/pipeline-configuration-entity-page.png)

+2. {% include product %} の `Project` エンティティの `Tank Name` フィールドを空白の値に設定します。

![プロジェクト タンク名フィールドをクリア](images/clear-project-tank-name.png)

3. ディスク上で対応するパイプライン設定ディレクトリをすべて削除します。 -4. Shotgun Desktop で、セットアップするプロジェクトを選択します。*既にプロジェクトを表示していた場合は、プロジェクト リスト ビューに移動してから、もう一度プロジェクトに戻ります。* +4. {% include product %} Desktop で、セットアップするプロジェクトを選択します。*既にプロジェクトを表示していた場合は、プロジェクト リスト ビューに移動してから、もう一度プロジェクトに戻ります。* 6. これでプロジェクト セットアップ プロセスを再び実行できます。 **別の方法** diff --git a/docs/ja/quick-answers/administering/sg-desktop-run-on-ubuntu.md b/docs/ja/quick-answers/administering/sg-desktop-run-on-ubuntu.md index 78a60a59a..ff589fdd5 100644 --- a/docs/ja/quick-answers/administering/sg-desktop-run-on-ubuntu.md +++ b/docs/ja/quick-answers/administering/sg-desktop-run-on-ubuntu.md @@ -5,14 +5,14 @@ pagename: sg-desktop-run-on-ubuntu lang: ja --- -# Shotgun Desktop は Ubuntu のような Debian システムで動作しますか? +# {% include product %} Desktop は Ubuntu のような Debian システムで動作しますか? -現在、Shotgun Desktop では Debian ベースのディストリビューションをサポートしていません。cpio を使用して RPM から Shotgun Desktop を抽出し、そのライブラリの依存関係を維持して、うまく動作させようとしたクライアントが過去にいましたが、良い結果は得られませんでした。参考として、[当社の開発グループで次のスレッドを確認することができます](https://groups.google.com/a/shotgunsoftware.com/d/msg/shotgun-dev/nNBg4CKNBLc/naiGlJowBAAJ)。 +現在、{% include product %} Desktop では Debian ベースのディストリビューションをサポートしていません。cpio を使用して RPM から {% include product %} Desktop を抽出し、そのライブラリの依存関係を維持して、うまく動作させようとしたクライアントが過去にいましたが、良い結果は得られませんでした。参考として、[当社の開発グループで次のスレッドを確認することができます](https://groups.google.com/a/shotgunsoftware.com/d/msg/shotgun-dev/nNBg4CKNBLc/naiGlJowBAAJ)。 Python 自体が多くのシステム レベル ライブラリの最上部に配置されているため、ライブラリの依存関係の明示的なリストはありません。 現在、Debian をサポートする正式な予定はありません。Ubuntu 向けの開発を行うのには問題があります。変更ごとに追加オペレーティング システムの QA とサポートを更新する必要があり、これが大きな負担になります。 -Shotgun Desktop を使用せずに Toolkit を手動で実行して有効にする場合([このドキュメントの説明を参照](https://support.shotgunsoftware.com/hc/ja-jp/articles/219033208#Step%208.%20Run%20the%20activation%20script)) - そのドキュメントのページから `activate_shotgun_pipeline_toolkit.py` スクリプトをダウンロードしてください。ガイドの手順 8 にある「クリックして Shotgun Pipeline Toolkit アクティベーション パッケージをダウンロード」という見出しをクリックします。 +{% include product %} Desktop を使用せずに Toolkit を手動で実行して有効にする場合([このドキュメントの説明を参照](https://support.shotgunsoftware.com/hc/ja-jp/articles/219033208#Step%208.%20Run%20the%20activation%20script)) - そのドキュメントのページから `activate_shotgun_pipeline_toolkit.py` スクリプトをダウンロードしてください。ガイドの手順 8 にある「クリックして {% include product %} Pipeline Toolkit アクティベーション パッケージをダウンロード」という見出しをクリックします。 diff --git a/docs/ja/quick-answers/administering/what-is-path-cache.md b/docs/ja/quick-answers/administering/what-is-path-cache.md index 302522757..e23099cd6 100644 --- a/docs/ja/quick-answers/administering/what-is-path-cache.md +++ b/docs/ja/quick-answers/administering/what-is-path-cache.md @@ -7,15 +7,15 @@ lang: ja # パス キャッシュとは何ですか? ファイルシステムの場所とは何ですか? -パス キャッシュは、ディスクのフォルダと Shotgun のエンティティ間の関連付けをトラックするために Toolkit で使用されます。 -マスター キャッシュは、エンティティ タイプ `FilesystemLocation` を使用して Shotgun 内に保存されます。 各ユーザには、[ディスクの Toolkit キャッシュ ディレクトリにローカルに保存された](./where-is-my-cache.md)独自のバージョンのパス キャッシュがあり、アプリケーションを起動するときやフォルダを作成するときはいつでもバックグラウンドで同期されます。 +パス キャッシュは、ディスクのフォルダと {% include product %} のエンティティ間の関連付けをトラックするために Toolkit で使用されます。 +マスター キャッシュは、エンティティ タイプ `FilesystemLocation` を使用して {% include product %} 内に保存されます。 各ユーザには、[ディスクの Toolkit キャッシュ ディレクトリにローカルに保存された](./where-is-my-cache.md)独自のバージョンのパス キャッシュがあり、アプリケーションを起動するときやフォルダを作成するときはいつでもバックグラウンドで同期されます。 -通常は、パス キャッシュを手動で変更しないことをお勧めします。オートデスクの内部プロセスで、ローカル キャッシュと Shotgun 内の FilesystemLocation エンティティを同期するだけでなく、イベント ログ エントリを作成して、すべてのユーザのマシンが Shotgun との同期を維持できるようにもしています。 +通常は、パス キャッシュを手動で変更しないことをお勧めします。オートデスクの内部プロセスで、ローカル キャッシュと {% include product %} 内の FilesystemLocation エンティティを同期するだけでなく、イベント ログ エントリを作成して、すべてのユーザのマシンが {% include product %} との同期を維持できるようにもしています。 パス キャッシュを変更するために使用できる tank コマンドがいくつかあります。 - `tank unregister_folders`   は、パス キャッシュの関連付けを削除します。 -- `tank synchronize_folders`   は、ローカル パス キャッシュと Shotgun を強制的に同期します。 +- `tank synchronize_folders`   は、ローカル パス キャッシュと {% include product %} を強制的に同期します。 通常、これらのコマンドのいずれかを実行する必要はありませんが、状況によっては、これらが役立つことがあります。 たとえば、プロジェクト内のエンティティの名前を変更するか、エンティティを再作成する場合は、その前に `unregister_folders` を実行する必要があります。 \ No newline at end of file diff --git a/docs/ja/quick-answers/administering/where-is-my-cache.md b/docs/ja/quick-answers/administering/where-is-my-cache.md index 217fdfaff..117b62cc1 100644 --- a/docs/ja/quick-answers/administering/where-is-my-cache.md +++ b/docs/ja/quick-answers/administering/where-is-my-cache.md @@ -10,7 +10,7 @@ lang: ja ## ルート キャッシュの場所 -Toolkit は、Shotgun サーバに対する不要な呼び出しを防止するために、一部のデータをローカル キャッシュに保存します。ローカル キャッシュには[パス キャッシュ](./what-is-path-cache.md)、バンドル キャッシュ、およびサムネイルが含まれます。ほとんどのユーザは既定の場所を使用しますが、変更の必要がある場合は、[cache_location コア フック](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/cache_location.py)を使用して設定可能です。 +Toolkit は、{% include product %} サーバに対する不要な呼び出しを防止するために、一部のデータをローカル キャッシュに保存します。ローカル キャッシュには[パス キャッシュ](./what-is-path-cache.md)、バンドル キャッシュ、およびサムネイルが含まれます。ほとんどのユーザは既定の場所を使用しますが、変更の必要がある場合は、[cache_location コア フック](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/cache_location.py)を使用して設定可能です。 既定のキャッシュ ルートの場所は次のとおりです。 @@ -36,7 +36,7 @@ Toolkit は、Shotgun サーバに対する不要な呼び出しを防止する **分散設定** -バンドル キャッシュとは、Shotgun サイト上のプロジェクトすべてで使用される、すべてのアプリケーション、エンジン、およびフレームワークのキャッシュ コレクションです。 分散設定用のバンドル キャッシュは次の場所に保存されています。 +バンドル キャッシュとは、{% include product %} サイト上のプロジェクトすべてで使用される、すべてのアプリケーション、エンジン、およびフレームワークのキャッシュ コレクションです。 分散設定用のバンドル キャッシュは次の場所に保存されています。 Mac: `~/Library/Caches/Shotgun/bundle_cache` diff --git a/docs/ja/quick-answers/developing.md b/docs/ja/quick-answers/developing.md index 78336a540..ccd3aa0ce 100644 --- a/docs/ja/quick-answers/developing.md +++ b/docs/ja/quick-answers/developing.md @@ -13,6 +13,6 @@ Toolkit を使用した開発に基づくクイック アンサーのコレク - [ソフトウェアを起動する前に環境変数を設定するにはどうすればいいですか?](./developing/setting-software-environment-variables.md) - [as_template_fields() でコンテキスト内に存在する値が見つからない](./developing/as-template-fields-missing-values.md) - [Maya で Toolkit アプリを起動するシェルフ ボタンを追加するにはどうすればいいですか?](./developing/maya-shelf-app-launcher.md) -- [Shotgun のイベント デーモンを使用してさまざまな Toolkit コア モジュールをロードするにはどうすればいいですか?](./developing/toolkit-core-event-daemon.md) +- [{% include product %} のイベント デーモンを使用してさまざまな Toolkit コア モジュールをロードするにはどうすればいいですか?](./developing/toolkit-core-event-daemon.md) - [API を使用して Toolkit の設定をプログラムによって更新するにはどうすればいいですか?](./developing/update-config-with-api.md) - [API を使用してパブリッシュを作成するにはどうすればいいですか?](./developing/create-publishes-via-api.md) diff --git a/docs/ja/quick-answers/developing/create-publishes-via-api.md b/docs/ja/quick-answers/developing/create-publishes-via-api.md index c7a998457..19fff0a67 100644 --- a/docs/ja/quick-answers/developing/create-publishes-via-api.md +++ b/docs/ja/quick-answers/developing/create-publishes-via-api.md @@ -7,16 +7,16 @@ lang: ja # API を使用してパブリッシュを作成するにはどうすればいいですか? -オートデスクの sgtk API には、Shotgun で `PublishedFiles` エンティティを登録するための[便利なメソッド](https://developer.shotgunsoftware.com/tk-core/utils.html#sgtk.util.register_publish)が用意されています。 +オートデスクの sgtk API には、{% include product %} で `PublishedFiles` エンティティを登録するための[便利なメソッド](https://developer.shotgunsoftware.com/tk-core/utils.html#sgtk.util.register_publish)が用意されています。 また、[独自の API](https://developer.shotgunsoftware.com/tk-multi-publish2/) が付属している Publish アプリもあります。 Publish API は最終的にコア sgtk API メソッドを使用して PublishedFile を登録しますが、カスマイズ可能な、コレクション、検証、およびパブリッシュに関するフレームワークも用意されています。Publish API ドキュメントだけでなく、[パイプライン チュートリアル](https://developer.shotgunsoftware.com/ja/cb8926fc/)にも、独自のパブリッシュ プラグインを記述する例が記載されています。 ## register_publish() API メソッドを使用する -未処理の Shotgun API 呼び出しを使用して Shotgun でパブリッシュ レコードを作成することは可能ですが、Toolkit の便利なメソッドを使用することをお勧めします。 +未処理の {% include product %} API 呼び出しを使用して {% include product %} でパブリッシュ レコードを作成することは可能ですが、Toolkit の便利なメソッドを使用することをお勧めします。 パブリッシュを作成する Toolkit アプリはすべて、[`sgtk.util.register_publish()`](https://developer.shotgunsoftware.com/tk-core/utils.html#sgtk.util.register_publish)と呼ばれる API ユーティリティ メソッドを使用しています。 -基本的に、このメソッドは Shotgun で新しい PublishedFile エンティティを作成し、ツールキットの概念を使用してその作業を容易にするよう試行します。 以下の行に従ってコードを実行する必要があります。 +基本的に、このメソッドは {% include product %} で新しい PublishedFile エンティティを作成し、ツールキットの概念を使用してその作業を容易にするよう試行します。 以下の行に従ってコードを実行する必要があります。 ```python # Get access to the Toolkit API diff --git a/docs/ja/quick-answers/developing/setting-software-environment-variables.md b/docs/ja/quick-answers/developing/setting-software-environment-variables.md index afcdf25f9..4918a12d5 100644 --- a/docs/ja/quick-answers/developing/setting-software-environment-variables.md +++ b/docs/ja/quick-answers/developing/setting-software-environment-variables.md @@ -7,9 +7,9 @@ lang: ja # ソフトウェアを起動する前に環境変数を設定するにはどうすればいいですか? -Shotgun Toolkit では、起動プロセス中にフックを使用して環境を設定し、カスタム コードを実行することができます。 +{% include product %} Toolkit では、起動プロセス中にフックを使用して環境を設定し、カスタム コードを実行することができます。 -Nuke や Maya などのソフトウェアを Shotgun Desktop またはブラウザ統合を使用して起動すると、`tk-multi-launchapp` が実行されます。このアプリには、ソフトウェアを起動し、Shotgun 統合が予測どおりに起動したことを確認するという役割があります。このプロセス内にフックを使用して公開されている 2 つのポイントがあり、そこでカスタム コードを実行することができます。 +Nuke や Maya などのソフトウェアを {% include product %} Desktop またはブラウザ統合を使用して起動すると、`tk-multi-launchapp` が実行されます。このアプリには、ソフトウェアを起動し、{% include product %} 統合が予測どおりに起動したことを確認するという役割があります。このプロセス内にフックを使用して公開されている 2 つのポイントがあり、そこでカスタム コードを実行することができます。 ## before_app_launch.py diff --git a/docs/ja/quick-answers/developing/setting_software_environment_variables.md b/docs/ja/quick-answers/developing/setting_software_environment_variables.md deleted file mode 100644 index 20b6fbd01..000000000 --- a/docs/ja/quick-answers/developing/setting_software_environment_variables.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default -title: ソフトウェアを起動する前に環境変数を設定するにはどうすればいいですか? -pagename: setting_software_environment_variables -lang: ja ---- - -# ソフトウェアを起動する前に環境変数を設定するにはどうすればいいですか? - -Shotgun Toolkit では、起動プロセス中にフックを使用して環境を設定し、カスタム コードを実行することができます。 - -Nuke や Maya などのソフトウェアを Shotgun Desktop またはブラウザ統合を使用して起動すると、`tk-multi-launchapp` が実行されます。このアプリには、ソフトウェアを起動し、Shotgun 統合が予測どおりに起動したことを確認するという役割があります。このプロセス内にフックを使用して公開されている 2 つのポイントがあり、そこでカスタム コードを実行することができます。 - -## before_app_launch.py - -[`before_app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/6a884aa144851148e8369e9f35a2471087f98d16/hooks/before_app_launch.py) フックは、ソフトウェアを起動する直前に呼び出されます。このフックを使用すると、起動されたソフトウェアに渡す任意のカスタム環境変数を完全に設定することができます。 - -例: - -```python -import os -import tank - -class BeforeAppLaunch(tank.Hook): - - def execute(self, app_path, app_args, version, engine_name, **kwargs): - - if engine_name == "tk-maya": - os.environ["MY_CUSTOM_MAYA_ENV_VAR"] = "Some Maya specific setting" -``` - -{% include warning title="警告" content="Shotgun で設定された環境変数を完全に再定義しないよう注意してください。 -たとえば、`NUKE_PATH` (Nuke の場合)、または `PYTHONPATH` (Maya の場合)にパスを追加する必要がある場合は、既存の値を置き換えるのではなく、そこにパスを追加するようにしてください。このための便利な方法が提供されています。 - -```python -tank.util.append_path_to_env_var(\"NUKE_PATH\", \"/my/custom/path\") -``` -" %} - -## カスタム ラッパー - -スタジオによっては、環境変数の設定とソフトウェアの起動を処理するカスタム ラッパーが用意されている場合があります。このようなカスタム コードを使用する場合は、`Software` エンティティの[パス フィールド](https://support.shotgunsoftware.com/hc/ja/articles/115000067493-Integrations-Admin-Guide#Example:%20Add%20your%20own%20Software)が実行可能なラッパーを示すように指定すると、`tk-multi-launchapp` が代わりに実行されます。 - -{% include warning title="警告" content="この方法を使用する場合は、Shotgun で設定された環境変数を保持するよう注意してください。そうしないと、統合が起動しなくなります。" %} \ No newline at end of file diff --git a/docs/ja/quick-answers/developing/toolkit-core-event-daemon.md b/docs/ja/quick-answers/developing/toolkit-core-event-daemon.md index dee2b848e..f66ad8042 100644 --- a/docs/ja/quick-answers/developing/toolkit-core-event-daemon.md +++ b/docs/ja/quick-answers/developing/toolkit-core-event-daemon.md @@ -13,7 +13,7 @@ lang: ja Toolkit の sgtk API はプロジェクト中心です。つまり、API を使用するプロジェクトから明示的に API を読み込まなければなりません。つまり、1 つの Python セッションで複数のプロジェクトに対して sgtk API 操作を使用すると、Python では同じ名前のモジュールを 1 回しか読み込めないため、問題が発生します。 -[Shotgun Event デーモン](https://github.com/shotgunsoftware/shotgunEvents)を使用している場合、特定のイベントについてはプラグイン内で Toolkit のアクションを実行することができます。これは、Python がモジュールを一度しか読み込まないため少々厄介です。そのため、プロジェクト A の Toolkit Core API をプラグインの初回実行時に読み込む場合、このバージョンはデーモンの存続期間中読み込まれたままになります。つまり、プラグインに割り当てられる次のイベントがプロジェクト B 用である場合、プロジェクト A の Core API を使用してプロジェクト B の新しい Toolkit オブジェクトのインスタンスを作成しようとすると、Toolkit にエラーが表示されます。 +[{% include product %} Event デーモン](https://github.com/shotgunsoftware/shotgunEvents)を使用している場合、特定のイベントについてはプラグイン内で Toolkit のアクションを実行することができます。これは、Python がモジュールを一度しか読み込まないため少々厄介です。そのため、プロジェクト A の Toolkit Core API をプラグインの初回実行時に読み込む場合、このバージョンはデーモンの存続期間中読み込まれたままになります。つまり、プラグインに割り当てられる次のイベントがプロジェクト B 用である場合、プロジェクト A の Core API を使用してプロジェクト B の新しい Toolkit オブジェクトのインスタンスを作成しようとすると、Toolkit にエラーが表示されます。 **一元管理設定を使用する場合の問題の例:** diff --git a/docs/ja/quick-answers/troubleshooting.md b/docs/ja/quick-answers/troubleshooting.md index db699e9bb..bc9ab01c7 100644 --- a/docs/ja/quick-answers/troubleshooting.md +++ b/docs/ja/quick-answers/troubleshooting.md @@ -19,14 +19,14 @@ lang: ja - [Python API で発生する SSL: CERTIFICATE_VERIFY_FAILED の問題の解決](./troubleshooting/fix-ssl-certificate-verify-failed.md) #### ソフトウェア統合 -- [Houdini Shotgun 統合が起動しないのはなぜですか。](./troubleshooting/houdini-integrations-not-starting.md) -- [SG Desktop から Nuke や Maya などを起動したが Shotgun のメニューにエントリが表示されない](./troubleshooting/menu-entries-missing-in-launched-dcc.md) +- [Houdini {% include product %} 統合が起動しないのはなぜですか。](./troubleshooting/houdini-integrations-not-starting.md) +- [SG Desktop から Nuke や Maya などを起動したが {% include product %} のメニューにエントリが表示されない](./troubleshooting/menu-entries-missing-in-launched-dcc.md) - [環境変数 NUKE_PATH を設定すると Nuke 統合の起動に失敗するのはなぜですか?](./troubleshooting/nuke-path-environment-variable.md) - [2 つの機能拡張がインストールされている場合の Photoshop 統合のトラブルシューティング](./troubleshooting/two-photoshop-shotgun-extensions.md) -- [Shotgun Toolkit を使用すると 3ds Max の起動時にクラッシュするのはなぜですか?](./troubleshooting/3dsmax-crashes-on-startup.md) +- [{% include product %} Toolkit を使用すると 3ds Max の起動時にクラッシュするのはなぜですか?](./troubleshooting/3dsmax-crashes-on-startup.md) #### ブラウザの統合 - [ローカル ファイル リンクを使用できず、Chrome から Toolkit アプリケーションを起動できない](./troubleshooting/cant-use-file-linking-toolkit-app-chrome.md) - [ローカル ファイル リンクを使用できず、Firefox から Toolkit アプリケーションを起動できない](./troubleshooting/cant-use-file-linking-toolkit-app-firefox.md) -- [Linux で Shotgun Desktop/ブラウザ統合の起動に失敗する](./troubleshooting/browser-integration-fails-linux.md) +- [Linux で {% include product %} Desktop/ブラウザ統合の起動に失敗する](./troubleshooting/browser-integration-fails-linux.md) diff --git a/docs/ja/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md b/docs/ja/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md index fe3d685bb..03907326e 100644 --- a/docs/ja/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md +++ b/docs/ja/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md @@ -5,9 +5,9 @@ pagename: 3dsmax-crashes-on-startup lang: ja --- -# Shotgun Toolkit を使用する場合、3ds Max が起動時にクラッシュするのはなぜですか? +# {% include product %} Toolkit を使用する場合、3ds Max が起動時にクラッシュするのはなぜですか? -Shotgun Desktop または Shotgun Web サイトから 3ds Max を起動すると、真っ白なダイアログが表示されて 3ds Max がフリーズするか、または次のメッセージが表示されます。 +{% include product %} Desktop または {% include product %} Web サイトから 3ds Max を起動すると、真っ白なダイアログが表示されて 3ds Max がフリーズするか、または次のメッセージが表示されます。 Microsoft Visual C++ Runtime Library (Not Responding) Runtime Error! @@ -54,4 +54,4 @@ class BeforeAppLaunch(tank.get_hook_baseclass()): 次に、パイプライン設定で `config/env/includes/app_launchers.yml` を開き、エントリ `launch_3dsmax` を探します。`hook_before_app_launch: default` を `hook_before_app_launch: '{config}/before_app_launch.py'` に置き換える必要があります。 -これで Shotgun と Shotgun Desktop から 3ds Max を正しく起動できるようになりました。まだ問題が解決しない場合は、support@shotgunsoftware.com までご連絡ください。 +これで {% include product %} と {% include product %} Desktop から 3ds Max を正しく起動できるようになりました。まだ問題が解決しない場合は、support@shotgunsoftware.com までご連絡ください。 diff --git a/docs/ja/quick-answers/troubleshooting/browser-integration-fails-linux.md b/docs/ja/quick-answers/troubleshooting/browser-integration-fails-linux.md index 743ca3385..7d33739e4 100644 --- a/docs/ja/quick-answers/troubleshooting/browser-integration-fails-linux.md +++ b/docs/ja/quick-answers/troubleshooting/browser-integration-fails-linux.md @@ -5,9 +5,9 @@ pagename: browser-integration-fails-linux lang: ja --- -# Linux で Shotgun Desktop/ブラウザ統合の起動に失敗する +# Linux で {% include product %} Desktop/ブラウザ統合の起動に失敗する -Linux で Shotgun Desktop を初めて実行すると、次のいずれかのエラー メッセージが表示される場合があります。この場合、特定のエラーに合わせて次の手順を実行して問題が解決されるかどうかを確認します。 +Linux で {% include product %} Desktop を初めて実行すると、次のいずれかのエラー メッセージが表示される場合があります。この場合、特定のエラーに合わせて次の手順を実行して問題が解決されるかどうかを確認します。 問題が解決しない場合は、support@shotgunsoftware.com までお気軽にお問い合わせください。 ### 目次 @@ -51,13 +51,13 @@ libffi をインストールする必要があります。このためには、 yum install libffi ``` -libffi をインストールしても問題が継続する場合は、次の symlink を作成して Shotgun Desktop を再起動してください。 +libffi をインストールしても問題が継続する場合は、次の symlink を作成して {% include product %} Desktop を再起動してください。 ``` sudo ln -s /usr/lib64/libffi.so.6.0.1 /usr/lib64/libffi.so.5 ``` -上記の手順で成功したユーザもいますが、 問題が解決しなかったユーザもいます。最新バージョンの Shotgun Desktop には、現在調査している Web ソケット サーバとの依存関係がいくつか追加されています。 +上記の手順で成功したユーザもいますが、 問題が解決しなかったユーザもいます。最新バージョンの {% include product %} Desktop には、現在調査している Web ソケット サーバとの依存関係がいくつか追加されています。 ## 証明書検証の失敗に関連する問題 @@ -71,7 +71,7 @@ certutil: function failed: SEC_ERROR_BAD_DATABASE: security library: bad databas **解決策** -コンピュータに Google Chrome をインストールしている場合は、Google Chrome を起動してから Shotgun Desktop を再起動します。問題が解決しない場合は、support@shotgunsoftware.com までお問い合わせください。 +コンピュータに Google Chrome をインストールしている場合は、Google Chrome を起動してから {% include product %} Desktop を再起動します。問題が解決しない場合は、support@shotgunsoftware.com までお問い合わせください。 Chrome がインストールされていない場合は、端末を開いて、次のコマンドを実行します。 @@ -93,7 +93,7 @@ $ certutil -N -d "sql:$HOME/.pki/nssdb" ``` パスワードは入力しないでください。 -これで、Shotgun Desktop が正しく起動されるようになります。 +これで、{% include product %} Desktop が正しく起動されるようになります。 ## 互換性のない Qt バージョン diff --git a/docs/ja/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md b/docs/ja/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md index 14013753d..912bcf341 100644 --- a/docs/ja/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md +++ b/docs/ja/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md @@ -9,7 +9,7 @@ lang: ja ## 概要 -Shotgun のアクション メニューで Toolkit アプリケーションのリストが表示されなかったり、Shotgun Desktop が動作していてもローカル ファイル リンクを使用するときにエラーが発生したりする場合があります。 これは Chrome での Shotgun Desktop のブラウザ統合のトラブルシューティングに関するガイドです。皆さんの役に立つことを願っています。[Firefox](./cant-use-file-linking-toolkit-app-firefox.md) のための個別のガイドがあります。 +{% include product %} のアクション メニューで Toolkit アプリケーションのリストが表示されなかったり、{% include product %} Desktop が動作していてもローカル ファイル リンクを使用するときにエラーが発生したりする場合があります。 これは Chrome での {% include product %} Desktop のブラウザ統合のトラブルシューティングに関するガイドです。皆さんの役に立つことを願っています。[Firefox](./cant-use-file-linking-toolkit-app-firefox.md) のための個別のガイドがあります。 - [問題を診断する](#diagnosing-the-issue) - [証明書問題をすばやく修正する方法](#how-to-quickly-fix-certificate-issues) @@ -18,13 +18,13 @@ Shotgun のアクション メニューで Toolkit アプリケーションの ## 問題を診断する -### Shotgun Desktop は動作していますか? +### {% include product %} Desktop は動作していますか? もちろん、そうだと思います。 既に確認済みだと思いますが、 念のためお尋ねしました。:) -### Shotgun Desktop の起動後に Chrome を再起動しましたか? +### {% include product %} Desktop の起動後に Chrome を再起動しましたか? -Shotgun Desktop が証明書を登録する前に Chrome を起動した場合(Shotgun Desktop を初めて起動した場合にのみ発生し、その後は問題になりません)、Chrome は期限切れの証明書のコピーを使用し、Shotgun Desktop への接続を拒否します。すべてのタブを閉じても Chrome は終了する必要がないため、アドレス バーに [chrome://restart](chrome://restart/) と入力して[Enter]キーを押します。これにより、Chrome に関連するすべてのプロセスを終了し、Chrome を再起動させます。 +{% include product %} Desktop が証明書を登録する前に Chrome を起動した場合({% include product %} Desktop を初めて起動した場合にのみ発生し、その後は問題になりません)、Chrome は期限切れの証明書のコピーを使用し、{% include product %} Desktop への接続を拒否します。すべてのタブを閉じても Chrome は終了する必要がないため、アドレス バーに [chrome://restart](chrome://restart/) と入力して[Enter]キーを押します。これにより、Chrome に関連するすべてのプロセスを終了し、Chrome を再起動させます。 ### ファイアウォール ソフトウェアを使用していますか? @@ -32,7 +32,7 @@ Shotgun Desktop が証明書を登録する前に Chrome を起動した場合(S ### Chrome が証明書を拒否していますか? -Chrome が証明書を受け入れていることを確認するには、https://localhost:9000 を参照します。これは、ローカル ファイル リンクを使用して Toolkit アプリケーションを起動するために Shotgun Web サイトがアクセスを試みるアドレスです。通常、次のメッセージが表示されます。 +Chrome が証明書を受け入れていることを確認するには、https://localhost:9000 を参照します。これは、ローカル ファイル リンクを使用して Toolkit アプリケーションを起動するために {% include product %} Web サイトがアクセスを試みるアドレスです。通常、次のメッセージが表示されます。 ![Autobahn Python メッセージ](images/autobahn-python.png) @@ -44,7 +44,7 @@ Chrome が証明書を受け入れていることを確認するには、https:/ ## 証明書問題をすばやく修正する方法 -この問題を回避する最も簡単な方法は、**ADVANCED** と **Proceed to localhost (unsafe)** をクリックすることです。 これにより、Chrome は証明書を承認していることを把握でき、Shotgun Web サイトが Shotgun Desktop と通信できるようになります。 +この問題を回避する最も簡単な方法は、**ADVANCED** と **Proceed to localhost (unsafe)** をクリックすることです。 これにより、Chrome は証明書を承認していることを把握でき、{% include product %} Web サイトが {% include product %} Desktop と通信できるようになります。 {% include info title="注" content="このため、Web ブラウザと Shotgun Desktop 間の接続のみが有効になります。信頼設定は 2 つのアプリケーション間のトラフィック フローを許可しますが、**インターネット上の他のサーバの信頼性を暗示しているわけではありません**。 残念なことに、問題を抱えたすべてのコンピュータにこのプロセスを繰り返し適用する必要があります。問題が解決されない場合、またはすべてのユーザに展開するには複雑すぎる場合は、次の手順を試すことをお勧めします。"%} @@ -54,11 +54,11 @@ Chrome が証明書を受け入れていることを確認するには、https:/ Chrome は自己署名証明書のセキュリティを定期的に更新しますが、ブラウザ統合がこの更新で壊れることがあります。 残念ながら、このような問題を解決するには証明書の certificate_path を再生成するしかありません。 -証明書を再生成するには、Shotgun Desktop のユーザ メニューの **[詳細設定]（Advanced）**セクションにある **Regenerate Certificates** オプションを選択します。(このオプションが表示されない場合は、ロック解除のために `tk-desktop` エンジンを更新してください。) +証明書を再生成するには、{% include product %} Desktop のユーザ メニューの **[詳細設定]（Advanced）**セクションにある **Regenerate Certificates** オプションを選択します。(このオプションが表示されない場合は、ロック解除のために `tk-desktop` エンジンを更新してください。) -証明書の再生成を確定すると、証明書を初めて生成したときのように一連のダイアログが表示されます。Windows と macOS で、Windows Certificate Store または macOS キーチェーンの更新を求めるプロンプトが 2 回表示されます。1 回目は古い証明書の削除のときで、2 回目は新しい証明書の登録のときです。Linux では、確認なしで登録されます。 登録されると、Shotgun Desktop が再起動されます。 +証明書の再生成を確定すると、証明書を初めて生成したときのように一連のダイアログが表示されます。Windows と macOS で、Windows Certificate Store または macOS キーチェーンの更新を求めるプロンプトが 2 回表示されます。1 回目は古い証明書の削除のときで、2 回目は新しい証明書の登録のときです。Linux では、確認なしで登録されます。 登録されると、{% include product %} Desktop が再起動されます。 -Shotgun Desktop の準備が完了したら、Chrome が完全にシャットダウンしてその証明書キャッシュがクリアされるように、アドレス バーに [chrome://restart](chrome://restart/) と入力して Chrome を再起動することをお勧めします。 +{% include product %} Desktop の準備が完了したら、Chrome が完全にシャットダウンしてその証明書キャッシュがクリアされるように、アドレス バーに [chrome://restart](chrome://restart/) と入力して Chrome を再起動することをお勧めします。 コンピュータがインターネットに接続されておらず、更新をダウンロードできない場合は、support@shotgunsoftware.com までお問い合わせください。 @@ -98,4 +98,4 @@ Shotgun Desktop の準備が完了したら、Chrome が完全にシャットダ ## 他の OS でのトラブルシューティング -他の OS での Shotgun Desktop 統合に問題がある場合は、この記事を更新してサポートできるように、[サポート チーム](https://support.shotgunsoftware.com/hc/ja/requests/new)までご連絡ください。 \ No newline at end of file +他の OS での {% include product %} Desktop 統合に問題がある場合は、この記事を更新してサポートできるように、[サポート チーム](https://support.shotgunsoftware.com/hc/ja/requests/new)までご連絡ください。 \ No newline at end of file diff --git a/docs/ja/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md b/docs/ja/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md index 08bc82025..8a1a26ad6 100644 --- a/docs/ja/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md +++ b/docs/ja/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md @@ -9,12 +9,12 @@ lang: ja ## 概要 -Shotgun のアクション メニューで Toolkit アプリケーションのリストが表示されなかったり、Shotgun Desktop が動作していてもローカル ファイル リンクを使用するときにエラーが発生したりする場合があります。 -これは Firefox での Shotgun Desktop のブラウザ統合のトラブルシューティングに関するガイドです。皆さんの役に立つことを願っています。[Chrome](./cant-use-file-linking-toolkit-app-chrome.md) のための個別のガイドがあります。 +{% include product %} のアクション メニューで Toolkit アプリケーションのリストが表示されなかったり、{% include product %} Desktop が動作していてもローカル ファイル リンクを使用するときにエラーが発生したりする場合があります。 +これは Firefox での {% include product %} Desktop のブラウザ統合のトラブルシューティングに関するガイドです。皆さんの役に立つことを願っています。[Chrome](./cant-use-file-linking-toolkit-app-chrome.md) のための個別のガイドがあります。 ## 問題を診断する -### Shotgun Desktop は動作していますか? +### {% include product %} Desktop は動作していますか? もちろん、そうだと思います。 既に確認済みだと思いますが、 念のためお尋ねしました。  @@ -24,7 +24,7 @@ Shotgun のアクション メニューで Toolkit アプリケーションの ### Firefox が証明書を拒否していますか? -Firefox が証明書を受け入れていることを確認するには、https://localhost:9000 を参照します。これは、ローカル ファイル リンクを使用して Toolkit アプリケーションを起動するために Shotgun Web サイトがアクセスを試みるアドレスです。通常、次のメッセージが表示されます。 +Firefox が証明書を受け入れていることを確認するには、https://localhost:9000 を参照します。これは、ローカル ファイル リンクを使用して Toolkit アプリケーションを起動するために {% include product %} Web サイトがアクセスを試みるアドレスです。通常、次のメッセージが表示されます。 ![Autobahn Python メッセージ](images/autobahn-python.png) @@ -40,9 +40,9 @@ Firefox が証明書を受け入れていることを確認するには、https: ![Firefox に例外を追加](images/add-exception-firefox.png) -****[証明書を取得]（Get Certificate）**、**[セキュリティ例外を承認]（Confirm Security Exception）の順にクリックします。 証明書を信頼できないというメッセージは無視します。証明書は認証局ではなく Shotgun Desktop によって生成されているため、問題ありません。 +****[証明書を取得]（Get Certificate）**、**[セキュリティ例外を承認]（Confirm Security Exception）の順にクリックします。 証明書を信頼できないというメッセージは無視します。証明書は認証局ではなく {% include product %} Desktop によって生成されているため、問題ありません。 -これで Shotgun サイトからローカル ファイル リンクにアクセスし、Toolkit アプリケーションを起動できるようになるはずです。 例外を追加しても問題が解決しない場合は、support@shotgunsoftware.com までご連絡ください。 +これで {% include product %} サイトからローカル ファイル リンクにアクセスし、Toolkit アプリケーションを起動できるようになるはずです。 例外を追加しても問題が解決しない場合は、support@shotgunsoftware.com までご連絡ください。 ## 「安全な接続ができませんでした」というエラーを解決する方法 diff --git a/docs/ja/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md b/docs/ja/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md index 0e655c13c..33e2d76ec 100644 --- a/docs/ja/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md +++ b/docs/ja/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md @@ -7,7 +7,7 @@ lang: ja # Python API で発生する SSL: CERTIFICATE_VERIFY_FAILED の問題の解決 -Python API は、API にバンドルされ、マシンに格納されている証明書のリストを利用して、Shotgun で使用されているさまざまな Web サービスに接続します。ただし、新しい認証局がリリースされた場合は、これらが Python API または OS にバンドルされていないことがあります。 +Python API は、API にバンドルされ、マシンに格納されている証明書のリストを利用して、{% include product %} で使用されているさまざまな Web サービスに接続します。ただし、新しい認証局がリリースされた場合は、これらが Python API または OS にバンドルされていないことがあります。 オートデスクの Python API には、2019 年 2 月 21 日時点の証明書の最新コピーが付属していますが、最新バージョンの API を使用している場合でも、API がこれらの証明書を使用して Amazon S3 にアップロードするのを妨害するバグが存在します。背景情報については、[この AWS に関するブログの投稿](https://aws.amazon.com/blogs/security/how-to-prepare-for-aws-move-to-its-own-certificate-authority/)を参照してください。状況を一時的に修正するには、次の解決策を試してください。 @@ -34,7 +34,7 @@ Windows 証明書ストアに必要な CA 証明書を追加します。Windows 1. Python API **v3.0.39** にアップグレードします。 -2. a. `SHOTGUN_API_CACERTS` を `/path/to/shotgun_api3/lib/httplib2/cacerts.txt` に設定します。 +2. a. `{% include product %}_API_CACERTS` を `/path/to/shotgun_api3/lib/httplib2/cacerts.txt` に設定します。 または @@ -46,7 +46,7 @@ Windows 証明書ストアに必要な CA 証明書を追加します。Windows 2. [https://github.com/certifi/python-certifi/blob/master/certifi/cacert.pem](ttps://github.com/certifi/python-certifi/blob/master/certifi/cacert.pem) にある証明書の最新リストをダウンロードします。 -3. `SHOTGUN_API_CACERTS` をこのファイルの保存場所に設定します。ただし、接続を作成するときに、Python API のように Toolkit から `ca_certs`ca_certs パラメータを指定することはできません。 +3. `{% include product %}_API_CACERTS` をこのファイルの保存場所に設定します。ただし、接続を作成するときに、Python API のように Toolkit から `ca_certs`ca_certs パラメータを指定することはできません。 ### Python API または Toolkit を更新できない場合 diff --git a/docs/ja/quick-answers/troubleshooting/houdini-integrations-not-starting.md b/docs/ja/quick-answers/troubleshooting/houdini-integrations-not-starting.md index dc3ccbd36..169c3c505 100644 --- a/docs/ja/quick-answers/troubleshooting/houdini-integrations-not-starting.md +++ b/docs/ja/quick-answers/troubleshooting/houdini-integrations-not-starting.md @@ -5,14 +5,14 @@ pagename: houdini-integrations-not-starting lang: ja --- -# Houdini Shotgun 統合が起動しないのはなぜですか。 +# Houdini {% include product %} 統合が起動しないのはなぜですか。 -ここでは、Shotgun の統合で Houdini が起動しない場合に見られる、最も一般的な理由について説明します。この場合、Houdini は Shotgun Desktop、Shotgun の Web サイト、または tank コマンドからエラーなしで起動します。 ただし、Houdini が起動すると、Shotgun メニューまたはシェルフが表示されなくなります。 +ここでは、{% include product %} の統合で Houdini が起動しない場合に見られる、最も一般的な理由について説明します。この場合、Houdini は {% include product %} Desktop、{% include product %} の Web サイト、または tank コマンドからエラーなしで起動します。 ただし、Houdini が起動すると、{% include product %} メニューまたはシェルフが表示されなくなります。 -この問題は、`HOUDINI_PATH` 環境変数がオーバーライドされていて、Shotgun がその環境変数に基づいて起動スクリプト パスを渡そうとしているために発生することがよくあります。 +この問題は、`HOUDINI_PATH` 環境変数がオーバーライドされていて、{% include product %} がその環境変数に基づいて起動スクリプト パスを渡そうとしているために発生することがよくあります。 -Houdini を Shotgun から起動すると、起動アプリケーション ロジックは Shotgun ブートストラップ スクリプト パスを `HOUDINI_PATH` 環境変数に追加します。 しかし、Houdini に [houdini.env ファイル](http://www.sidefx.com/docs/houdini/basics/config_env.html#setting-environment-variables)があると問題が発生することがあります。 このファイルがあると、ユーザーは Houdini がロードされたときに存在する環境変数を設定できますが、ファイルに定義されている値によって現在のセッションの既存の環境変数が上書きされます。 +Houdini を {% include product %} から起動すると、起動アプリケーション ロジックは {% include product %} ブートストラップ スクリプト パスを `HOUDINI_PATH` 環境変数に追加します。 しかし、Houdini に [houdini.env ファイル](http://www.sidefx.com/docs/houdini/basics/config_env.html#setting-environment-variables)があると問題が発生することがあります。 このファイルがあると、ユーザーは Houdini がロードされたときに存在する環境変数を設定できますが、ファイルに定義されている値によって現在のセッションの既存の環境変数が上書きされます。 これを修正するには、その変数の新しい定義に既存の `HOUDINI_PATH` 環境変数を含めます。 @@ -24,7 +24,7 @@ Houdini を Shotgun から起動すると、起動アプリケーション ロ HOUDINI_PATH = /example/of/an/existing/path;$HOUDINI_PATH;& -これにより、Houdini の起動時に Shotgun の設定値が維持されます。 +これにより、Houdini の起動時に {% include product %} の設定値が維持されます。 {% include warning title="注意" content="Windows では、`$HOUDINI_PATH` によって問題が発生することがあります。この変数によって Shotgun の統合へのブートストラップが数回試行され、次のようなエラーが表示されます。 diff --git a/docs/ja/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md b/docs/ja/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md index c0bf86058..d91aca5b1 100644 --- a/docs/ja/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md +++ b/docs/ja/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md @@ -5,22 +5,22 @@ pagename: menu-entries-missing-in-launched-dcc lang: ja --- -# SG Desktop から Nuke や Maya などを起動したが Shotgun のメニューにエントリが表示されない +# SG Desktop から Nuke や Maya などを起動したが {% include product %} のメニューにエントリが表示されない -Shotgun メニューに表示されるアクションはコンテキストに応じて設定されます。つまり、利用可能なアクションのリストは、現在のコンテキストによって異なる可能性があります。コンテキストが間違っているためにアプリが表示されない可能性があります。 +{% include product %} メニューに表示されるアクションはコンテキストに応じて設定されます。つまり、利用可能なアクションのリストは、現在のコンテキストによって異なる可能性があります。コンテキストが間違っているためにアプリが表示されない可能性があります。 ## 例 -[Shotgun Desktop](https://support.shotgunsoftware.com/hc/ja/articles/219039818) からアプリケーションを起動すると、既定ではプロジェクト環境が表示されます。この環境は、`config/env/project.yml` に格納されたパイプライン設定内の設定ファイルによって管理されます。ユーザーの作業のほとんどはこの環境では行わないため、多くのアプリでは操作用に設定されていません。 +[{% include product %} Desktop](https://support.shotgunsoftware.com/hc/ja/articles/219039818) からアプリケーションを起動すると、既定ではプロジェクト環境が表示されます。この環境は、`config/env/project.yml` に格納されたパイプライン設定内の設定ファイルによって管理されます。ユーザーの作業のほとんどはこの環境では行わないため、多くのアプリでは操作用に設定されていません。 **既定の Maya プロジェクト アクション:** -![Shotgun メニューのプロジェクト アクション](images/shotgun-menu-project-actions.png) +![{% include product %} メニューのプロジェクト アクション](images/shotgun-menu-project-actions.png) -[Shotgun Workfiles アプリ](https://support.shotgunsoftware.com/hc/ja/articles/219033088)を使用すると、作業するアセット、ショット、またはタスクを選択できます。これにより、新しい適切な環境をロードし、多くのアプリで Shotgun メニューのメニュー項目を有効にできます。 +[{% include product %} Workfiles アプリ](https://support.shotgunsoftware.com/hc/ja/articles/219033088)を使用すると、作業するアセット、ショット、またはタスクを選択できます。これにより、新しい適切な環境をロードし、多くのアプリで {% include product %} メニューのメニュー項目を有効にできます。 **既定の Maya アセット タスク アクション:** -![Shotgun メニューのプロジェクト アクション](images/shotgun-menu-asset-step-actions.png) +![{% include product %} メニューのプロジェクト アクション](images/shotgun-menu-asset-step-actions.png) 環境が正しいにもかかわらずアクションが表示されない場合は、関連する[ログ](where-are-my-log-files.md)を調べ、エラーがないかどうかを確認します。完全な出力を取得するには、[デバッグ ログを有効に](turn-debug-logging-on.md)しなければならない可能性があります。 \ No newline at end of file diff --git a/docs/ja/quick-answers/troubleshooting/nuke-path-environment-variable.md b/docs/ja/quick-answers/troubleshooting/nuke-path-environment-variable.md index d721c1f08..cbe39526d 100644 --- a/docs/ja/quick-answers/troubleshooting/nuke-path-environment-variable.md +++ b/docs/ja/quick-answers/troubleshooting/nuke-path-environment-variable.md @@ -9,7 +9,7 @@ lang: ja 当社の統合では Nuke の起動時に `NUKE_PATH` 環境変数が設定され、Nuke の起動プロセス中にブートストラップ スクリプトが実行されます。[`before_launch_app.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/6a884aa144851148e8369e9f35a2471087f98d16/hooks/before_app_launch.py) フックを実行する前に `NUKE_PATH` を明示的に定義するのは [`tk-multi-launchapp`](https://support.shotgunsoftware.com/hc/ja/articles/219032968-Application-Launcher#Set%20Environment%20Variables%20and%20Automate%20Behavior%20at%20Launch) です。 -起動プロセス中に `os.environ['NUKE_PATH'] = "/my/custom/path"` などを使用してこの環境変数を設定している場合、Shotgun の統合は開始されません。これは、起動スクリプトのパスを環境変数から削除したためです。 +起動プロセス中に `os.environ['NUKE_PATH'] = "/my/custom/path"` などを使用してこの環境変数を設定している場合、{% include product %} の統合は開始されません。これは、起動スクリプトのパスを環境変数から削除したためです。 この機能を `tank.util` で使用すると、Toolkit ブートストラップへのパスを維持しながら、パスが環境変数 `NUKE_PATH` またはその先頭に追加されます。 diff --git a/docs/ja/quick-answers/troubleshooting/performance-troubleshooting.md b/docs/ja/quick-answers/troubleshooting/performance-troubleshooting.md index 2d5e85321..cab87aff1 100644 --- a/docs/ja/quick-answers/troubleshooting/performance-troubleshooting.md +++ b/docs/ja/quick-answers/troubleshooting/performance-troubleshooting.md @@ -7,14 +7,14 @@ lang: ja # パフォーマンスのトラブルシューティング -Toolkit の使用速度が低下することがあります。速度が低下する理由はさまざまです。サーバ速度やインターネット接続などのクライアント側インフラストラクチャの問題、Toolkit や Shotgun が高いパフォーマンスで実行されるように設定されていない設定ベースの問題、さらに最適化を行う余地があるコード上の問題などがあります。 +Toolkit の使用速度が低下することがあります。速度が低下する理由はさまざまです。サーバ速度やインターネット接続などのクライアント側インフラストラクチャの問題、Toolkit や {% include product %} が高いパフォーマンスで実行されるように設定されていない設定ベースの問題、さらに最適化を行う余地があるコード上の問題などがあります。 次に、チェック項目のクイック リストを示します。これらのチェック項目については、以下で詳細に説明します。 -- アプリ、エンジン、フレームワーク、コア、Shotgun Desktop が[最新](#keeping-up-to-date)であることを確認します。 +- アプリ、エンジン、フレームワーク、コア、{% include product %} Desktop が[最新](#keeping-up-to-date)であることを確認します。 - 一般的な用途のときに[デバッグ ログ](./turn-debug-logging-on.md)が無効になっていることを確認します。 - [必要なフォルダのみを作成](#folder-creation-is-slow)し、フォルダ数を制限して、実際に必要な場合に限りフォルダが作成されるようにします。スキーマにフォルダを追加しすぎると、速度が低下します。 -- サーバにユーザ キャッシュを保存する、速度が低下することがあります。ユーザの Shotgun キャッシュをリダイレクトするには、ローカル ドライブ上の場所を指定するように [ `SHOTGUN_HOME`環境変数](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)を設定します。 +- サーバにユーザ キャッシュを保存する、速度が低下することがあります。ユーザの {% include product %} キャッシュをリダイレクトするには、ローカル ドライブ上の場所を指定するように [ `{% include product %}_HOME`環境変数](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)を設定します。 - アーティストが必要としていないコンテンツを除外するように、[作業ファイルおよびローダー アプリを設定](#file-open-file-save-or-the-loader-app-is-slow)します。ステータスを基準とするフィルタを実行して、エンティティ リストを短くし、アーティストの現在のタスクに関連するエントリが表示されるようにします。 - カスタム フックの有無を調べて、追加のオーバーヘッドがないか確認します。 @@ -40,13 +40,13 @@ Toolkit の使用速度が低下することがあります。速度が低下す ### キャッシュの場所 -Shotgun Toolkit は[データをユーザのホーム ディレクトリにキャッシュします](../administering/where-is-my-cache.md)。このキャッシュには、さまざまな SQLite データベース、およびキャッシュされたアプリと設定を含めることができます。通常、ユーザのホーム ディレクトリはマシンのローカル ハード ドライブに保存されますが、スタジオでは、ネットワーク上のストレージにこれらをリダイレクトすることが一般的に行われています。この方法の場合、パフォーマンスが低下することがあります。特に大きな影響を受けるのが、ブラウザの統合やフォルダの作成/検索に使用される SQLite データベースです。 +{% include product %} Toolkit は[データをユーザのホーム ディレクトリにキャッシュします](../administering/where-is-my-cache.md)。このキャッシュには、さまざまな SQLite データベース、およびキャッシュされたアプリと設定を含めることができます。通常、ユーザのホーム ディレクトリはマシンのローカル ハード ドライブに保存されますが、スタジオでは、ネットワーク上のストレージにこれらをリダイレクトすることが一般的に行われています。この方法の場合、パフォーマンスが低下することがあります。特に大きな影響を受けるのが、ブラウザの統合やフォルダの作成/検索に使用される SQLite データベースです。 -ユーザ ディレクトリがサーバ上の場所に保存されている場合は、[ `SHOTGUN_HOME`環境変数](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)を使用して、Shotgun Toolkit のキャッシュのパスを再設定することをお勧めします。`SHOTGUN_HOME` 環境変数は、データおよびその他の項目の高速検索に使用されるバンドル キャッシュ、サムネイル、SQLite データベースなど、Toolkit がさまざまなデータをキャッシュする場所を設定する際に使用されます。 +ユーザ ディレクトリがサーバ上の場所に保存されている場合は、[ `{% include product %}_HOME`環境変数](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)を使用して、{% include product %} Toolkit のキャッシュのパスを再設定することをお勧めします。`{% include product %}_HOME` 環境変数は、データおよびその他の項目の高速検索に使用されるバンドル キャッシュ、サムネイル、SQLite データベースなど、Toolkit がさまざまなデータをキャッシュする場所を設定する際に使用されます。 ### デバッグ -Shotgun Toolkit でデバッグ ログを有効にして、さまざまなプロセスから詳細な出力を取得することができます。このようにすると、問題を診断するときに非常に便利です。ただし、デバッグ設定は、通常の日常的な用途のときは有効にならないように設計されています。ログの出力量が増えると、パフォーマンスが大幅に低下することがあります。 +{% include product %} Toolkit でデバッグ ログを有効にして、さまざまなプロセスから詳細な出力を取得することができます。このようにすると、問題を診断するときに非常に便利です。ただし、デバッグ設定は、通常の日常的な用途のときは有効にならないように設計されています。ログの出力量が増えると、パフォーマンスが大幅に低下することがあります。 パフォーマンスの問題が発生した場合、特に、特定のマシンやユーザに限定された問題が発生する場合は、最初に[デバッグ ログ](./turn-debug-logging-on.md)が有効になっていないことを確認してください。 @@ -72,21 +72,21 @@ Toolkit の詳細設定は、[一元管理設定と分散設定](https://develop {% include info title="注" content="分散設定に興味はあっても、マシンごとに依存関係をダウンロードすることについて懸念を抱いている場合は、バンドル キャッシュのみを一元管理して、すべてのユーザで共有することができます。" %} -分散設定を使用している場合、ユーザはキャッシュ内にまだ保存されていないデータのみダウンロードする必要があります。ユーザがデータをダウンロードすると、他のユーザもそのデータを利用できるようになります。このようにするには、共有場所を指定するように各マシンの [ `SHOTGUN_BUNDLE_CACHE_PATH`環境変数](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)を設定します。 +分散設定を使用している場合、ユーザはキャッシュ内にまだ保存されていないデータのみダウンロードする必要があります。ユーザがデータをダウンロードすると、他のユーザもそのデータを利用できるようになります。このようにするには、共有場所を指定するように各マシンの [ `{% include product %}_BUNDLE_CACHE_PATH`環境変数](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)を設定します。 ## ソフトウェアの起動速度が遅い -Maya、Nuke、Houdini などのソフトウェアを起動するときに、Shotgun を使用しない場合に比べて起動時間が長くなることがあります。Shotgun を使用しない場合に比べて起動時間が長くなるのは通常のことですが、これらの時間が許容できないレベルまで増大することがあります(ソフトウェアによって異なりますが、通常は起動時間が 1 分未満であると予測しています)。ソフトウェアの起動には多くのプロセスが関係しているため、この問題を診断するのは面倒なことがあります。 +Maya、Nuke、Houdini などのソフトウェアを起動するときに、{% include product %} を使用しない場合に比べて起動時間が長くなることがあります。{% include product %} を使用しない場合に比べて起動時間が長くなるのは通常のことですが、これらの時間が許容できないレベルまで増大することがあります(ソフトウェアによって異なりますが、通常は起動時間が 1 分未満であると予測しています)。ソフトウェアの起動には多くのプロセスが関係しているため、この問題を診断するのは面倒なことがあります。 ### 診断 最初に行う必要があるのは、この問題が発生する場合の条件を特定することです。 -1. **Shotgun を使用しないで起動したときに低速になりますか?** - 明らかなことかもしれませんが、Shotgun を使用して起動した場合のみ問題が発生することを確認することが重要です。 -2. **起動方法に関係なく低速ですか? つまり、SG Desktop から起動した場合と、ブラウザ統合を使用して SG サイトから起動した場合で違いはありますか?** - Shotgun サイトから起動したときに低速になり、SG Desktop から起動したときに低速にならない場合は、ブラウザ統合に問題があるか、ディスク上にフォルダを作成するときに問題が発生している可能性があります。プロジェクト以外のコンテキストから起動した場合は、ディスク上に作成されるフォルダ数が増える可能性があるため、時間がかかることがあります。また、ソフトウェアが起動されるたびに、必要なフォルダの有無を確認することも重要です。 +1. **{% include product %} を使用しないで起動したときに低速になりますか?** - 明らかなことかもしれませんが、{% include product %} を使用して起動した場合のみ問題が発生することを確認することが重要です。 +2. **起動方法に関係なく低速ですか? つまり、SG Desktop から起動した場合と、ブラウザ統合を使用して SG サイトから起動した場合で違いはありますか?** - {% include product %} サイトから起動したときに低速になり、SG Desktop から起動したときに低速にならない場合は、ブラウザ統合に問題があるか、ディスク上にフォルダを作成するときに問題が発生している可能性があります。プロジェクト以外のコンテキストから起動した場合は、ディスク上に作成されるフォルダ数が増える可能性があるため、時間がかかることがあります。また、ソフトウェアが起動されるたびに、必要なフォルダの有無を確認することも重要です。 3. **すべてのプロジェクトで発生しますか?** - 問題が発生しないプロジェクトがある場合は、設定方法に固有の問題である可能性があります。 4. **1 日の特定の時点で発生しますか?** - 1 日の特定の時点で発生する場合は、1 日の特定の時間帯にサーバ使用量が増大しているなど、インフラストラクチャに対する要求が増加している可能性があります。 5. **使用しているすべてのマシン/OS で発生しますか?** - 特定のマシンの速度が低下する場合、問題の原因は Toolkit の外部にある可能性があります。ただし、最初の手順として、このマシンに Toolkit のキャッシュを作成することをお勧めします。ソフトウェアおよび Python パッケージごとに異なるバージョンの OS が付属していて、特定のバンドルでパフォーマンスの問題が発生することがあります。特に、Windows で Samba (SMB)共有を使用している場合に、パフォーマンスの問題が発生するケースが見られます。このような問題の修正プログラムはありませんが、これを使用する場合にこの問題を認識することが大事です。この問題が特定の OS、Python パッケージ、またはソフトウェア バージョンに限定されていると判断される場合は、[サポート チーム](https://support.shotgunsoftware.com/hc/ja/requests/new)に問い合わせてさらに調査するよう依頼してください。 -6. **すべてのユーザで発生しますか?** - 上記と同様に、同じマシンを使用している別のユーザでは、この問題が発生しないことがあります。この場合は、まずユーザのローカル Shotgun キャッシュをクリアします。また、通常のプロダクションでの用途に対してデバッグ ログが有効になっていないことを確認してください。パフォーマンスが低下しなくなります。 +6. **すべてのユーザで発生しますか?** - 上記と同様に、同じマシンを使用している別のユーザでは、この問題が発生しないことがあります。この場合は、まずユーザのローカル {% include product %} キャッシュをクリアします。また、通常のプロダクションでの用途に対してデバッグ ログが有効になっていないことを確認してください。パフォーマンスが低下しなくなります。 7. **起動速度の低下は特定のアプリ/ソフトウェアに特有のものですか、それともすべてのアプリ/ソフトウェアで起動速度が異常に低下しますか?** - 特定のソフトウェアの起動速度が低下する場合は、設定に問題がある可能性があります。起動の前後に実行されるようにカスタム フックが設定されていて、パフォーマンス低下の原因となっている可能性があるかどうかを確認することをお勧めします。起動時に使用される一般的なフックは [`before_app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/master/hooks/before_app_launch.py)、[`app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/master/hooks/app_launch.py)、およびコア フックの [`engine_init.py`](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/engine_init.py) です。ときどき、新しいバージョンのソフトウェアがリリースされ、Toolkit の統合の起動速度が突然大幅に低下することもあります。このような場合は、[サポート](https://support.shotgunsoftware.com/hc/ja/requests/new)に問い合わせて、この問題が認識されているかどうか、および既知の修正プログラムがあるかどうかを確認する必要があります。使用しているソフトウェア(パッチ/サービス パックが適用可能な場合は、これらを含む)のバージョン番号、および実行している Toolkit エンジンとコアのバージョンをお知らせください。 ### 問題が発生するタイミング(起動前または起動後) @@ -98,13 +98,13 @@ Maya、Nuke、Houdini などのソフトウェアを起動するときに、Shot 通常は、ログを調べなくても、プロセスの最初の手順と 2 番目の手順のどちらでパフォーマンスの問題が発生しているのかを確認できます。 - そのためには、ソフトウェアのスプラッシュ画面を観察して、この画面の起動時間が長いかを確認します。スプラッシュ画面の起動時間が長い場合は、問題が最初の手順で発生している可能性があります。 -- また、ソフトウェアの起動時間が比較的短いにもかかわらず、初期化が終了して Shotgun メニューが表示された後に速度が低下することがあります。この場合は、2 番目の手順で問題が発生しています。 +- また、ソフトウェアの起動時間が比較的短いにもかかわらず、初期化が終了して {% include product %} メニューが表示された後に速度が低下することがあります。この場合は、2 番目の手順で問題が発生しています。 この情報を把握しておくと、この次の作業でログを確認する際に役立ちます。 ### ログを調べる -起動の最初の手順または 2 番目の手順のどちらで問題が発生しているのかを確認したら、調査対象のログを特定することができます。ログはエンジンごとに分かれているため、問題が起動前の段階で発生している可能性がある場合は、SG Desktop から起動しているのか、それとも SG サイトから起動しているのかに応じて、`tk-desktop.log` または `tk-shotgun.log` を調べる必要があります。 +起動の最初の手順または 2 番目の手順のどちらで問題が発生しているのかを確認したら、調査対象のログを特定することができます。ログはエンジンごとに分かれているため、問題が起動前の段階で発生している可能性がある場合は、SG Desktop から起動しているのか、それとも SG サイトから起動しているのかに応じて、`tk-desktop.log` または `tk-{% include product %}.log` を調べる必要があります。 次に、デバッグ ログを有効にする必要があります。{% include info title="注" content="デバッグ ログが既に有効になっている場合は、[上記のとおり](#debugging)、これが動作低下の原因になっていることがあるため、デバッグ ログを有効にしないでテストしてください。" %} デバッグ ログを有効にしたら、既存のログをクリアして、起動プロセスを再現する必要があります。ログ内のタイムスタンプを使用して、時間が急に変化している行を確認します。 @@ -115,14 +115,14 @@ Maya、Nuke、Houdini などのソフトウェアを起動するときに、Shot 2019-05-01 11:28:01,847 [82801 INFO sgtk.env.asset.tk-shotgun.tk-shotgun-folders] 1 Asset processed - Processed 66 folders on disk. -時間が急に変化している場所を特定したら、そのログの行を調べると、その段階で何が起こっていたのかを把握することができます。たとえば、フォルダの作成中や、Shotgun 接続の取得中に問題が発生していることがあります。 +時間が急に変化している場所を特定したら、そのログの行を調べると、その段階で何が起こっていたのかを把握することができます。たとえば、フォルダの作成中や、{% include product %} 接続の取得中に問題が発生していることがあります。 ただし、ログを参照するのは面倒な作業であり、内容に意味があるとは限らないため、[サポート](https://support.shotgunsoftware.com/hc/ja/requests/new)に問い合わせて、この作業のサポートを依頼することができます。 ### ソフトウェアの起動速度が低下する一般的な原因 |-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **インターネットの速度低下** | Toolkit のほぼあらゆる使用状況において Shotgun サイトに接続して通信する必要がありますが、インターネットの速度が低下すると、この動作が影響を受けます。この場合は通常、ソフトウェアの起動だけでなく、他の状況においても、速度に関する問題が発生します。ただし、接続速度が低下するのではなく、接続が不安定になる場合は、起動時にパフォーマンスの問題が生じる可能性があります(大量の Shotgun 通信がプロセスを通して行われるためです)。 | +| **インターネットの速度低下** | Toolkit のほぼあらゆる使用状況において {% include product %} サイトに接続して通信する必要がありますが、インターネットの速度が低下すると、この動作が影響を受けます。この場合は通常、ソフトウェアの起動だけでなく、他の状況においても、速度に関する問題が発生します。ただし、接続速度が低下するのではなく、接続が不安定になる場合は、起動時にパフォーマンスの問題が生じる可能性があります(大量の {% include product %} 通信がプロセスを通して行われるためです)。 | | **サーバ アクセス速度の低下** | この問題は確実に起動時間に影響します。[一元管理設定](#centralized-configs-vs-distributed-configs)を使用している(設定が中央サーバに保存されている)場合は、設定ファイルを読み取るときに大量の I/O が発生することがあります。特に、ソフトウェアを起動すると、起動時の状況に応じてフォルダが作成されます。つまり、フォルダが作成されているかどうかが確認され、作成されていなければ作成されます。 | | **フォルダの作成** | 上記のように、フォルダ作成が速度低下の一般的な原因になることがあります。[詳細については、以下のフォルダ作成時のパフォーマンスに関するトラブルシューティングを参照してください。](#folder-creation-is-slow) | @@ -201,7 +201,7 @@ sgtk.create_filesystem_structure(entity["type"], entity["id"], engine="publish") ### フォルダを登録する -フォルダ作成プロセス中にフォルダが[登録](../administering/what-is-path-cache.md)されるため、後でコンテキストを調べる際に登録されたパスを使用することができます。[上記のように](#folder-creation-is-slow)、この処理中に、レジストリが保存されている一元的な場所である Shotgun サイトと通信する必要があります。ただし、ツールによる高速検索を有効にするために、これらのレジストリもローカルにキャッシュされます。 +フォルダ作成プロセス中にフォルダが[登録](../administering/what-is-path-cache.md)されるため、後でコンテキストを調べる際に登録されたパスを使用することができます。[上記のように](#folder-creation-is-slow)、この処理中に、レジストリが保存されている一元的な場所である {% include product %} サイトと通信する必要があります。ただし、ツールによる高速検索を有効にするために、これらのレジストリもローカルにキャッシュされます。 #### SQLite データベース diff --git a/docs/ja/quick-answers/troubleshooting/turn-debug-logging-on.md b/docs/ja/quick-answers/troubleshooting/turn-debug-logging-on.md index 41740af0c..cc631ad95 100644 --- a/docs/ja/quick-answers/troubleshooting/turn-debug-logging-on.md +++ b/docs/ja/quick-answers/troubleshooting/turn-debug-logging-on.md @@ -7,13 +7,13 @@ lang: ja # デバッグ ログをオフにするにはどうすればいいですか? -## Shotgun Desktop によるデバッグを有効にする +## {% include product %} Desktop によるデバッグを有効にする -デバッグを有効にする最も簡単な方法は、Shotgun Desktop アプリを使用してオンに切り替えることです。これは、Shotgun Desktop にログインした後で設定できます。アプリの右下にあるプロファイル画像をクリックして、**[Advanced] -> [Toggle Debug Logging]**を選択します。この設定はセッションの終了後も維持されるため、デバッグが終了したら忘れずにオフにしてください。 +デバッグを有効にする最も簡単な方法は、{% include product %} Desktop アプリを使用してオンに切り替えることです。これは、{% include product %} Desktop にログインした後で設定できます。アプリの右下にあるプロファイル画像をクリックして、**[Advanced] -> [Toggle Debug Logging]**を選択します。この設定はセッションの終了後も維持されるため、デバッグが終了したら忘れずにオフにしてください。 ![SG Desktop でのデバッグ ログの切り替え](images/desktop-enable-debug-logging.png) -デバッグをオンにすると、Shotgun Desktop から起動されたアプリ、またはブラウザ統合を介した Toolkit コマンドも、このデバッグ状態を継承することに注意してください。 +デバッグをオンにすると、{% include product %} Desktop から起動されたアプリ、またはブラウザ統合を介した Toolkit コマンドも、このデバッグ状態を継承することに注意してください。 ## 環境変数をセットアップする diff --git a/docs/ja/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md b/docs/ja/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md index 57a998e24..b4e6ffc68 100644 --- a/docs/ja/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md +++ b/docs/ja/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md @@ -9,13 +9,13 @@ lang: ja ## どんな問題がありますか? -After Effects 統合のリリースに伴い、Shotgun と統合されるすべての Adobe アプリで使用できる共通プラグインが用意されました。この変更の一環として、以前の Photoshop 統合との後方互換性を保ち、スタジオが更新プログラムに正しく移行できるようにするため、機能拡張の名前を変更する必要がありました。 +After Effects 統合のリリースに伴い、{% include product %} と統合されるすべての Adobe アプリで使用できる共通プラグインが用意されました。この変更の一環として、以前の Photoshop 統合との後方互換性を保ち、スタジオが更新プログラムに正しく移行できるようにするため、機能拡張の名前を変更する必要がありました。 -これは残念ながら、アップグレード時に 2 つの Shotgun 機能拡張がインストールされる可能性があることも意味します。 +これは残念ながら、アップグレード時に 2 つの {% include product %} 機能拡張がインストールされる可能性があることも意味します。 -![Photoshop メニューに複数の Shotgun 機能拡張が表示される](./images/photoshop-extension-panel.png) +![Photoshop メニューに複数の {% include product %} 機能拡張が表示される](./images/photoshop-extension-panel.png) -**Shotgun Adobe Panel** が新しい機能拡張であり、`v1.7.0` 以降の Photoshop 統合を使用している場合にはこちらを使用する必要があります。 +**{% include product %} Adobe Panel** が新しい機能拡張であり、`v1.7.0` 以降の Photoshop 統合を使用している場合にはこちらを使用する必要があります。 ## エラーの修正方法 @@ -24,7 +24,7 @@ After Effects 統合のリリースに伴い、Shotgun と統合されるすべ - `~/Library/Application Support/Adobe/CEP/extensions/com.sg.basic.ps`OSX: - Windows: `%AppData%\Adobe\CEP\extensions\com.sg.basic.ps` -![Photoshop メニューに複数の Shotgun 機能拡張が表示される](./images/shotgun-desktop-console-photoshop-extension.png) +![Photoshop メニューに複数の {% include product %} 機能拡張が表示される](./images/shotgun-desktop-console-photoshop-extension.png) Photoshop を終了してそのディレクトリを削除すると、再起動時の拡張拡張は 1 つだけになります。 diff --git a/docs/ja/quick-answers/troubleshooting/where-are-my-log-files.md b/docs/ja/quick-answers/troubleshooting/where-are-my-log-files.md index 02515c8e2..8ad4e3f0e 100644 --- a/docs/ja/quick-answers/troubleshooting/where-are-my-log-files.md +++ b/docs/ja/quick-answers/troubleshooting/where-are-my-log-files.md @@ -7,7 +7,7 @@ lang: ja # ログ ファイルはどこにありますか? -既定では、Shotgun Desktop および Shotgun の統合は、ログ ファイルを次のディレクトリに保存します。 +既定では、{% include product %} Desktop および {% include product %} の統合は、ログ ファイルを次のディレクトリに保存します。 **Mac** @@ -23,6 +23,6 @@ lang: ja ログ ファイル名の形式は `tk-.log` です。例として `tk-desktop.log` や `tk-maya.log` があります。 -ユーザのキャッシュの場所をオーバーライドするように [`SHOTGUN_HOME` 環境変数](http://developer.shotgunsoftware.com/tk-core/utils.html#localfilestoragemanager)を設定している場合、ログ ファイルは次の場所にあります。`$SHOTGUN_HOME/logs` +ユーザのキャッシュの場所をオーバーライドするように [`{% include product %}_HOME` 環境変数](http://developer.shotgunsoftware.com/tk-core/utils.html#localfilestoragemanager)を設定している場合、ログ ファイルは次の場所にあります。`$SHOTGUN_HOME/logs` {% include info title="注" content="Shotgun Desktop からこのディレクトリにアクセスすることもできます。プロジェクトを選択し、プロジェクト名の右側にある下矢印ボタンをクリックして、**[Open Log Folder]**を選択します。"%} diff --git a/docs/ja/quick-answers/workflow/version-publishedfile-difference.md b/docs/ja/quick-answers/workflow/version-publishedfile-difference.md index 1da0511d6..8b4a23eba 100644 --- a/docs/ja/quick-answers/workflow/version-publishedfile-difference.md +++ b/docs/ja/quick-answers/workflow/version-publishedfile-difference.md @@ -7,9 +7,9 @@ lang: ja # バージョンと Published File の違いは何ですか? -「**パブリッシュ**」は、アプリケーション内で使用可能なディスク上のファイル(またはイメージ シーケンス)またはデータを表します。これには、exr シーケンス、abc、Maya ファイルなどがあります。パブリッシュは Shotgun の `PublishedFile` エンティティによって表されます。 +「**パブリッシュ**」は、アプリケーション内で使用可能なディスク上のファイル(またはイメージ シーケンス)またはデータを表します。これには、exr シーケンス、abc、Maya ファイルなどがあります。パブリッシュは {% include product %} の `PublishedFile` エンティティによって表されます。 -「**バージョン**」(Shotgun の `Version` エンティティ)はパブリッシュの視覚表現で、レビューやノートの作成に使用されます。`Version` エンティティ上に Published Files という名前のフィールドがあり、互いに接続する任意の数のパブリッシュ レコードを入力することができます。このフィールドを使用して、パブリッシュ グループに関連付けられているレビュー `Version` をトラックできます。パブリッシュ時にこの関係を設定することをお勧めします。バージョンは Shotgun の `Version` エンティティによって表されます。 +「**バージョン**」({% include product %} の `Version` エンティティ)はパブリッシュの視覚表現で、レビューやノートの作成に使用されます。`Version` エンティティ上に Published Files という名前のフィールドがあり、互いに接続する任意の数のパブリッシュ レコードを入力することができます。このフィールドを使用して、パブリッシュ グループに関連付けられているレビュー `Version` をトラックできます。パブリッシュ時にこの関係を設定することをお勧めします。バージョンは {% include product %} の `Version` エンティティによって表されます。 究極的には、ファイル形式は異なるが実際は同じコンテンツを表す(Maya ファイル、obj、alembic などの)一連のファイルをパブリッシュ時に生成できることが理想です。これらのファイルは、同じ内容をすべて異なる形式で表現しています。その後、パブリッシュ データをプレビューしてノートを作成するために、1 つのレビュー `Version` に関連付けます。 diff --git a/docs/ja/reference/pipeline-integrations/env-config-ref.md b/docs/ja/reference/pipeline-integrations/env-config-ref.md index ab042c6bc..640c4cb6e 100644 --- a/docs/ja/reference/pipeline-integrations/env-config-ref.md +++ b/docs/ja/reference/pipeline-integrations/env-config-ref.md @@ -15,7 +15,7 @@ Toolkit パイプラインの中心にあるのは環境設定です。Toolkit ## 環境について -Shotgun Toolkit プラットフォームは、一般的に使用されるコンテンツ作成ソフトウェアのための完全にカスタマイズ可能な統合セットを提供するため、これを使用してスタジオのパイプラインを構築できます。プロジェクトの構成において、統合されているソフトウェア パッケージはどれか、そのそれぞれで利用可能な Toolkit アプリはどれかを指定し、さらに各アプリのオプションを指定することにより、スタジオのニーズに合わせてアーティストのワークフローを構築できます。 +{% include product %} Toolkit プラットフォームは、一般的に使用されるコンテンツ作成ソフトウェアのための完全にカスタマイズ可能な統合セットを提供するため、これを使用してスタジオのパイプラインを構築できます。プロジェクトの構成において、統合されているソフトウェア パッケージはどれか、そのそれぞれで利用可能な Toolkit アプリはどれかを指定し、さらに各アプリのオプションを指定することにより、スタジオのニーズに合わせてアーティストのワークフローを構築できます。 しかし、スタジオのパイプラインでは、さまざまなタイプのアーティストが異なるワークフローを使用するのが一般的です。簡単な例として、アセットを扱うアーティストの場合は Mari などのテクスチャ ペイント ソフトウェアを利用可能にし、ショットを扱うアーティストの場合は Nuke などの合成ソフトウェアを利用可能にします。 @@ -107,7 +107,7 @@ engines: ### ロケーション ディスクリプタ -すべての Toolkit バンドルには `location` 設定があり、これをバンドルの**「ディスクリプタ」と呼びます。ディスクリプタは、特定のバンドルの入手元、およびそのタイプに応じて直接アクセスするかローカルにキャッシュするかを Toolkit に指示します。Toolkit バンドルを入手できる場所の例としては、Shotgun App Store、GIT リポジトリ、ディスク上のパス、または Shotgun サイトにアップロードされた zip ファイルなどがあります。これらには、それぞれ対応するディスクリプタ タイプがあり、そのタイプに固有の設定があります。以下に、上記の例の `tk-maya` エンジンのディスクリプタをもう一度示します。 +すべての Toolkit バンドルには `location` 設定があり、これをバンドルの**「ディスクリプタ」と呼びます。ディスクリプタは、特定のバンドルの入手元、およびそのタイプに応じて直接アクセスするかローカルにキャッシュするかを Toolkit に指示します。Toolkit バンドルを入手できる場所の例としては、{% include product %} App Store、GIT リポジトリ、ディスク上のパス、または {% include product %} サイトにアップロードされた zip ファイルなどがあります。これらには、それぞれ対応するディスクリプタ タイプがあり、そのタイプに固有の設定があります。以下に、上記の例の `tk-maya` エンジンのディスクリプタをもう一度示します。 ```yaml location: @@ -116,7 +116,7 @@ engines: version: v0.9.4 ``` -これはタイプ `app_store` のディスクリプタで、指定されたバンドルを Shotgun App Store から入手するよう Toolkit に指示します。タイプ `app_store` のディスクリプタの設定は `name` と `version` です。 +これはタイプ `app_store` のディスクリプタで、指定されたバンドルを {% include product %} App Store から入手するよう Toolkit に指示します。タイプ `app_store` のディスクリプタの設定は `name` と `version` です。 対照的に、スタジオでカスタム バンドルをアクティブに開発している場合、たとえば特定のワークフロー用の Toolkit アプリを作成している場合は、ディスク上のパスから直接入手することができます。この場合、以下に示すようにタイプ `dev` のディスクリプタを使用します。 diff --git a/docs/ja/shotgun.md b/docs/ja/shotgun.md index 043717106..5b35a7224 100644 --- a/docs/ja/shotgun.md +++ b/docs/ja/shotgun.md @@ -5,13 +5,13 @@ pagename: shotgun-index lang: ja --- -# Shotgun の開発 +# {% include product %} の開発 プロダクション管理では、すべての個別の要素を同期させる必要があるため、多大な労力を必要とします。 -データに直接接続するには、Shotgun REST API または Python API を使用します。反復的なタスクを自動化するにはイベント トリガ フレームワーク、Shotgun の Web インタフェースからアプリを直接起動するにはアクション メニュー アイテムを使用します。 +データに直接接続するには、{% include product %} REST API または Python API を使用します。反復的なタスクを自動化するにはイベント トリガ フレームワーク、{% include product %} の Web インタフェースからアプリを直接起動するにはアクション メニュー アイテムを使用します。 -独自のサービスまたは許可されたユーザ用のサービスを基に動作する、または一緒に動作するサービス、アプリケーション、モジュール、およびコンポーネントを独自に開発するには、Shotgun API を使用することをお勧めします。 +独自のサービスまたは許可されたユーザ用のサービスを基に動作する、または一緒に動作するサービス、アプリケーション、モジュール、およびコンポーネントを独自に開発するには、{% include product %} API を使用することをお勧めします。 {% include warning title="認証キー" content="オートデスクからユーザのみなさまにお願いしたいことは、API 情報を開示しないこと(および許可されたユーザに開示を許可しないこと)ことのみです。ユーザは API 情報に含まれている認証キーなどを使用することで、ログオンしなくても、サービスやその機能にアクセスできるようになります。また、ログオンすることなくサービスまたはその機能にアクセスできる権限を、API を使用して自分自身に与えることや、ユーザに与えることも行わないでください。"%} diff --git a/docs/ja/toolkit.md b/docs/ja/toolkit.md index b487f5439..a0c199adc 100644 --- a/docs/ja/toolkit.md +++ b/docs/ja/toolkit.md @@ -7,7 +7,7 @@ lang: ja # Toolkit プラットフォーム -Toolkit は、アーティスト向けアプリケーションおよびパイプライン ツールを Shotgun と統合するための拡張可能なプラットフォームです。 +Toolkit は、アーティスト向けアプリケーションおよびパイプライン ツールを {% include product %} と統合するための拡張可能なプラットフォームです。 Toolkit のコア API は、すべての統合を構築するためのプラットフォームです。Core API は、アプリケーション、エンジンおよびプラットフォームの基本、ファイル システムの整理とツールの配置を処理します。 diff --git a/docs/ko/contribution.md b/docs/ko/contribution.md index 77720ba1c..5d6581095 100644 --- a/docs/ko/contribution.md +++ b/docs/ko/contribution.md @@ -7,7 +7,7 @@ lang: ko # 기여 가이드 -가능한 모든 사항을 공개하려는 노력의 일환으로 Autodesk Shotgun 팀에서는 [Creative Commons 라이센스](https://github.com/shotgunsoftware/developer-beta/blob/master/LICENSE.md)에 따라 공용 리포지토리에 개발자 문서를 올리기로 했습니다. 이 문서를 더 효율적으로 작성할 수 있는 방법을 아신다면 개선 사항과 함께 리포지토리에 대한 pull 요청을 주십시오. pull 요청을 수락하기 위해서는 다음 기여자 계약서 중 하나에 서명하여 보내 주셔야 합니다. +가능한 모든 사항을 공개하려는 노력의 일환으로 Autodesk {% include product %} 팀에서는 [Creative Commons 라이센스](https://github.com/shotgunsoftware/developer-beta/blob/master/LICENSE.md)에 따라 공용 리포지토리에 개발자 문서를 올리기로 했습니다. 이 문서를 더 효율적으로 작성할 수 있는 방법을 아신다면 개선 사항과 함께 리포지토리에 대한 pull 요청을 주십시오. pull 요청을 수락하기 위해서는 다음 기여자 계약서 중 하나에 서명하여 보내 주셔야 합니다. - [개인 기여 계약서](../all_langs/contribution/ind_contrib_agmt_for_shotgun_developer_documentation.pdf) - [기업 기여 계약서](../all_langs/contribution/corp_contrib_agmt_for_shotgun_developer_documentation.pdf) diff --git a/docs/ko/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md b/docs/ko/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md index 24a9d85c8..fd17fcc78 100644 --- a/docs/ko/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md +++ b/docs/ko/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md @@ -10,19 +10,19 @@ lang: ko ## Auto updates ### What parts auto update? -By default Shotgun Desktop will automatically check for updates, and install them to the local machine if it finds any. +By default {% include product %} Desktop will automatically check for updates, and install them to the local machine if it finds any. It checks for updates on two components: -- `tk-framework-desktopstartup` - A frame work which aids the launch of Shotgun Desktop. +- `tk-framework-desktopstartup` - A frame work which aids the launch of {% include product %} Desktop. - `tk-config-basic` - The default site config. -The configuration acts as a manifest for the versions of the apps, engines, frameworks, and core version that should be used by Shotgun Desktop. +The configuration acts as a manifest for the versions of the apps, engines, frameworks, and core version that should be used by {% include product %} Desktop. By updating the config, you are potentially updating any of these components as well. -Any updates that are found are downloaded and stored in the user's local cache, rather than modifying the original Shotgun Desktop installed files. +Any updates that are found are downloaded and stored in the user's local cache, rather than modifying the original {% include product %} Desktop installed files. -Shotgun Create as an application has it's own update mechanism separate from Shotgun Desktop which is not covered here. -However the integration features provided in Shotgun Create work in a similar way, and will also auto update `tk-config-basic` into the same user cache. +{% include product %} Create as an application has it's own update mechanism separate from {% include product %} Desktop which is not covered here. +However the integration features provided in {% include product %} Create work in a similar way, and will also auto update `tk-config-basic` into the same user cache. ### What doesn't auto update? @@ -44,12 +44,12 @@ The following sections describes how to address each of these scenarios. ### Initial Setup If your studio has restricted internet access or no internet access then you will need to ensure that you have all the required parts cached locally. -You will still need one machine that can connect to the internet in order to download Shotgun Create or Shotgun Desktop. +You will still need one machine that can connect to the internet in order to download {% include product %} Create or {% include product %} Desktop. -Shotgun Create and Shotgun Desktop come prepackaged with all the dependencies required to run the basic integrations. -When you start either of them up, it will automatically try to look for updates, but if it cannot connect to the Shotgun App Store, it will simply run the most recent version that exists locally. +{% include product %} Create and {% include product %} Desktop come prepackaged with all the dependencies required to run the basic integrations. +When you start either of them up, it will automatically try to look for updates, but if it cannot connect to the {% include product %} App Store, it will simply run the most recent version that exists locally. -It is recommended that you follow the "Managing updates" steps bellow after installing Shotgun Desktop, as the components bundled with the installer may not be the latest. +It is recommended that you follow the "Managing updates" steps bellow after installing {% include product %} Desktop, as the components bundled with the installer may not be the latest. {% include info title="Note" content="Depending on your network setup, it can sometimes get stuck looking for updates online even though it won't be able to access them. In this situation you can set the environment variable `SHOTGUN_DISABLE_APPSTORE_ACCESS` to `\"1\"` to stop it from trying." %} @@ -63,7 +63,7 @@ To update the `tk-framework-desktopstartup` component, you will need to [downloa For the `tk-config-basic` component it's a bit more tricky, due to all its dependencies. -1. Run Shotgun Desktop on a workstation connected to the internet. When it starts up, the latest upgrades will be automatically downloaded. +1. Run {% include product %} Desktop on a workstation connected to the internet. When it starts up, the latest upgrades will be automatically downloaded. (Ensure `SHOTGUN_DISABLE_APPSTORE_ACCESS` is not set on this machine.) 2. Copy the bundle cache to a shared location where all machines can access it. 3. Set the `SHOTGUN_BUNDLE_CACHE_FALLBACK_PATHS` environment variable on offline machines to point to this location. @@ -79,14 +79,14 @@ In this situation you can set the environment variable `SHOTGUN_DISABLE_APPSTORE ### Disabling updates for a single project 1. Determine the version you want to lock your project to. You can find the integration releases [here](https://support.shotgunsoftware.com/hc/en-us/sections/115000020494-Integrations). -2. In Shotgun, create a Pipeline Configuration entity for the project you want to lock down, with the following fields populated (In this example, we are locking down the config to use v1.0.36 of the integrations): +2. In {% include product %}, create a Pipeline Configuration entity for the project you want to lock down, with the following fields populated (In this example, we are locking down the config to use v1.0.36 of the integrations): - Name: `Primary` - Project: The project you want to lock down - Plugin ids: `basic.*` - Descriptor: `sgtk:descriptor:app_store?name=tk-config-basic&version=v1.0.36` ![Pipeline Configuration entity with a setup for a project with disabled updates.](images/offline-and-disabled-auto-updates/freeze_single_project.png) -3. Anyone starting Shotgun Desktop on the project will now always use `v1.0.36`. Any new users starting to work on the project will also get `v1.0.36`. +3. Anyone starting {% include product %} Desktop on the project will now always use `v1.0.36`. Any new users starting to work on the project will also get `v1.0.36`. #### Good to know @@ -141,7 +141,7 @@ Note that you’ve omitted the version number from the Descriptor field for the Scenario: We’re locked down to v1.0.0, and we’d like to upgrade to v2.0.0, but first I want to test out the new version before deploying it to the studio.* Solution -Duplicate the Pipeline Configuration entity in Shotgun by right-clicking on it and selecting "Duplicate Selected". +Duplicate the Pipeline Configuration entity in {% include product %} by right-clicking on it and selecting "Duplicate Selected". Name the cloned config “update test”, and assign yourself to the User Restrictions field. You will now begin to use this Pipeline Configuration. Change the descriptor to point to the version you wish to test. diff --git a/docs/ko/guides/pipeline-integrations/getting-started/advanced_config.md b/docs/ko/guides/pipeline-integrations/getting-started/advanced_config.md index 6ad2c8aa5..346da00b9 100644 --- a/docs/ko/guides/pipeline-integrations/getting-started/advanced_config.md +++ b/docs/ko/guides/pipeline-integrations/getting-started/advanced_config.md @@ -11,35 +11,35 @@ lang: ko ## 안내서 정보 -이 안내서에서는 Shotgun 데스크톱에서 **고급 프로젝트 설정 마법사**를 사용하여 디지털 컨텐츠 생성 파이프라인의 구성을 생성하는 방법에 대해 설명합니다. 구성 도구에 대해 간단히 살펴보고, 마법사를 사용하는 방법을 설명하며, 자세한 내용을 확인할 수 있는 자료도 제공합니다. 마법사를 사용하면 프로젝트에 대한 파이프라인 구성이 생성되고 파이프라인의 각 단계를 지원하기 위해 편집 및 확장할 수 있는 준비가 이루어집니다. 이 구성은 UI, Shotgun 앱 및 프로덕션 파이프라인을 지원하는 데 필요한 다양한 도구의 여러 측면을 제어합니다. 마법사를 사용하는 것은 구성을 확장하는 한 가지 방법에 불과합니다. 마법사에서는 파이프라인의 각 단계에 설정을 추가하고 소프트웨어 응용프로그램과의 통합도 추가할 수 있습니다. 이 안내서에서는 툴킷의 기본 구성을 기반으로 프로젝트의 구성을 설정할 것입니다. +이 안내서에서는 {% include product %} 데스크톱에서 **고급 프로젝트 설정 마법사**를 사용하여 디지털 컨텐츠 생성 파이프라인의 구성을 생성하는 방법에 대해 설명합니다. 구성 도구에 대해 간단히 살펴보고, 마법사를 사용하는 방법을 설명하며, 자세한 내용을 확인할 수 있는 자료도 제공합니다. 마법사를 사용하면 프로젝트에 대한 파이프라인 구성이 생성되고 파이프라인의 각 단계를 지원하기 위해 편집 및 확장할 수 있는 준비가 이루어집니다. 이 구성은 UI, {% include product %} 앱 및 프로덕션 파이프라인을 지원하는 데 필요한 다양한 도구의 여러 측면을 제어합니다. 마법사를 사용하는 것은 구성을 확장하는 한 가지 방법에 불과합니다. 마법사에서는 파이프라인의 각 단계에 설정을 추가하고 소프트웨어 응용프로그램과의 통합도 추가할 수 있습니다. 이 안내서에서는 툴킷의 기본 구성을 기반으로 프로젝트의 구성을 설정할 것입니다. 이 안내서를 학습하는 사용자는 다음과 같은 준비를 갖추어야 합니다. 1. 고급 프로젝트 설정 마법사를 사용한 적이 없음 -2. Shotgun 사용 방법에 대한 기초적인 지식을 갖추고 있음 -3. Shotgun 툴킷을 처음 접함 +2. {% include product %} 사용 방법에 대한 기초적인 지식을 갖추고 있음 +3. {% include product %} 툴킷을 처음 접함 ### 이 문서 사용 이 안내서를 사용하고 프로젝트에 대해 커스터마이즈 가능한 구성을 생성하려면 다음과 같은 준비가 필요합니다. -1. 유효한 Shotgun 사이트. [여기서 Shotgun에 등록](https://www.shotgunsoftware.com/kr/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management)하면 30일 무료 체험판을 다운로드해 직접 체험해 볼 수 있습니다. -2. Shotgun 데스크톱. 데스크톱이 설치되어 있지 않은 경우 [이 링크를 따라 시작할 수 있습니다.](https://support.shotgunsoftware.com/hc/ko/articles/115000068574-Integrations-user-guide#Installation%20of%20Desktop) +1. 유효한 {% include product %} 사이트. [여기서 {% include product %}에 등록](https://www.shotgunsoftware.com/kr/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management)하면 30일 무료 체험판을 다운로드해 직접 체험해 볼 수 있습니다. +2. {% include product %} 데스크톱. 데스크톱이 설치되어 있지 않은 경우 [이 링크를 따라 시작할 수 있습니다.](https://support.shotgunsoftware.com/hc/ko/articles/115000068574-Integrations-user-guide#Installation%20of%20Desktop) 3. 프로젝트 파일과 파이프라인 구성을 저장할 수 있는 파일 시스템. 파일 시스템에 `Shotgun` 폴더를 생성하고, 이 폴더 안에 `projects` 및 `configs` 폴더를 생성합니다. ## 고급 프로젝트 설정 마법사 정보 -Shotgun 데스크톱의 고급 프로젝트 설정(Advanced Project Setup) 마법사는 기본 구성을 기반으로 파이프라인 구성을 생성합니다. 기본 구성을 사용하면 탄탄한 기초를 토대로 파이프라인 프로세스를 지원하는 커스터마이즈 가능한 설정, 앱 및 UI 요소를 작성할 수 있습니다. 이 마법사를 통해 생성되는 구성은 프로젝트의 파이프라인 요구사항을 충족하도록 편집 및 확장할 수 있습니다. +{% include product %} 데스크톱의 고급 프로젝트 설정(Advanced Project Setup) 마법사는 기본 구성을 기반으로 파이프라인 구성을 생성합니다. 기본 구성을 사용하면 탄탄한 기초를 토대로 파이프라인 프로세스를 지원하는 커스터마이즈 가능한 설정, 앱 및 UI 요소를 작성할 수 있습니다. 이 마법사를 통해 생성되는 구성은 프로젝트의 파이프라인 요구사항을 충족하도록 편집 및 확장할 수 있습니다. 기본 구성에는 다음이 포함됩니다. * 디스크에서 파일이 저장되는 위치를 결정하는 기본 파일 시스템 스키마 및 템플릿 -* 사용자의 소프트웨어 응용프로그램에서 바로 Shotgun 및 파이프라인 기능과 상호 작용할 수 있게 해 주는, 모든 지원되는 [소프트웨어 통합](https://support.shotgunsoftware.com/hc/ko/articles/219039798-Integrations-Apps-and-Engines) +* 사용자의 소프트웨어 응용프로그램에서 바로 {% include product %} 및 파이프라인 기능과 상호 작용할 수 있게 해 주는, 모든 지원되는 [소프트웨어 통합](https://support.shotgunsoftware.com/hc/ko/articles/219039798-Integrations-Apps-and-Engines) -커스터마이즈 수준은 상상력과 기발함, 그리고 프로그래밍 지식 또는 Shotgun 커뮤니티의 다른 사용자가 만든 것을 가져다 쓸 수 있는 능력 등에 따라 달라질 수 있습니다. +커스터마이즈 수준은 상상력과 기발함, 그리고 프로그래밍 지식 또는 {% include product %} 커뮤니티의 다른 사용자가 만든 것을 가져다 쓸 수 있는 능력 등에 따라 달라질 수 있습니다. ### 구성 만들기 -모든 프로젝트에는 구성이 필요합니다. Shotgun 데스크톱을 통해 프로젝트에 처음 액세스하면 기초 구성이 다운로드되고 설정됩니다. 이 기초 구성에서는 사용자의 시스템에서 지원되는 컨텐츠 생성 소프트웨어를 자동으로 탐지하고 구성을 프로젝트와 연결합니다. 지원되는 소프트웨어 응용프로그램 내 통합은 파이프라인 구성의 설정에 의해 제어됩니다. [Panel](https://support.shotgunsoftware.com/hc/ko/articles/219033098-Shotgun-Panel) 앱에는 Shotgun의 프로젝트 정보가 표시되므로 아티스트가 작업 세션을 떠나지 않고도 노트에 회신하고 버전을 볼 수 있습니다. [Publisher](https://support.shotgunsoftware.com/hc/ko/articles/219032998-Publishing-your-work) 앱에서는 자신의 작업물을 팀의 다른 작업자와 공유할 수 있으며 [Loader](https://support.shotgunsoftware.com/hc/ko/articles/219033078-Load-Published-Files-) 앱을 통해서는 팀원이 게시한 파일을 로드할 수 있습니다. 기초 구성에는 파일 시스템 관리 설정이나 파일 및 디렉토리의 디스크 내 명명 방식을 템플릿 개발 등이 포함되지 않습니다. 또한, 기본 구성이 설정될 때 추가되는 다양한 앱도 포함되지 않습니다. 기초 구성은 구성 파일을 직접 편집하지 않고도 툴킷을 바로 실행할 수 있게 해주는 단순한 구성입니다. 이 마법사는 기초 구성을 기본 구성으로 변환합니다. 또한, 사용자의 작업을 지원하기 위해 추가적인 앱과 소프트웨어 통합을 제공합니다. 기초 구성도 편집 가능하기는 하지만, 고급 설정을 통해 프로젝트를 커스터마이즈할 수 있도록 설정할 때까지는 편집할 수 없습니다. +모든 프로젝트에는 구성이 필요합니다. {% include product %} 데스크톱을 통해 프로젝트에 처음 액세스하면 기초 구성이 다운로드되고 설정됩니다. 이 기초 구성에서는 사용자의 시스템에서 지원되는 컨텐츠 생성 소프트웨어를 자동으로 탐지하고 구성을 프로젝트와 연결합니다. 지원되는 소프트웨어 응용프로그램 내 통합은 파이프라인 구성의 설정에 의해 제어됩니다. [Panel](https://support.shotgunsoftware.com/hc/ko/articles/219033098-Shotgun-Panel) 앱에는 {% include product %}의 프로젝트 정보가 표시되므로 아티스트가 작업 세션을 떠나지 않고도 노트에 회신하고 버전을 볼 수 있습니다. [Publisher](https://support.shotgunsoftware.com/hc/ko/articles/219032998-Publishing-your-work) 앱에서는 자신의 작업물을 팀의 다른 작업자와 공유할 수 있으며 [Loader](https://support.shotgunsoftware.com/hc/ko/articles/219033078-Load-Published-Files-) 앱을 통해서는 팀원이 게시한 파일을 로드할 수 있습니다. 기초 구성에는 파일 시스템 관리 설정이나 파일 및 디렉토리의 디스크 내 명명 방식을 템플릿 개발 등이 포함되지 않습니다. 또한, 기본 구성이 설정될 때 추가되는 다양한 앱도 포함되지 않습니다. 기초 구성은 구성 파일을 직접 편집하지 않고도 툴킷을 바로 실행할 수 있게 해주는 단순한 구성입니다. 이 마법사는 기초 구성을 기본 구성으로 변환합니다. 또한, 사용자의 작업을 지원하기 위해 추가적인 앱과 소프트웨어 통합을 제공합니다. 기초 구성도 편집 가능하기는 하지만, 고급 설정을 통해 프로젝트를 커스터마이즈할 수 있도록 설정할 때까지는 편집할 수 없습니다. ### 기초 구성과 기본 구성의 차이점 @@ -51,19 +51,19 @@ Shotgun 데스크톱의 고급 프로젝트 설정(Advanced Project Setup) 마 | 업데이트 | 자동으로 업데이트됨 | 수동으로 업데이트됨 | | 파일 시스템 지원 | 파일 시스템 스키마 지원 안 함 | 폴더 구조와 파일 명명 표준을 지원하는 도구 포함 | | 소프트웨어 통합 | 3ds Max, Houdini, Maya, Nuke, Photoshop, Flame | Basic + Hiero, Motionbulder, Mari | -| 툴킷 앱 | Shotgun Panel, Publisher, Loader | Basic + Workfiles, Snap Shot, Scene Breakdown, Nuke Write Node, Houdini Mantra Node 등 | +| 툴킷 앱 | {% include product %} Panel, Publisher, Loader | Basic + Workfiles, Snap Shot, Scene Breakdown, Nuke Write Node, Houdini Mantra Node 등 | -이 안내서에서는 Shotgun 데스크톱의 마법사를 사용하여 기본 구성을 기반으로 프로젝트의 파이프라인 구성을 생성합니다. 이 구성을 생성하면 자체 프로덕션 파이프라인을 지원하는 데 필요한 커스터마이즈를 수행할 수 있게 됩니다. +이 안내서에서는 {% include product %} 데스크톱의 마법사를 사용하여 기본 구성을 기반으로 프로젝트의 파이프라인 구성을 생성합니다. 이 구성을 생성하면 자체 프로덕션 파이프라인을 지원하는 데 필요한 커스터마이즈를 수행할 수 있게 됩니다. ## 연습 시작 ### 기본 구성 사용 준비 -**1단계:** Shotgun에 "the_other_side"라는 프로젝트를 생성합니다. +**1단계:** {% include product %}에 "the_other_side"라는 프로젝트를 생성합니다. ![새 프로젝트](./images/advanced_config/2_new_project.png) -**2단계:** Shotgun 데스크톱 앱을 실행하고 Shotgun 사이트의 사용자 이름 및 암호를 사용하여 로그인합니다. +**2단계:** {% include product %} 데스크톱 앱을 실행하고 {% include product %} 사이트의 사용자 이름 및 암호를 사용하여 로그인합니다. ![로그인](./images/advanced_config/3_login.png) @@ -77,21 +77,21 @@ Shotgun 데스크톱의 고급 프로젝트 설정(Advanced Project Setup) 마 ### 기본 구성 액세스 -프로젝트에 액세스할 때 기초 구성이 다운로드되고 설정되었습니다. Publish 앱 및 지원되는 소프트웨어 패키지가 탐지되어 Shotgun 데스크톱의 **앱**(Apps) 창에 자동으로 추가되었습니다. +프로젝트에 액세스할 때 기초 구성이 다운로드되고 설정되었습니다. Publish 앱 및 지원되는 소프트웨어 패키지가 탐지되어 {% include product %} 데스크톱의 **앱**(Apps) 창에 자동으로 추가되었습니다. **4단계:** 프로젝트가 로드되면 화면 오른쪽 아래에 있는 프로파일 **아바타**를 선택합니다. 팝업 메뉴에서 **고급 프로젝트 설정…**(Advanced project setup…)을 선택하여 마법사를 시작합니다. ![고급 프로젝트 설정](./images/advanced_config/6_advanced_project_setup.png) -네 개의 옵션이 있고 그중에 Shotgun 기본값(Shotgun Default)이 선택되어 있는 대화상자가 표시됩니다. 여기서 프로젝트의 파이프라인 구성을 기존 프로젝트의 구성, git 리포지토리의 구성, 디스크의 경로 중 무엇을 기반으로 할지 선택할 수 있습니다. +네 개의 옵션이 있고 그중에 {% include product %} 기본값({% include product %} Default)이 선택되어 있는 대화상자가 표시됩니다. 여기서 프로젝트의 파이프라인 구성을 기존 프로젝트의 구성, git 리포지토리의 구성, 디스크의 경로 중 무엇을 기반으로 할지 선택할 수 있습니다. -이 연습에서는 **Shotgun 기본값**(Shotgun Default)을 선택하겠습니다. 이 옵션을 선택하면 Shotgun의 기본 구성을 기반으로 프로젝트의 파이프라인 구성이 생성됩니다. +이 연습에서는 **{% include product %} 기본값**({% include product %} Default)을 선택하겠습니다. 이 옵션을 선택하면 {% include product %}의 기본 구성을 기반으로 프로젝트의 파이프라인 구성이 생성됩니다. ![구성 선택](./images/advanced_config/7_select_config.png) **5단계:** **계속**(Continue)을 선택합니다. -두 개의 옵션이 있고 그중에서 **기본값**(Default)이 선택되어 있는 대화상자가 표시됩니다. 이 대화상자에는 레거시(Legacy) 기본 구성 설정을 선택할 수 있는 옵션이 있습니다. 이 구성 설정은 이전 버전의 Shotgun을 계속 사용하는 스튜디오를 위해 제공되는 이전 버전의 설정입니다. 이 연습에서는 기본값(Default)을 사용하겠습니다. +두 개의 옵션이 있고 그중에서 **기본값**(Default)이 선택되어 있는 대화상자가 표시됩니다. 이 대화상자에는 레거시(Legacy) 기본 구성 설정을 선택할 수 있는 옵션이 있습니다. 이 구성 설정은 이전 버전의 {% include product %}을 계속 사용하는 스튜디오를 위해 제공되는 이전 버전의 설정입니다. 이 연습에서는 기본값(Default)을 사용하겠습니다. ![구성 선택](./images/advanced_config/8_select_config.png) @@ -107,13 +107,13 @@ Shotgun 데스크톱의 고급 프로젝트 설정(Advanced Project Setup) 마 ![저장소 정의](./images/advanced_config/10_define_storage2.png) -Shotgun 툴킷은 세 개의 운영 체제인 Linux, Mac, Windows를 지원합니다. +{% include product %} 툴킷은 세 개의 운영 체제인 Linux, Mac, Windows를 지원합니다. **8단계:** 프로젝트 데이터를 저장하는 데 사용되는 운영 체제 옆에 있는 필드를 선택합니다. 폴더 아이콘을 선택하고 이 연습을 진행하기 전에 파일 시스템에 생성한 프로젝트 폴더로 이동합니다. ![저장소 루트 폴더](./images/advanced_config/11_storage_root_folder.png) -이 설정을 진행하면 프로덕션 데이터 저장 위치로 지정한 폴더에만 Shotgun이 액세스할 수 있게 됩니다. 이 연습의 준비 과정에서 Shotgun 루트 디렉토리에 `projects/` 디렉토리를 추가했습니다. `projects/` 디렉토리는 툴킷이 로컬 프로젝트 관련 정보를 저장할 위치입니다. +이 설정을 진행하면 프로덕션 데이터 저장 위치로 지정한 폴더에만 {% include product %}이 액세스할 수 있게 됩니다. 이 연습의 준비 과정에서 {% include product %} 루트 디렉토리에 `projects/` 디렉토리를 추가했습니다. `projects/` 디렉토리는 툴킷이 로컬 프로젝트 관련 정보를 저장할 위치입니다. ![저장소 정의](./images/advanced_config/12_define_Storage3.png) @@ -131,7 +131,7 @@ Shotgun 툴킷은 세 개의 운영 체제인 Linux, Mac, Windows를 지원합 ![프로젝트 폴더](./images/advanced_config/14_project_folder_name.png) -툴킷은 파이프라인 구성이 Shotgun에 업로드되고 각 사용자에 대해 로컬로 캐시되는 분산 설정이나 사용자가 디스크에서 공유된 위치에 있는 단일 구성에 액세스하는 중앙 집중식 설정에서도 작동할 수 있습니다. 이 연습에서는 중앙 집중식 설정을 사용하겠습니다. [분산 설정에 대한 자세한 내용은 여기서 확인할 수 있습니다](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations). +툴킷은 파이프라인 구성이 {% include product %}에 업로드되고 각 사용자에 대해 로컬로 캐시되는 분산 설정이나 사용자가 디스크에서 공유된 위치에 있는 단일 구성에 액세스하는 중앙 집중식 설정에서도 작동할 수 있습니다. 이 연습에서는 중앙 집중식 설정을 사용하겠습니다. [분산 설정에 대한 자세한 내용은 여기서 확인할 수 있습니다](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations). 마지막 단계에서는 프로젝트와 관련된 구성을 생성하기 위해 적합한 폴더, 파일 및 데이터를 생성합니다. @@ -145,7 +145,7 @@ Shotgun 툴킷은 세 개의 운영 체제인 Linux, Mac, Windows를 지원합 ![설정 완료](./images/advanced_config/17_project_setup_complete.png) -**팁:** Shotgun 데스크톱에 신속하게 액세스하기 위해 메뉴 막대에 앱을 고정할 수 있습니다. 이렇게 하려면 **아바타**를 선택하고 **메뉴에 고정**(Pin to Menu)을 선택하십시오. +**팁:** {% include product %} 데스크톱에 신속하게 액세스하기 위해 메뉴 막대에 앱을 고정할 수 있습니다. 이렇게 하려면 **아바타**를 선택하고 **메뉴에 고정**(Pin to Menu)을 선택하십시오. 다 되었습니다. 프로젝트 설정이 완료되었습니다. 이제 기본 구성을 기반으로 지정한 위치에 프로젝트에 대한 툴킷 파이프라인 구성이 생성되었으므로 커스터마이즈 작업을 시작할 수 있습니다. @@ -157,7 +157,7 @@ Shotgun 툴킷은 세 개의 운영 체제인 Linux, Mac, Windows를 지원합 ## 고급 항목 -Shotgun 툴킷에서는 구성을 간편하게 편집하고 복제하고 가져올 수 있는 방법을 다양하게 제공합니다. 기존의 구성을 확장하면 시간을 절약할 수 있으며 네트워크에 있는 다른 작업자가 만든 모든 멋진 구성을 이용할 수 있습니다. 필요한 구성을 찾기 위해 방대한 Shotgun [커뮤니티](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups&hl=ko#!forum/shotgun-dev)를 활용할 수 있습니다. Shotgun 커뮤니티는 정보를 공유하는 커뮤니티이므로 서로에게 친절하게 대하고, 작업에 도움이 되는 구성을 발견하면 작성자의 공로를 인정하고 감사의 인사를 전해 주시기 바랍니다. 그리고 다른 사람에게 도움이 될 새로운 정보를 게시하는 것도 잊지 마십시오. 이런 식으로 우리는 서로를 도와가며 특별한 커뮤니티를 만들어 가고 있습니다! +{% include product %} 툴킷에서는 구성을 간편하게 편집하고 복제하고 가져올 수 있는 방법을 다양하게 제공합니다. 기존의 구성을 확장하면 시간을 절약할 수 있으며 네트워크에 있는 다른 작업자가 만든 모든 멋진 구성을 이용할 수 있습니다. 필요한 구성을 찾기 위해 방대한 {% include product %} [커뮤니티](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups&hl=ko#!forum/shotgun-dev)를 활용할 수 있습니다. {% include product %} 커뮤니티는 정보를 공유하는 커뮤니티이므로 서로에게 친절하게 대하고, 작업에 도움이 되는 구성을 발견하면 작성자의 공로를 인정하고 감사의 인사를 전해 주시기 바랍니다. 그리고 다른 사람에게 도움이 될 새로운 정보를 게시하는 것도 잊지 마십시오. 이런 식으로 우리는 서로를 도와가며 특별한 커뮤니티를 만들어 가고 있습니다! 다음은 재미있게 구성 관련 작업을 진행할 수 있는 몇 가지 방법입니다. @@ -167,7 +167,7 @@ Shotgun 툴킷에서는 구성을 간편하게 편집하고 복제하고 가져 ### 프로덕션 단계에 적용된 구성 편집 -현재 프로덕션 단계에 적용된 구성을 수정하고 싶지만 아티스트가 사용하는 동안에는 편집하고 싶지 않은 경우가 있습니다. Shotgun에서는 단 몇 개의 명령으로 기존 구성을 복사하여 수정된 구성을 프로덕션에 적용하기 전에 안전하게 수정 사항을 테스트해 볼 수 있습니다. 이 프로세스에서는 프로덕션 구성을 새 구성으로 교체하고 이전 구성은 자동으로 백업합니다. +현재 프로덕션 단계에 적용된 구성을 수정하고 싶지만 아티스트가 사용하는 동안에는 편집하고 싶지 않은 경우가 있습니다. {% include product %}에서는 단 몇 개의 명령으로 기존 구성을 복사하여 수정된 구성을 프로덕션에 적용하기 전에 안전하게 수정 사항을 테스트해 볼 수 있습니다. 이 프로세스에서는 프로덕션 구성을 새 구성으로 교체하고 이전 구성은 자동으로 백업합니다. 구성의 복사본을 작성하는 것은 대개 다음과 같은 이유 때문입니다. @@ -180,7 +180,7 @@ Shotgun 툴킷에서는 구성을 간편하게 편집하고 복제하고 가져 ### 파이프라인 구성의 클라우드 배포 -이 안내서에서는 공유 네트워크 위치에 있으면서 모든 사용자가 액세스하게 되는 파이프라인 구성의 단일 사본인 **중앙 집중식 구성**을 생성하는 과정을 살펴봅니다. 하지만 작업 인력이 여러 위치 및 네트워크에 분산되어 있는 경우 파이프라인 구성의 단일 사본을 공유하는 것이 가능하지 않을 수 있습니다. 이 시나리오의 툴킷을 사용하면 **분산 구성** 옵션을 통해 파이프라인 구성을 Shotgun에 업로드할 수 있으며 사용자가 프로젝트에 액세스할 때마다 구성이 다운로드되고 로컬로 캐시됩니다. [Core API 개발자 문서](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)에서 분산 구성에 대한 자세한 내용을 알아볼 수 있습니다. +이 안내서에서는 공유 네트워크 위치에 있으면서 모든 사용자가 액세스하게 되는 파이프라인 구성의 단일 사본인 **중앙 집중식 구성**을 생성하는 과정을 살펴봅니다. 하지만 작업 인력이 여러 위치 및 네트워크에 분산되어 있는 경우 파이프라인 구성의 단일 사본을 공유하는 것이 가능하지 않을 수 있습니다. 이 시나리오의 툴킷을 사용하면 **분산 구성** 옵션을 통해 파이프라인 구성을 {% include product %}에 업로드할 수 있으며 사용자가 프로젝트에 액세스할 때마다 구성이 다운로드되고 로컬로 캐시됩니다. [Core API 개발자 문서](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)에서 분산 구성에 대한 자세한 내용을 알아볼 수 있습니다. ### 둘 이상의 루트 폴더 사용 diff --git a/docs/ko/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md b/docs/ko/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md index 33928bac9..07a9f4dbc 100644 --- a/docs/ko/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md +++ b/docs/ko/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md @@ -11,9 +11,9 @@ lang: ko ## 안내서 정보 -파이프라인 관리의 가장 어려운 점 중 하나는 생성되는 다양한 파일을 추적하는 것입니다. 툴킷 파이프라인은 Shotgun의 데이터 및 구성된 폴더 구조를 기반으로 폴더를 만들고 올바른 위치에 표준화된 명명 규칙을 사용하여 자동으로 파일을 작성하는 방식으로 파일 시스템 관리를 자동화해 주므로 아티스트는 컨텐츠 생성에 집중할 수 있습니다. 파이프라인 구성은 기본 폴더 세트 및 파일 명명 규칙과 함께 제공되지만 프로덕션에서는 이를 커스터마이즈하는 경우가 많습니다. 이 안내서에서는 이러한 커스터마이즈에 필요한 지식을 제공합니다. +파이프라인 관리의 가장 어려운 점 중 하나는 생성되는 다양한 파일을 추적하는 것입니다. 툴킷 파이프라인은 {% include product %}의 데이터 및 구성된 폴더 구조를 기반으로 폴더를 만들고 올바른 위치에 표준화된 명명 규칙을 사용하여 자동으로 파일을 작성하는 방식으로 파일 시스템 관리를 자동화해 주므로 아티스트는 컨텐츠 생성에 집중할 수 있습니다. 파이프라인 구성은 기본 폴더 세트 및 파일 명명 규칙과 함께 제공되지만 프로덕션에서는 이를 커스터마이즈하는 경우가 많습니다. 이 안내서에서는 이러한 커스터마이즈에 필요한 지식을 제공합니다. -기본 구성에서 에셋은 `asset_type/asset/pipeline_step`과 같은 폴더 구조로 관리됩니다. 이 안내서에서는 "Set"라는 커스텀 엔티티를 사용하여 각 에셋이 사용되는 프로덕션 세트별로 에셋을 추가 구성합니다. 먼저 Shotgun에서 커스텀 엔티티를 설정한 다음 이를 사용하여 지정된 세트에 생성된 에셋을 관리합니다. 폴더 구조는 `set/asset_type/asset/pipeline_step`과 같은 형태입니다. +기본 구성에서 에셋은 `asset_type/asset/pipeline_step`과 같은 폴더 구조로 관리됩니다. 이 안내서에서는 "Set"라는 커스텀 엔티티를 사용하여 각 에셋이 사용되는 프로덕션 세트별로 에셋을 추가 구성합니다. 먼저 {% include product %}에서 커스텀 엔티티를 설정한 다음 이를 사용하여 지정된 세트에 생성된 에셋을 관리합니다. 폴더 구조는 `set/asset_type/asset/pipeline_step`과 같은 형태입니다. 일부 씬은 차고에서 진행되고 나머지 씬은 다이닝룸에서 진행하는 프로젝트를 수행한다고 가정하고 세트별로 에셋을 구성하는 방식을 설명하겠습니다. 설정을 사용하면, "렌치", "기름통" 또는 “작업대"와 같은 에셋에 대한 파일은 "garage" 폴더에 구성되고 "접시", "와인병" 또는 "테이블보"와 같은 에셋에 대한 파일은 "dining_room" 폴더에 구성됩니다. 예제에서 군침 도는 "필레" 에셋은 적절하게 다이닝룸에 배치됩니다. @@ -21,7 +21,7 @@ lang: ko ### 이 안내서는 다음과 같이 세 부분으로 구성됩니다. -* Shotgun에서 "Set"라는 **커스텀 엔티티** 만들기. 아티스트가 만드는 다이닝룸 요소와 연결하는 데 사용됩니다. +* {% include product %}에서 "Set"라는 **커스텀 엔티티** 만들기. 아티스트가 만드는 다이닝룸 요소와 연결하는 데 사용됩니다. * **스키마** 폴더 편집. 툴킷이 폴더 구조에서 현재 세트를 기반으로 동적으로 이름이 지정된 폴더를 포함할 수 있게 합니다. * 에셋 작업 파일 이름 지정에 사용되는 **템플릿** 편집. 툴킷이 파일 이름에 연관된 세트 이름을 포함할 수 있게 합니다. @@ -29,9 +29,9 @@ lang: ko 이 안내서를 사용하려면 다음이 필요합니다. -1. 유효한 [Shotgun](https://www.shotgunsoftware.com/kr/signup/) 사이트. 하나 이상의 에셋이 생성된 프로젝트가 있어야 합니다. 에셋에는 모델 태스크가 있어야 합니다. -2. Shotgun 사이트를 에셋 관리에 사용하는 방법에 대한 기본적인 이해 -3. [Shotgun 데스크톱](https://support.shotgunsoftware.com/hc/ko/articles/115000068574-Integrations-user-guide#Installation%20of%20Desktop)이 시스템에 설치되어 있어야 함 +1. 유효한 [{% include product %}](https://www.shotgunsoftware.com/kr/signup/) 사이트. 하나 이상의 에셋이 생성된 프로젝트가 있어야 합니다. 에셋에는 모델 태스크가 있어야 합니다. +2. {% include product %} 사이트를 에셋 관리에 사용하는 방법에 대한 기본적인 이해 +3. [{% include product %} 데스크톱](https://support.shotgunsoftware.com/hc/ko/articles/115000068574-Integrations-user-guide#Installation%20of%20Desktop)이 시스템에 설치되어 있어야 함 4. 식별된 프로젝트에 대한 복제된 파이프라인 구성이나 [구성 시작하기](./advanced_config.md) 안내서를 완료하고 해당 연습에서 생성한 구성 복제 5. YAML에 대한 기본 지식 6. 파이프라인 구성이 저장된 파일 시스템에 대해 읽기 및 쓰기 권한을 적절하게 설정합니다. @@ -42,11 +42,11 @@ lang: ko ### 파일 스키마 및 템플릿 정보 -툴킷 파이프라인 구성에서 스키마 및 템플릿을 사용하면 Shotgun 데이터를 활용하여 디스크의 프로덕션 파일을 관리할 수 있습니다. 기본 구성의 스키마에는 **샷**, **시퀀스**, **에셋**, **에셋 유형** 등의 엔티티가 포함됩니다. **레벨**, **에피소드**, **시즌**과 같은 다른 엔티티나 앞에서 설명한 **세트(Set)**같은 커스텀 엔티티를 추가할 수 있습니다. +툴킷 파이프라인 구성에서 스키마 및 템플릿을 사용하면 {% include product %} 데이터를 활용하여 디스크의 프로덕션 파일을 관리할 수 있습니다. 기본 구성의 스키마에는 **샷**, **시퀀스**, **에셋**, **에셋 유형** 등의 엔티티가 포함됩니다. **레벨**, **에피소드**, **시즌**과 같은 다른 엔티티나 앞에서 설명한 **세트(Set)**같은 커스텀 엔티티를 추가할 수 있습니다. 툴킷 플랫폼을 통해 **스키마**를 사용하여 동적으로 폴더 구조를 빌드할 수 있습니다. 스키마는 실제 프로덕션 파일 시스템을 빌드할 때 템플릿으로 사용되는 프로덕션 폴더 구조의 미니어쳐 버전입니다. 스키마는 동적 폴더 생성을 위한 명시적 지침으로, YAML 파일을 사용하여 동적으로 생성된 폴더의 규칙을 정의합니다. 기본 구성에는 에셋 및 샷 파이프라인에 대한 폴더 생성을 지원하는 사전 구성된 스키마가 포함됩니다. 에셋 폴더 구조(`/assets///`) 생성을 지원하는 스키마 부분을 수정하여 새로 생성하는 **Set** 엔티티도 지원할 수 있습니다. -**템플릿**을 사용하면 Shotgun 데이터 및 스키마 구조의 정보를 사용하여 만든 파일을 동적으로 이름을 지정하고 저장할 수 있습니다. 기본 구성은 파이프라인의 요구에 맞게 편집할 수 있는 일련의 초보자용 템플릿을 제공합니다. +**템플릿**을 사용하면 {% include product %} 데이터 및 스키마 구조의 정보를 사용하여 만든 파일을 동적으로 이름을 지정하고 저장할 수 있습니다. 기본 구성은 파이프라인의 요구에 맞게 편집할 수 있는 일련의 초보자용 템플릿을 제공합니다. {% include info title="참고" content="Shotgun 통합의 기본 설정에는 파일 시스템 관리가 포함되지 않습니다. 프로젝트에 대한 파일 시스템 관리를 구성하려면 프로젝트에 고급 설정이 필요합니다. 첫 번째 안내서인 [구성 시작하기](./advanced_config.md)에서 고급 설정 프로세스에 대해 설명합니다." %} @@ -56,11 +56,11 @@ lang: ko ### 커스텀 엔티티 활성화하기 -**1단계:** 브라우저에서 Shotgun 사이트를 엽니다. 아바타를 클릭하고 관리자(ADMIN) > 사이트 기본 설정(Site Preferences)으로 이동합니다. 결과 페이지에서 **엔티티**(Entities) 섹션을 확장합니다. +**1단계:** 브라우저에서 {% include product %} 사이트를 엽니다. 아바타를 클릭하고 관리자(ADMIN) > 사이트 기본 설정(Site Preferences)으로 이동합니다. 결과 페이지에서 **엔티티**(Entities) 섹션을 확장합니다. ![Python 앱](./images/dynamic_filesystem_configuration/1_site_preferences.png) -Shotgun에서 사용할 수 있는 엔티티 유형 목록이 표시됩니다. 아래 이미지에서 목록 상단에는 현재 Shotgun 사이트에 구성된 일부 엔티티 유형이 있습니다. 이러한 엔티티 유형 아래에는 구성되지 않았거나 활성화되지 않은 몇 가지 **커스텀 엔티티**가 있습니다. +{% include product %}에서 사용할 수 있는 엔티티 유형 목록이 표시됩니다. 아래 이미지에서 목록 상단에는 현재 {% include product %} 사이트에 구성된 일부 엔티티 유형이 있습니다. 이러한 엔티티 유형 아래에는 구성되지 않았거나 활성화되지 않은 몇 가지 **커스텀 엔티티**가 있습니다. ### 커스텀 엔티티 유형 중 하나를 선택하고 구성하고 활성화합니다. @@ -70,7 +70,7 @@ Shotgun에서 사용할 수 있는 엔티티 유형 목록이 표시됩니다. ![Python 앱](./images/dynamic_filesystem_configuration/4_enable_entity.png) -이렇게 하면 Shotgun에서 해당 커스텀 엔티티가 활성화되고 표시 이름이 *Set*로 표시됩니다. 기본적으로 엔티티의 시스템 이름은 `CustomEntity01`로 유지되므로 커스텀 엔티티에 대한 별칭을 작성합니다. 이 예제에서는 `CustomEntity01`을 사용하지만 다른 커스텀 엔티티를 사용할 수 있습니다. +이렇게 하면 {% include product %}에서 해당 커스텀 엔티티가 활성화되고 표시 이름이 *Set*로 표시됩니다. 기본적으로 엔티티의 시스템 이름은 `CustomEntity01`로 유지되므로 커스텀 엔티티에 대한 별칭을 작성합니다. 이 예제에서는 `CustomEntity01`을 사용하지만 다른 커스텀 엔티티를 사용할 수 있습니다. {% include info title="참고" content="선택한 커스텀 엔티티의 시스템 이름을 기억하십시오." %} @@ -98,7 +98,7 @@ Shotgun에서 사용할 수 있는 엔티티 유형 목록이 표시됩니다. 이 안내서에서는 이를 **현재 프로젝트만**(Only the current project)으로 적용하고 **필드 만들기**(Create Field)를 선택합니다. -Shotgun이 새 필드를 구성합니다. +{% include product %}이 새 필드를 구성합니다. ![Python 앱](./images/dynamic_filesystem_configuration/8_only_current_project.png) @@ -124,7 +124,7 @@ Shotgun이 새 필드를 구성합니다. ### 스키마 설정 -이제 Set 커스텀 엔티티가 활성화되고 "Dining Room"이라는 Set 엔티티가 만들어지고 에셋 엔티티가 Dining Room Set에 링크되었습니다. Shotgun 사이트에서 모든 부분이 준비되었으며 이제 폴더 구조를 수정할 수 있습니다. 아티스트가 태스크에 대한 작업을 시작하면 툴킷은 연결된 Shotgun 데이터를 사용하여 파일 시스템에 만들 폴더를 결정합니다. 새 폴더가 생성되고 파이프라인 구성 스키마를 기반으로 이름이 자동으로 지정됩니다. +이제 Set 커스텀 엔티티가 활성화되고 "Dining Room"이라는 Set 엔티티가 만들어지고 에셋 엔티티가 Dining Room Set에 링크되었습니다. {% include product %} 사이트에서 모든 부분이 준비되었으며 이제 폴더 구조를 수정할 수 있습니다. 아티스트가 태스크에 대한 작업을 시작하면 툴킷은 연결된 {% include product %} 데이터를 사용하여 파일 시스템에 만들 폴더를 결정합니다. 새 폴더가 생성되고 파이프라인 구성 스키마를 기반으로 이름이 자동으로 지정됩니다. 이제 아티스트가 프로덕션 파이프라인을 단계별로 수행할 때 툴킷에서 동적으로 생성할 폴더 구조를 정의할 수 있습니다. 이 작업은 스키마를 편집하여 수행합니다. @@ -150,7 +150,7 @@ Shotgun이 새 필드를 구성합니다. `/assets////` -Set 엔티티는 `CustomEntity01`로 표시됩니다. Shotgun에서 Set의 *표시 이름*으로 CustomEntity01을 제공했지만 구성에서 항상 시스템 이름으로 `CustomEntity01`을 참조합니다. +Set 엔티티는 `CustomEntity01`로 표시됩니다. {% include product %}에서 Set의 *표시 이름*으로 CustomEntity01을 제공했지만 구성에서 항상 시스템 이름으로 `CustomEntity01`을 참조합니다. ### 스키마가 YAML 파일을 사용하는 방법 @@ -158,7 +158,7 @@ Set 엔티티는 `CustomEntity01`로 표시됩니다. Shotgun에서 Set의 *표 ### Set 엔티티에 대한 새 폴더 및 YAML 파일 만들기 -스키마에는 Shotgun에서 추적하는 다른 엔티티에 대한 폴더가 포함된 `project` 폴더가 있습니다. 새 에셋 엔티티 CustomEntity01을 추가하여 Shotgun에서 Set의 항목을 추적할 수 있도록 합니다. 이러한 항목은 에셋이므로 에셋에서 폴더 및 YAML 파일을 편집할 수 있습니다. +스키마에는 {% include product %}에서 추적하는 다른 엔티티에 대한 폴더가 포함된 `project` 폴더가 있습니다. 새 에셋 엔티티 CustomEntity01을 추가하여 {% include product %}에서 Set의 항목을 추적할 수 있도록 합니다. 이러한 항목은 에셋이므로 에셋에서 폴더 및 YAML 파일을 편집할 수 있습니다. 다시 말하지만 우리의 목표는 `asset_type/asset/step` 폴더 구조에서 `set/asset_type/asset/step` 폴더 구조로 바꾸는 것입니다. 따라서 해당 YAML 파일을 사용하여 스키마에서 세트를 나타내는 폴더를 추가하려고 합니다. 커스텀 엔티티에 대한 시스템 이름을 사용해야 하므로 `CustomEntity01/` 폴더와 `CustomEntity01.yml`을 만듭니다. @@ -180,7 +180,7 @@ filters: - { "path": "project", "relation": "is", "values": [ "$project" ] } ``` -YAML 파일은 툴킷에서 `CustomEntity01` 폴더 이름을 무엇으로 지정할지에 대한 지침을 제공합니다. 여기서는 유형이 `shotgun_entity`인 폴더를 만들고 있으며 이는 Shotgun 쿼리에 해당함을 의미합니다. `entity_type` 필드는 Shotgun에서 `CustomEntity01` 엔티티를 쿼리함을 나타내고 `name` 필드는 쿼리할 엔티티에 대한 *필드*를 나타내며 여기서는 `CustomEntity01`에서 `code` 필드를 가져옵니다. +YAML 파일은 툴킷에서 `CustomEntity01` 폴더 이름을 무엇으로 지정할지에 대한 지침을 제공합니다. 여기서는 유형이 `{% include product %}_entity`인 폴더를 만들고 있으며 이는 {% include product %} 쿼리에 해당함을 의미합니다. `entity_type` 필드는 {% include product %}에서 `CustomEntity01` 엔티티를 쿼리함을 나타내고 `name` 필드는 쿼리할 엔티티에 대한 *필드*를 나타내며 여기서는 `CustomEntity01`에서 `code` 필드를 가져옵니다. `filters` 필드는 이 동적 폴더를 만들어야 하는 경우를 제한합니다. @@ -225,10 +225,10 @@ filters: 폴더는 툴킷 파이프라인 워크플로우의 몇 지점에서 생성됩니다. -* **응용프로그램 시작 관리자**: 사용자가 태스크에 대한 DCC를 시작할 때마다 툴킷은 해당 태스크에 대한 디렉토리를 만듭니다(아직 없는 경우). 툴킷을 사용하여 수행하는 첫 번째 작업이 보통 DCC를 시작하는 것이기 때문에 이 방법이 디렉토리를 생성하는 가장 일반적인 방법입니다. 이 작업은 Shotgun 또는 Shotgun 데스크톱이나 Create 앱에서 마우스 오른쪽 버튼 클릭 메뉴를 통해 수행할 수 있습니다. -* **Shotgun 메뉴**: 태스크에 대해 폴더를 만드는 가장 직접적인 방법은 Shotgun에서 태스크를 마우스 오른쪽 버튼으로 클릭하고 "폴더 만들기"(Create Folders) 메뉴 항목을 선택하는 것입니다. -* **툴킷 API**: 툴킷 API를 통해 직접 디렉토리 생성 로직을 트리거할 수 있습니다. 툴킷 API는 커스텀 시작 관리자에 툴킷을 연결하거나, Shotgun에서 샷이 생성될 때 샷에 대한 디렉토리를 자동으로 만들려는 워크플로우의 이벤트 트리거 등에 사용할 수 있습니다. -* **tank 명령**: Shotgun의 메뉴 항목과 유사하며 `tank folders` 터미널 명령도 태스크에 대한 폴더를 만듭니다. +* **응용프로그램 시작 관리자**: 사용자가 태스크에 대한 DCC를 시작할 때마다 툴킷은 해당 태스크에 대한 디렉토리를 만듭니다(아직 없는 경우). 툴킷을 사용하여 수행하는 첫 번째 작업이 보통 DCC를 시작하는 것이기 때문에 이 방법이 디렉토리를 생성하는 가장 일반적인 방법입니다. 이 작업은 {% include product %} 또는 {% include product %} 데스크톱이나 Create 앱에서 마우스 오른쪽 버튼 클릭 메뉴를 통해 수행할 수 있습니다. +* **{% include product %} 메뉴**: 태스크에 대해 폴더를 만드는 가장 직접적인 방법은 {% include product %}에서 태스크를 마우스 오른쪽 버튼으로 클릭하고 "폴더 만들기"(Create Folders) 메뉴 항목을 선택하는 것입니다. +* **툴킷 API**: 툴킷 API를 통해 직접 디렉토리 생성 로직을 트리거할 수 있습니다. 툴킷 API는 커스텀 시작 관리자에 툴킷을 연결하거나, {% include product %}에서 샷이 생성될 때 샷에 대한 디렉토리를 자동으로 만들려는 워크플로우의 이벤트 트리거 등에 사용할 수 있습니다. +* **tank 명령**: {% include product %}의 메뉴 항목과 유사하며 `tank folders` 터미널 명령도 태스크에 대한 폴더를 만듭니다. `tank` 명령을 사용하여 테스트하겠습니다. @@ -274,7 +274,7 @@ In total, 23 folders were processed. ### 툴킷 앱의 템플릿 사용 방법 -먼저 세트를 나타내는 CustomEntity01을 활성화한 다음 에셋 엔티티에 에셋과 세트 간 링크를 나타내는 링크 필드를 추가하면 Shotgun에서 세트와 에셋을 연결할 수 있습니다. 에셋과 세트 간에 관계를 설정한 후 폴더 스키마를 설정하여 해당 연결을 사용해 모든 에셋 *폴더*를 연결된 세트의 폴더 내에 배치합니다. 이제 *파일*의 이름을 동적으로 지정하고 툴킷 앱에서 자동으로 파일을 관리할 수 있습니다. +먼저 세트를 나타내는 CustomEntity01을 활성화한 다음 에셋 엔티티에 에셋과 세트 간 링크를 나타내는 링크 필드를 추가하면 {% include product %}에서 세트와 에셋을 연결할 수 있습니다. 에셋과 세트 간에 관계를 설정한 후 폴더 스키마를 설정하여 해당 연결을 사용해 모든 에셋 *폴더*를 연결된 세트의 폴더 내에 배치합니다. 이제 *파일*의 이름을 동적으로 지정하고 툴킷 앱에서 자동으로 파일을 관리할 수 있습니다. 아티스트가 프로젝트의 태스크 작업을 시작하면 필수 폴더 구조가 생성됩니다. 그러 다음 아티스트가 Workfiles 앱의 **파일 저장**(File Save) 액션을 시작하면 자동으로 파일 이름이 지정됩니다. 툴킷의 Workfiles 앱을 통해 액세스한 템플릿은 해당 파일의 이름을 지정하는 데 사용됩니다. Nuke Write 노드 및 Houdini Mantra 노드와 같은 렌더 앱은 템플릿을 사용하여 렌더링된 파일의 이름을 지정하고 파일을 저장합니다. 게시된 파일의 경우 Publisher 앱에서 수행하는 작업입니다. @@ -357,17 +357,17 @@ Workfiles **파일 열기**(File Open) 액션을 사용하여 파일이 액세 ### 테스트 -**18단계:** Shotgun 데스크톱에서 Maya를 시작합니다. +**18단계:** {% include product %} 데스크톱에서 Maya를 시작합니다. ![Python 앱](images/dynamic_filesystem_configuration/23_test_file_creation.png) -Maya에서 **Shotgun > 파일 열기(File Open)**로 이동하여 결과 대화상자에서, Shotgun에서 Set를 지정한 에셋에 대한 태스크를 선택합니다. +Maya에서 **{% include product %} > 파일 열기(File Open)**로 이동하여 결과 대화상자에서, {% include product %}에서 Set를 지정한 에셋에 대한 태스크를 선택합니다. ![Python 앱](images/dynamic_filesystem_configuration/24_test_new_file.png) **+새 파일**(+New File)을 선택합니다. -간단한 3D 객체를 만들거나 **Shotgun > 파일 저장(Save File)**을 사용하여 파일을 저장할 수 있습니다. +간단한 3D 객체를 만들거나 **{% include product %} > 파일 저장(Save File)**을 사용하여 파일을 저장할 수 있습니다. ![Python 앱](images/dynamic_filesystem_configuration/file_save.png) @@ -375,17 +375,17 @@ Maya에서 **Shotgun > 파일 열기(File Open)**로 이동하여 결과 대화 **파일 저장**(File Save) 대화상자에 새 템플릿 설정을 사용하여 **미리보기: Dining-Room_scene.v001.ma**(Preview: Dining-Room_scene.v001.ma)가 표시되어 있습니다. -**작업 영역**(Work Area)에는 Workfiles가 파일을 저장하는 경로인 **.../Shotgun/projects/the_other_side/assets/Dining-Room/Prop/Filet/model/work/maya**가 표시되어 있습니다. +**작업 영역**(Work Area)에는 Workfiles가 파일을 저장하는 경로인 **.../{% include product %}/projects/the_other_side/assets/Dining-Room/Prop/Filet/model/work/maya**가 표시되어 있습니다. ## 고급 항목 ### 예제 확장 -이 예제에서는 단일 템플릿을 수정했지만 파일 시스템 구성을 사용하여 수행할 수 있는 작업은 훨씬 많습니다. 실제 사례에서는 동일한 파일 명명 규칙을 갖도록 *모든* 에셋 관련 파일을 변경합니다. 다른 엔티티(시즌, 에피소드, 레벨 등)를 기반으로 수정하고, 사용자 폴더를 만들고, 정규 표현식으로 조작된 Shotgun 데이터를 기반으로 폴더 이름을 지정하는 등 많은 작업을 수행할 수 있습니다. 툴킷의 모든 폴더 및 스키마 옵션에 대한 자세한 내용은 [파일 시스템 구성 참조](https://support.shotgunsoftware.com/hc/ko/articles/219039868)를 참조하십시오. +이 예제에서는 단일 템플릿을 수정했지만 파일 시스템 구성을 사용하여 수행할 수 있는 작업은 훨씬 많습니다. 실제 사례에서는 동일한 파일 명명 규칙을 갖도록 *모든* 에셋 관련 파일을 변경합니다. 다른 엔티티(시즌, 에피소드, 레벨 등)를 기반으로 수정하고, 사용자 폴더를 만들고, 정규 표현식으로 조작된 {% include product %} 데이터를 기반으로 폴더 이름을 지정하는 등 많은 작업을 수행할 수 있습니다. 툴킷의 모든 폴더 및 스키마 옵션에 대한 자세한 내용은 [파일 시스템 구성 참조](https://support.shotgunsoftware.com/hc/ko/articles/219039868)를 참조하십시오. ### 경로 캐시 -폴더가 생성될 때 디스크의 폴더와 Shotgun 엔티티 간에 매핑이 만들어집니다. 이러한 매핑은 Shotgun에 FilesystemLocation 엔티티로 저장되고 사용자 컴퓨터의 SQLite 데이터베이스에서 캐시됩니다. 경로 캐시 작동 방식과 이를 사용한 작업 방법에 대한 자세한 내용은 [이 문서](../../../quick-answers/administering/what-is-path-cache.md)를 참조하십시오. +폴더가 생성될 때 디스크의 폴더와 {% include product %} 엔티티 간에 매핑이 만들어집니다. 이러한 매핑은 {% include product %}에 FilesystemLocation 엔티티로 저장되고 사용자 컴퓨터의 SQLite 데이터베이스에서 캐시됩니다. 경로 캐시 작동 방식과 이를 사용한 작업 방법에 대한 자세한 내용은 [이 문서](../../../quick-answers/administering/what-is-path-cache.md)를 참조하십시오. ### 추가 리소스 diff --git a/docs/ko/guides/pipeline-integrations/getting-started/editing_app_setting.md b/docs/ko/guides/pipeline-integrations/getting-started/editing_app_setting.md index 2f46e9c44..9dd445ab8 100644 --- a/docs/ko/guides/pipeline-integrations/getting-started/editing_app_setting.md +++ b/docs/ko/guides/pipeline-integrations/getting-started/editing_app_setting.md @@ -16,38 +16,38 @@ lang: ko 이 안내서에서는 기존 파이프라인 구성 내에서 설정을 프로젝트 파이프라인의 요구 사항에 맞게 편집하는 방법에 대해 설명합니다. 첫 번째 안내서인 **[구성 시작하기](./advanced_config.md)**에서는 편집을 위해 파이프라인 구성을 준비하는 방법을 설명합니다. 편집 가능한 프로젝트 구성을 만드는 데 익숙하지 않다면 먼저 **구성 시작하기**를 전체적으로 검토하십시오. -기본 구성을 확장하는 방법으로 Shotgun 툴킷에서 파이프라인 워크플로우 내의 태스크를 커스터마이즈할 수 있습니다. 커스터마이즈의 간단한 예로, 하나 이상의 소프트웨어 패키지 내에서 툴킷 앱의 버튼을 활성화 또는 비활성화하여 사용자들이 툴킷의 기능과 상호 작용하는 방식을 변경할 수 있습니다. 툴킷은 독자적인 구성을 지원하므로 커스텀 워크플로우를 생성하고, 반복적이고 일상적인 태스크를 자동화하고, 후크를 수정하고, 툴킷 플랫폼에 커스텀 도구를 추가함으로써 더 스마트하고 빠르게 작업할 수 있습니다. 그러나 Shotgun 소프트웨어 통합을 통해서만 액세스할 수 있으며 일상적인 작업용으로는 아직 출시되지 않았습니다. +기본 구성을 확장하는 방법으로 {% include product %} 툴킷에서 파이프라인 워크플로우 내의 태스크를 커스터마이즈할 수 있습니다. 커스터마이즈의 간단한 예로, 하나 이상의 소프트웨어 패키지 내에서 툴킷 앱의 버튼을 활성화 또는 비활성화하여 사용자들이 툴킷의 기능과 상호 작용하는 방식을 변경할 수 있습니다. 툴킷은 독자적인 구성을 지원하므로 커스텀 워크플로우를 생성하고, 반복적이고 일상적인 태스크를 자동화하고, 후크를 수정하고, 툴킷 플랫폼에 커스텀 도구를 추가함으로써 더 스마트하고 빠르게 작업할 수 있습니다. 그러나 {% include product %} 소프트웨어 통합을 통해서만 액세스할 수 있으며 일상적인 작업용으로는 아직 출시되지 않았습니다. -이 안내서의 연습을 통해 Shotgun 소프트웨어 통합 내에서 구성 설정 제어 액션을 찾는 방법과 설정이 존재하는 위치, 설정을 편집하는 방법을 익힐 수 있습니다. 특히 Maya 내에서 프로젝트 작업 중에 아티스트가 새 태스크를 생성하지 못하도록 **+새 태스크**(+New Task) 버튼의 동작을 관리하는 Workfiles 앱의 설정을 편집해 보겠습니다. +이 안내서의 연습을 통해 {% include product %} 소프트웨어 통합 내에서 구성 설정 제어 액션을 찾는 방법과 설정이 존재하는 위치, 설정을 편집하는 방법을 익힐 수 있습니다. 특히 Maya 내에서 프로젝트 작업 중에 아티스트가 새 태스크를 생성하지 못하도록 **+새 태스크**(+New Task) 버튼의 동작을 관리하는 Workfiles 앱의 설정을 편집해 보겠습니다. ## 이 문서 사용 이 안내서를 사용하고 파이프라인 구성에 대한 편집을 수행하려면 다음이 필요합니다. -1. 활성 [Shotgun](https://www.shotgunsoftware.com/kr/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management) 사이트. +1. 활성 [{% include product %}](https://www.shotgunsoftware.com/kr/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management) 사이트. 2. 하나 이상의 에셋이 있는 프로젝트. 첫 번째 안내서에서 생성한 the_other_side 프로젝트에 에셋을 추가할 수 있습니다. [구성 시작하기](./advanced_config.md) 안내서에서 프로젝트의 에셋을 생성하는 방법을 익힐 수 있습니다. 3. 식별된 프로젝트에 대한 파이프라인 구성이나 [구성 시작하기](./advanced_config.md) 안내서를 완료하고 해당 연습에서 생성한 구성을 사용합니다. 4. 파이프라인 구성이 저장된 파일 시스템에 대해 읽기 및 쓰기 권한을 적절하게 설정합니다. -5. Shotgun 데스크톱이 시스템에 설치되어 있어야 합니다. +5. {% include product %} 데스크톱이 시스템에 설치되어 있어야 합니다. 6. 활성 상태의 Maya 멤버쉽. Maya의 30일 체험판은 [여기](https://www.autodesk.co.kr/products/maya/free-trial)에서 구할 수 있습니다. {% include info title="참고" content="이 안내서는 `tk-config-default2` 파이프라인 구성을 기반으로 합니다. 이 구성을 수정한 경우 YAML 설정의 파일, 폴더 및 블록의 위치가 여기에 설명된 것과 다를 수 있습니다." %} ## Workfiles 앱 정보 -Workfiles 앱은 Shotgun 소프트웨어 통합에서 파일 관리를 제어하고, 작업 파일을 검색하고 열고 저장하는 기능에 대한 액세스를 제어합니다. **+새 태스크**(+New Task) 버튼은 사용자가 이 작업을 수행하기 위해 Shotgun으로 이동할 필요 없이 태스크를 추가할 수 있게 해 주는 Workfiles 앱의 동작입니다. 구성은 환경별 파일로 나뉩니다. 이를 통해 파일을 생성하고, 파일에 이름을 지정하고, 파일을 저장하는 시기 또는 태스크를 실행하거나 특정 기능을 수행하는 시기를 제어하는 등 파이프라인의 여러 단계와 관련된 기능을 관리할 수 있습니다. 이러한 구성은 Workfiles 앱의 모든 기능과 연관되며 앱 또는 엔진의 설정을 수정할 때도 적용됩니다. 자세한 내용은 이 문서의 끝부분에 있는 [고급 항목](#advanced-topics)을 참조하십시오. +Workfiles 앱은 {% include product %} 소프트웨어 통합에서 파일 관리를 제어하고, 작업 파일을 검색하고 열고 저장하는 기능에 대한 액세스를 제어합니다. **+새 태스크**(+New Task) 버튼은 사용자가 이 작업을 수행하기 위해 {% include product %}으로 이동할 필요 없이 태스크를 추가할 수 있게 해 주는 Workfiles 앱의 동작입니다. 구성은 환경별 파일로 나뉩니다. 이를 통해 파일을 생성하고, 파일에 이름을 지정하고, 파일을 저장하는 시기 또는 태스크를 실행하거나 특정 기능을 수행하는 시기를 제어하는 등 파이프라인의 여러 단계와 관련된 기능을 관리할 수 있습니다. 이러한 구성은 Workfiles 앱의 모든 기능과 연관되며 앱 또는 엔진의 설정을 수정할 때도 적용됩니다. 자세한 내용은 이 문서의 끝부분에 있는 [고급 항목](#advanced-topics)을 참조하십시오. ## 구성 파일 익히기 -Shotgun의 파이프라인 구성 목록을 사용하여 작업 중인 프로젝트의 파이프라인 구성이 저장된 위치를 찾을 수 있습니다. 저장된 위치를 아는 경우 5단계로 건너뛸 수 있습니다. +S{% include product %}의 파이프라인 구성 목록을 사용하여 작업 중인 프로젝트의 파이프라인 구성이 저장된 위치를 찾을 수 있습니다. 저장된 위치를 아는 경우 5단계로 건너뛸 수 있습니다. ## 파이프라인 구성 찾기 -**1단계:** 이 연습에서 사용하게 될 프로젝트를 관리하는 **Shotgun 사이트**를 엽니다. +**1단계:** 이 연습에서 사용하게 될 프로젝트를 관리하는 **{% include product %} 사이트**를 엽니다. -**2단계:** **Shotgun 사이트**의 **프로젝트 페이지**에서 프로젝트를 선택하여 액세스합니다. +**2단계:** **{% include product %} 사이트**의 **프로젝트 페이지**에서 프로젝트를 선택하여 액세스합니다. -![Shotgun 프로젝트](./images/editing_app_setting/1_shotgun_project.png) +![{% include product %} 프로젝트](./images/editing_app_setting/1_shotgun_project.png) **3단계:** 오른쪽 상단에 있는 **아바타**를 선택하여 **관리자**(ADMIN) 메뉴를 표시하고 아래로 스크롤하여 **기본 레이아웃(Default Layouts) > 파이프라인 구성(Pipeline Configuration) > 파이프라인 구성 목록(Pipeline Configuration List)**을 선택합니다. @@ -75,23 +75,23 @@ Shotgun의 파이프라인 구성 목록을 사용하여 작업 중인 프로젝 ## 구성 파일 편집 -Shotgun 툴킷을 통해 다양한 소프트웨어 패키지 내에 통합된 앱으로 변경할 수 있습니다. Workfiles 앱의 기능 중 하나는 **+새 태스크**(+New Task) 버튼으로, 사용자가 **파일 열기**(File Open) 대화상자에서 새 태스크를 추가할 수 있게 해 줍니다. 기본적으로 이 기능은 모든 사용자에 대해 프로젝트의 모든 진행단계에서 활성화되어 있습니다. 그러나 이 기능을 제한하고 싶은 스튜디오도 있을 수 있습니다. 특정 명명 규칙이 있거나 프로젝트의 프로덕션 관리 팀만 태스크를 생성할 수 있도록 제한하려는 경우에 그렇습니다. 이 경우 아티스트가 Maya에서 작업할 파이프라인의 모든 지점에 대해 **+새 태스크**(+New Task) 버튼을 비활성화하면 됩니다. +{% include product %} 툴킷을 통해 다양한 소프트웨어 패키지 내에 통합된 앱으로 변경할 수 있습니다. Workfiles 앱의 기능 중 하나는 **+새 태스크**(+New Task) 버튼으로, 사용자가 **파일 열기**(File Open) 대화상자에서 새 태스크를 추가할 수 있게 해 줍니다. 기본적으로 이 기능은 모든 사용자에 대해 프로젝트의 모든 진행단계에서 활성화되어 있습니다. 그러나 이 기능을 제한하고 싶은 스튜디오도 있을 수 있습니다. 특정 명명 규칙이 있거나 프로젝트의 프로덕션 관리 팀만 태스크를 생성할 수 있도록 제한하려는 경우에 그렇습니다. 이 경우 아티스트가 Maya에서 작업할 파이프라인의 모든 지점에 대해 **+새 태스크**(+New Task) 버튼을 비활성화하면 됩니다. ## Maya에서 프로젝트에 대해 +새 태스크(+New Task) 버튼 비활성화 -**7단계:** **Shotgun 데스크톱**을 엽니다. +**7단계:** **{% include product %} 데스크톱**을 엽니다. **8단계:** 편집할 구성의 프로젝트를 선택합니다. ![프로젝트 로드](./images/editing_app_setting/6_load_project.png) -**9단계:** Shotgun 데스크톱에서 Maya를 시작합니다. +**9단계:** {% include product %} 데스크톱에서 Maya를 시작합니다. ![프로젝트 로드](./images/editing_app_setting/7_view_project.png) -**Shotgun** 메뉴가 완전히 로드될 때까지 기다립니다. 인터넷 연결 속도가 느릴 경우 메뉴가 로드되는 동안 커피 한 잔 준비하는 것도 좋습니다. +**{% include product %}** 메뉴가 완전히 로드될 때까지 기다립니다. 인터넷 연결 속도가 느릴 경우 메뉴가 로드되는 동안 커피 한 잔 준비하는 것도 좋습니다. -Maya와 Shotgun이 완전히 로드되면 **파일 열기**(File Open) 대화상자가 자동으로 열립니다. Shotgun 데스크톱에서 Maya를 실행하면 **프로젝트** 환경에서 Maya가 시작되고 툴킷 워크플로우의 구성이 `config/env/project.yml` 파일에 의해 구동됩니다. 기본 구성에서 식별되는 환경은 `project`, `sequence`, `shot`, `shot_step`, `asset`, `asset_step`입니다. +Maya와 {% include product %}이 완전히 로드되면 **파일 열기**(File Open) 대화상자가 자동으로 열립니다. {% include product %} 데스크톱에서 Maya를 실행하면 **프로젝트** 환경에서 Maya가 시작되고 툴킷 워크플로우의 구성이 `config/env/project.yml` 파일에 의해 구동됩니다. 기본 구성에서 식별되는 환경은 `project`, `sequence`, `shot`, `shot_step`, `asset`, `asset_step`입니다. **10단계:** **파일 열기**(File Open) 대화상자의 왼쪽 창에서 **에셋**(Assets) 탭을 선택합니다. 검색 결과에 표시되는 폴더 내의 모든 에셋을 선택합니다. @@ -101,11 +101,11 @@ Maya와 Shotgun이 완전히 로드되면 **파일 열기**(File Open) 대화상 ## +새 태스크(+New Task) 버튼을 제어하는 설정 찾기 -파이프라인 요구 사항을 충족하기 위해 툴킷 파이프라인 구성을 사용하여 사용자 환경을 커스터마이즈할 수 있습니다. 파이프라인 구성은 프로젝트 파이프라인의 요구 사항에 맞게 필요에 따라 기본 Shotgun 통합 설정을 재정의할 수 있습니다. Shotgun 코어 코드의 기본값과 다른 설정만 추가하여 구성을 간단하게 생성할 수 있는 구조입니다. 이 연습에서는 Workfiles 앱의 **+새 태스크**(+New Task) 버튼을 사용할 수 없게 할 예정이지만 그전에 이 버튼을 제어하는 구성 설정을 확인해야 합니다. +파이프라인 요구 사항을 충족하기 위해 툴킷 파이프라인 구성을 사용하여 사용자 환경을 커스터마이즈할 수 있습니다. 파이프라인 구성은 프로젝트 파이프라인의 요구 사항에 맞게 필요에 따라 기본 {% include product %} 통합 설정을 재정의할 수 있습니다. {% include product %} 코어 코드의 기본값과 다른 설정만 추가하여 구성을 간단하게 생성할 수 있는 구조입니다. 이 연습에서는 Workfiles 앱의 **+새 태스크**(+New Task) 버튼을 사용할 수 없게 할 예정이지만 그전에 이 버튼을 제어하는 구성 설정을 확인해야 합니다. **11단계:** **프로젝트(프로젝트 이름)**(Project(프로젝트 이름)) 옆에 있는 **파일 열기**(File Open) 창의 오른쪽 상단에서 **>**를 선택합니다. -이 참조 상자는 **파일 열기**(File Open) 창의 기능을 제어하는 구성 설정에 대한 상세한 정보를 보여 줍니다. 툴킷의 일부 앱에는 앱에 사용된 설정과 기본 설정을 보여 주는 참조 상자가 있습니다. **위치:**(Location:) 식별자는 **tk-multi-workfiles2**입니다. 이 식별자는 Workfiles 앱을 만드는 코드 번들의 식별자입니다. 파이프라인 구성을 검색할 때 이 이름으로 앱의 설정이 있는 위치를 확인할 수 있습니다. Shotgun 통합에서 사용할 수 있는 모든 구성 설정, 앱 및 엔진이 나열된 [앱 및 엔진 페이지](https://support.shotgunsoftware.com/hc/ko/articles/219039798-Integrations-Apps-and-Engines)가 있습니다. +이 참조 상자는 **파일 열기**(File Open) 창의 기능을 제어하는 구성 설정에 대한 상세한 정보를 보여 줍니다. 툴킷의 일부 앱에는 앱에 사용된 설정과 기본 설정을 보여 주는 참조 상자가 있습니다. **위치:**(Location:) 식별자는 **tk-multi-workfiles2**입니다. 이 식별자는 Workfiles 앱을 만드는 코드 번들의 식별자입니다. 파이프라인 구성을 검색할 때 이 이름으로 앱의 설정이 있는 위치를 확인할 수 있습니다. {% include product %} 통합에서 사용할 수 있는 모든 구성 설정, 앱 및 엔진이 나열된 [앱 및 엔진 페이지](https://support.shotgunsoftware.com/hc/ko/articles/219039798-Integrations-Apps-and-Engines)가 있습니다. ![Current_work_area](./images/editing_app_setting/9_current_work_area.png) @@ -135,13 +135,13 @@ Maya와 Shotgun이 완전히 로드되면 **파일 열기**(File Open) 대화상 **12단계:** 기본 Maya 창을 앞으로 가져옵니다. -**13단계:** Maya 창의 오른쪽 상단에서 **Shotgun** 메뉴 항목을 찾습니다. +**13단계:** Maya 창의 오른쪽 상단에서 **{% include product %}** 메뉴 항목을 찾습니다. -![Maya shotgun2](./images/editing_app_setting/12_Maya_Shotgun2.png) +![Maya {% include product %}2](./images/editing_app_setting/12_Maya_Shotgun2.png) -**팁:** 메뉴가 표시되지 않을 경우 일부 숨겨진 메뉴 항목을 볼 수 있는 **>>**가 표시됩니다. **>>**를 선택하여 Shotgun 메뉴를 표시하거나 Maya 창을 넓히면 됩니다. +**팁:** 메뉴가 표시되지 않을 경우 일부 숨겨진 메뉴 항목을 볼 수 있는 **>>**가 표시됩니다. **>>**를 선택하여 {% include product %} 메뉴를 표시하거나 Maya 창을 넓히면 됩니다. -**14단계:** 메뉴 오른쪽 상단에서 **Shotgun > 프로젝트 the_other_side(Project the_other_side) > 작업 영역 정보…(Work Area Info…)**를 선택합니다. +**14단계:** 메뉴 오른쪽 상단에서 **{% include product %} > 프로젝트 the_other_side(Project the_other_side) > 작업 영역 정보…(Work Area Info…)**를 선택합니다. ![작업 영역 정보](./images/editing_app_setting/13_work_area_info.png) @@ -149,7 +149,7 @@ Maya와 Shotgun이 완전히 로드되면 **파일 열기**(File Open) 대화상 **15단계:** **현재 작업 영역**(Your Current Work Area) 대화상자에서 아래에 있는 **환경**(Environment) 탭을 선택합니다. -첫 번째 항목에서 사용 중인 엔진이 확인됩니다. 엔진은 특정 소프트웨어 응용프로그램 내에서 Shotgun 도구를 통합하는 기능을 구동합니다. 여기에는 각 소프트웨어 통합에 해당하는 로직이 포함됩니다. 창에 표시된 두 번째 항목은 현재 프로젝트 환경이 위치한 경로를 보여 줍니다. +첫 번째 항목에서 사용 중인 엔진이 확인됩니다. 엔진은 특정 소프트웨어 응용프로그램 내에서 {% include product %} 도구를 통합하는 기능을 구동합니다. 여기에는 각 소프트웨어 통합에 해당하는 로직이 포함됩니다. 창에 표시된 두 번째 항목은 현재 프로젝트 환경이 위치한 경로를 보여 줍니다. ![작업 영역 정보 환경](./images/editing_app_setting/14_shotgun_work_area_info_Environment.png) @@ -219,7 +219,7 @@ frameworks: "@frameworks" 이 전체 행은 Maya 엔진의 구성 설정인 `tk-maya`를 찾기 위해 포함된 파일에서 `settings.tk-maya.project` 블록을 찾는다는 것을 나타냅니다. -Shotgun 툴킷은 YAML 파일에서 간단한 용어를 사용하여 설정의 이름과 설정으로 이동하는 경로를 나타냅니다. **+새 태스크**(+New Task) 버튼 수행 방식을 제어하는 코드 번들이 `tk-multi-workfiles2`로 식별되는 것은 Maya **파일 열기**(File Open) 참조 상자를 볼 때 이미 알고 있습니다. 툴킷 번들은 이러한 식별자를 사용하여 YAML 파일에서 참조됩니다. ‘tk-multi-workfiles2’는 Workfiles 앱 코드 번들의 식별자이며 **+새 태스크**(+New Task) 버튼은 Workfiles 앱의 기능입니다. +{% include product %} 툴킷은 YAML 파일에서 간단한 용어를 사용하여 설정의 이름과 설정으로 이동하는 경로를 나타냅니다. **+새 태스크**(+New Task) 버튼 수행 방식을 제어하는 코드 번들이 `tk-multi-workfiles2`로 식별되는 것은 Maya **파일 열기**(File Open) 참조 상자를 볼 때 이미 알고 있습니다. 툴킷 번들은 이러한 식별자를 사용하여 YAML 파일에서 참조됩니다. ‘tk-multi-workfiles2’는 Workfiles 앱 코드 번들의 식별자이며 **+새 태스크**(+New Task) 버튼은 Workfiles 앱의 기능입니다. tk-maya.yml에서 Workfiles 앱 설정 찾기 @@ -318,7 +318,7 @@ Workfiles 앱의 구성 설정을 수정하여 프로젝트 환경의 버튼 동 ## 작업 중인 환경 검색 -**26단계:** Maya 메뉴 오른쪽 상단에서 **Shotgun**을 선택합니다. +**26단계:** Maya 메뉴 오른쪽 상단에서 **{% include product %}**을 선택합니다. ![아트 에셋 환경](./images/editing_app_setting/23_Art_Asset.png) @@ -334,7 +334,7 @@ Workfiles 앱의 구성 설정을 수정하여 프로젝트 환경의 버튼 동 참고: 각 환경은 독립적이며 프로젝트는 전용 구성을 사용하고 소프트웨어 통합은 프로젝트가 로드될 때 파이프라인 구성에서 해당 특정 소프트웨어의 설정만 읽습니다. -지금까지 파이프라인 구성을 편집하여 앱 설정을 변경했습니다. 이제 본격적으로 Shotgun 툴킷 환경에서 수행할 수 있는 모든 작업에 대해 알아보겠습니다. 다음은 살펴볼 몇 가지 고급 항목입니다. +지금까지 파이프라인 구성을 편집하여 앱 설정을 변경했습니다. 이제 본격적으로 {% include product %} 툴킷 환경에서 수행할 수 있는 모든 작업에 대해 알아보겠습니다. 다음은 살펴볼 몇 가지 고급 항목입니다. ## 고급 항목 diff --git a/docs/ko/guides/pipeline-integrations/getting-started/installing_app.md b/docs/ko/guides/pipeline-integrations/getting-started/installing_app.md index 4e7331a53..2ed4e45d9 100644 --- a/docs/ko/guides/pipeline-integrations/getting-started/installing_app.md +++ b/docs/ko/guides/pipeline-integrations/getting-started/installing_app.md @@ -16,9 +16,9 @@ lang: ko ## 안내서 정보 -이 안내서에서는 Shotgun 툴킷 앱을 기존 파이프라인 구성에 추가하는 방법을 살펴보고 구성 관리 도구에 대해 간단히 알아보겠습니다. +이 안내서에서는 {% include product %} 툴킷 앱을 기존 파이프라인 구성에 추가하는 방법을 살펴보고 구성 관리 도구에 대해 간단히 알아보겠습니다. -여기서 추가할 앱은 Shotgun Python 콘솔 앱입니다. Maya에는 자체 Python 콘솔이 있지만 이 툴킷 앱에는 Maya 콘솔에 없는 일부 기능이 있습니다. +여기서 추가할 앱은 {% include product %} Python 콘솔 앱입니다. Maya에는 자체 Python 콘솔이 있지만 이 툴킷 앱에는 Maya 콘솔에 없는 일부 기능이 있습니다. 이 안내서에서는 [파이프라인 구성 편집](./editing_app_setting.md)안내서에서 생성한 파이프라인 구성을 활용합니다. 이 안내서를 완료하지 않았다면 기존 파이프라인 구성을 사용하여 앱을 추가할 수 있습니다. @@ -26,36 +26,36 @@ lang: ko 이 안내서를 사용하고 툴킷 앱을 설치하려면 다음이 필요합니다. -1. 유효한 [Shotgun](https://www.shotgunsoftware.com/kr/signup/) 사이트. +1. 유효한 [{% include product %}](https://www.shotgunsoftware.com/kr/signup/) 사이트. 2. 지정한 프로젝트에 대한 파이프라인 구성. 또는 [구성 시작하기 안내서](./advanced_config.md)의 연습에서 생성한 구성을 사용하십시오. 3. 파이프라인 구성이 저장된 파일 시스템에 대해 읽기 및 쓰기 권한을 적절하게 설정합니다. -4. Shotgun 데스크톱이 시스템에 설치되어 있어야 합니다. +4. {% include product %} 데스크톱이 시스템에 설치되어 있어야 합니다. 5. 활성 상태의 Maya 멤버쉽. [여기](https://www.autodesk.co.kr/products/maya/free-trial)에서 Maya 30일 체험판을 다운로드하십시오. {% include info title="참고" content="이 안내서는 tk-config-default2 파이프라인 구성을 기반으로 합니다. 이 구성을 수정한 경우 YAML 설정의 파일, 폴더 및 블록의 위치가 여기에 설명된 것과 다를 수 있습니다." %} -## Shotgun 툴킷 앱 정보 +## {% include product %} 툴킷 앱 정보 ### Toolkit 앱의 작동 방식 -파이프라인 구성에서 참조하는 앱은 다양한 위치에서 가져온 것일 수 있습니다. 기본 구성에서 표준인 앱은 Shotgun 앱 스토어에서 가져온 것입니다. 파이프라인 구성의 파일은 툴킷에 "주소록에서 Python 콘솔 앱의 주소를 찾아줄래?"라고 묻는 것처럼 Shotgun 통합이 앱에 액세스하는 방법을 지정합니다. 파이프라인 구성 파일은 툴킷에 특정 앱에 활용되는 코드의 번들을 찾는 위치를 알려줍니다. +파이프라인 구성에서 참조하는 앱은 다양한 위치에서 가져온 것일 수 있습니다. 기본 구성에서 표준인 앱은 {% include product %} 앱 스토어에서 가져온 것입니다. 파이프라인 구성의 파일은 툴킷에 "주소록에서 Python 콘솔 앱의 주소를 찾아줄래?"라고 묻는 것처럼 {% include product %} 통합이 앱에 액세스하는 방법을 지정합니다. 파이프라인 구성 파일은 툴킷에 특정 앱에 활용되는 코드의 번들을 찾는 위치를 알려줍니다. -기본 구성에서 툴킷 앱의 "주소"는 `config/env/includes/app_locations.yml` 파일에 나열되어 있으며 코드를 찾는 위치를 지정합니다. 이러한 "주소"를 [설명자](https://developer.shotgunsoftware.com/tk-core/descriptor.html)라고 합니다. Shotgun 통합은 앱에 대한 코드 번들을 찾는 위치뿐 아니라 앱을 사용하는 환경도 알아야 합니다. +기본 구성에서 툴킷 앱의 "주소"는 `config/env/includes/app_locations.yml` 파일에 나열되어 있으며 코드를 찾는 위치를 지정합니다. 이러한 "주소"를 [설명자](https://developer.shotgunsoftware.com/tk-core/descriptor.html)라고 합니다. {% include product %} 통합은 앱에 대한 코드 번들을 찾는 위치뿐 아니라 앱을 사용하는 환경도 알아야 합니다. -다음은 앱 설치 방법과 Shotgun 통합에 앱을 사용하는 위치를 알리는 방법에 대한 개념적인 개요입니다. 여기서는 구성을 확장하고 툴킷에 설명자를 조회하도록 요청하고 Shotgun에 앱을 사용하는 위치를 알리는 단계를 간략하게 설명합니다. 이 안내서에서는 다음 단계를 자세히 살펴봅니다. +다음은 앱 설치 방법과 {% include product %} 통합에 앱을 사용하는 위치를 알리는 방법에 대한 개념적인 개요입니다. 여기서는 구성을 확장하고 툴킷에 설명자를 조회하도록 요청하고 {% include product %}에 앱을 사용하는 위치를 알리는 단계를 간략하게 설명합니다. 이 안내서에서는 다음 단계를 자세히 살펴봅니다. 1. 추가하려는 앱의 설명자를 결정합니다. 2. 앱 설명자를 추가하려는 활성 파이프라인 구성의 복사본을 생성합니다. 3. 앱의 설명자가 구성에 존재하는지 확인하고, 존재하지 않는 경우 추가합니다. 4. 들여쓰기에 탭이 아니라 공백을 사용하여 YAML 파일의 서식을 올바르게 지정합니다. 5. 앱이 사용되는 환경을 결정합니다. -6. 이러한 환경 내에서 Shotgun이 앱을 사용할 수 있도록 허용하는 설정을 추가합니다. +6. 이러한 환경 내에서 {% include product %}이 앱을 사용할 수 있도록 허용하는 설정을 추가합니다. 7. 새 구성을 테스트합니다. 8. 확장된 구성을 라이브로 적용합니다. ### Python 콘솔 앱에 대한 위치 설명자 찾기 -**1단계:** [앱 및 엔진 페이지](https://support.shotgunsoftware.com/hc/ko/articles/219039798-Applications-that-Toolkit-Integrates-with#tk-maya)를 열고 Maya에서 Shotgun Python 콘솔에 대한 정보를 찾습니다. 제목을 선택합니다. +**1단계:** [앱 및 엔진 페이지](https://support.shotgunsoftware.com/hc/ko/articles/219039798-Applications-that-Toolkit-Integrates-with#tk-maya)를 열고 Maya에서 {% include product %} Python 콘솔에 대한 정보를 찾습니다. 제목을 선택합니다. ![Python 앱](./images/installing_app/1_python_app.png) @@ -67,7 +67,7 @@ lang: ko ### Maya의 프로젝트 환경에서 Python 콘솔 앱이 없음을 확인 -**2단계:** Maya를 실행하고 Shotgun 메뉴 **Shotgun > 프로젝트 the_other_side**(Project the_other_side)를 선택하면 프로젝트 환경에 해당 프로젝트에 사용할 수 있는 앱 목록이 표시됩니다. +**2단계:** Maya를 실행하고 {% include product %} 메뉴 **{% include product %} > 프로젝트 the_other_side**(Project the_other_side)를 선택하면 프로젝트 환경에 해당 프로젝트에 사용할 수 있는 앱 목록이 표시됩니다. ![앱 목록](./images/installing_app/3_list_of_apps.png) @@ -81,11 +81,11 @@ lang: ko ### 파이프라인 구성 목록으로 이동합니다. -**3단계:** Shotgun을 열고 오른쪽 위에서 **관리자(Admin) 메뉴(아바타) > 기본 레이아웃(Default Layouts) > 파이프라인 구성(Pipeline Configuration) > 파이프라인 구성 목록(Pipeline Configuration List)**을 선택합니다. +**3단계:** {% include product %}을 열고 오른쪽 위에서 **관리자(Admin) 메뉴(아바타) > 기본 레이아웃(Default Layouts) > 파이프라인 구성(Pipeline Configuration) > 파이프라인 구성 목록(Pipeline Configuration List)**을 선택합니다. ![파이프라인 구성 목록](./images/installing_app/4_REPLACE_pipeline_configuration_list.png) -이렇게 하면 Shotgun 사이트의 파이프라인 구성이 모두 포함된 상세 목록이 표시됩니다. +이렇게 하면 {% include product %} 사이트의 파이프라인 구성이 모두 포함된 상세 목록이 표시됩니다. **4단계:** 파이프라인 구성 목록이 표시되면 열 헤더의 맨 오른쪽에 있는 **+** 기호를 선택하고 **프로젝트**(Projects) 열을 추가합니다. @@ -119,11 +119,11 @@ lang: ko ## 복제된 구성을 프로젝트와 연결 -**8단계:** Shotgun 데스크톱을 열고 복제된 구성을 생성한 프로젝트를 선택합니다. 오른쪽 위에 있는 **아래쪽 화살표**를 선택하여 이 프로젝트와 연결된 구성을 표시하고 방금 생성한 **Primary Clone Config 2**를 선택합니다. +**8단계:** {% include product %} 데스크톱을 열고 복제된 구성을 생성한 프로젝트를 선택합니다. 오른쪽 위에 있는 **아래쪽 화살표**를 선택하여 이 프로젝트와 연결된 구성을 표시하고 방금 생성한 **Primary Clone Config 2**를 선택합니다. ![복제본 선택](./images/installing_app/11_select_clone.png) -Shotgun 데스크톱이 이제 이 프로젝트에 대해 복제된 구성을 사용합니다. +{% include product %} 데스크톱이 이제 이 프로젝트에 대해 복제된 구성을 사용합니다. ## 파이프라인 구성 편집 @@ -181,7 +181,7 @@ engines: ### YAML 파일 -Shotgun 툴킷 파이프라인 구성은 [YAML](https://yaml.org/spec/1.2/spec.html) 파일에서 단순한 용어를 사용하여 앱과 엔진의 위치와 해당 설정을 식별합니다. +{% include product %} 툴킷 파이프라인 구성은 [YAML](https://yaml.org/spec/1.2/spec.html) 파일에서 단순한 용어를 사용하여 앱과 엔진의 위치와 해당 설정을 식별합니다. 이 블록에서 @@ -190,11 +190,11 @@ Shotgun 툴킷 파이프라인 구성은 [YAML](https://yaml.org/spec/1.2/spec.h * `tk-maya`는 Maya에 대한 툴킷 엔진의 식별자입니다. * `@`은 설정 값을 포함된 파일에서 가져온다는 것을 나타내는 데 사용되는 툴킷 용어입니다. -YAML 파일은 Shotgun 통합으로 통하는 창입니다. 이 파일을 사용하면 파이프라인의 요구사항을 충족하는 작업 환경을 더욱 손쉽게 구성할 수 있습니다. +YAML 파일은 {% include product %} 통합으로 통하는 창입니다. 이 파일을 사용하면 파이프라인의 요구사항을 충족하는 작업 환경을 더욱 손쉽게 구성할 수 있습니다. ### 구성이 툴킷 번들을 참조하는 방식 -Shotgun 통합의 코드는 앱, 엔진 및 프레임워크에 대한 번들로 구성됩니다. 번들은 툴킷의 YAML 파일에서 `tk-maya`, `tk-multi-pythonconsole` 등과 같은 식별자로 참조됩니다. YAML에서 각 번들에 해당하는 블록에는 식별된 번들의 액세스 및 활용 방식을 제어하는 설정이 포함됩니다. +{% include product %} 통합의 코드는 앱, 엔진 및 프레임워크에 대한 번들로 구성됩니다. 번들은 툴킷의 YAML 파일에서 `tk-maya`, `tk-multi-pythonconsole` 등과 같은 식별자로 참조됩니다. YAML에서 각 번들에 해당하는 블록에는 식별된 번들의 액세스 및 활용 방식을 제어하는 설정이 포함됩니다. ## Python 콘솔에 대한 설정을 추가할 위치 @@ -232,7 +232,7 @@ settings.tk-maya.project: tk-multi-workfiles2: "@settings.tk-multi-workfiles2.launch_at_startup" ``` -**Screening Room, Shotgun 패널 및 Workfiles2** 앱의 위치 식별자가 포함된 다른 파일에 나열되어 있고 **About** 앱과 다르게 액세스되는 것을 알 수 있습니다. 이러한 앱에는 추가 설정이 있으므로 정리를 위해 포함된 설정 폴더로 분리되었습니다. +**Screening Room, {% include product %} 패널 및 Workfiles2** 앱의 위치 식별자가 포함된 다른 파일에 나열되어 있고 **About** 앱과 다르게 액세스되는 것을 알 수 있습니다. 이러한 앱에는 추가 설정이 있으므로 정리를 위해 포함된 설정 폴더로 분리되었습니다. {% include info title="참고" content="Python 콘솔 앱은 기본 구성에 이미 있지만, 사용 중인 구성에 이전에 추가한 적이 없는 앱을 추가할 경우 또는 앱의 버전을 변경하고 [중앙 집중식 구성](https://developer.shotgunsoftware.com/tk-core/initializing.html#centralized-configurations)을 사용하는 경우에는 추가 단계를 수행해야 합니다. 터미널을 열고 복제된 구성이 저장된 위치를 찾습니다. 복제된 구성의 루트 폴더에서 다음 명령을 실행합니다.
@@ -248,7 +248,7 @@ Windows: ## Maya에서 변경 사항 보기 -**16단계:** Shotgun 데스크톱을 열고 작업하는 프로젝트를 선택한 후 복제된 구성을 사용하고 있는지 확인합니다. +**16단계:** {% include product %} 데스크톱을 열고 작업하는 프로젝트를 선택한 후 복제된 구성을 사용하고 있는지 확인합니다. 프로젝트 이름 아래, 생성된 복제본의 이름에 파란색 막대가 표시됩니다. @@ -256,7 +256,7 @@ Windows: ![Maya의 복제된 구성](./images/installing_app/14_maya_cloned_config.png) -**17단계:** 데스크톱에서 Maya를 실행하고 **Shotgun > 프로젝트(Project) > …** 메뉴를 선택합니다. +**17단계:** 데스크톱에서 Maya를 실행하고 **{% include product %} > 프로젝트(Project) > …** 메뉴를 선택합니다. 다음에 해당하는 경우: @@ -264,7 +264,7 @@ Windows: * 복제된 구성이 올바르게 확장되었습니다. * 확장된 파일을 저장했습니다. * 복제된 구성과 프로젝트를 연결했습니다. -* Shotgun 데스크톱에서 Maya를 다시 실행했습니다. +* {% include product %} 데스크톱에서 Maya를 다시 실행했습니다. Python 콘솔 앱을 Maya에서 사용할 수 있습니다. @@ -328,7 +328,7 @@ Please type in the id of the configuration to push to (ENTER to exit): ![ID 열](./images/installing_app/17_id_column.png) -ID를 입력하면 Shotgun에서 다음 작업을 수행합니다. +ID를 입력하면 {% include product %}에서 다음 작업을 수행합니다. * 기본 구성 백업 * 복제된 구성 복사 @@ -348,11 +348,11 @@ Push Complete! ## 기본 구성에서 수행한 변경 사항 표시 -**19단계:** Shotgun 데스크톱의 오른쪽 위에 있는 화살표를 클릭하고 **구성**(CONFIGURATION) 목록에서 **기본**(Primary)을 선택합니다. +**19단계:** {% include product %} 데스크톱의 오른쪽 위에 있는 화살표를 클릭하고 **구성**(CONFIGURATION) 목록에서 **기본**(Primary)을 선택합니다. ![Maya 구성 변경](./images/installing_app/18_change_config_maya.png) -**20단계:** 데스크톱에서 Maya를 실행하고 **Shotgun > 프로젝트(Project) > …** 메뉴에서 Shotgun Python 콘솔...(Shotgun Python Console...)을 찾습니다. +**20단계:** 데스크톱에서 Maya를 실행하고 **{% include product %} > 프로젝트(Project) > …** 메뉴에서 {% include product %} Python 콘솔...({% include product %} Python Console...)을 찾습니다. ![Maya 내 앱](./images/installing_app/19_app_in_maya.png) @@ -360,15 +360,15 @@ Python 콘솔 앱이 선택한 프로젝트의 프로젝트 환경에 추가되 ## 고급 항목 -### Shotgun 개발자 커뮤니티 +### {% include product %} 개발자 커뮤니티 -툴킷의 놀라운 특징 중 하나는 모든 작업자가 툴킷 앱을 작성할 수 있다는 점입니다. 앱을 전용 앱으로 사용할 수도 있지만, Shotgun 도구에 추가할 수 있도록 [Shotgun 커뮤니티](https://support.shotgunsoftware.com/hc/ko/articles/219039828)에서 공유할 수도 있습니다. 뛰어난 앱을 만들었으며, 이 앱을 Shotgun 커뮤니티 페이지에서 공유하고 싶다면 [support@shotgunsoftware.com](mailto:support@shotgunsoftware.com)으로 이메일을 보내 주시기 바랍니다. +툴킷의 놀라운 특징 중 하나는 모든 작업자가 툴킷 앱을 작성할 수 있다는 점입니다. 앱을 전용 앱으로 사용할 수도 있지만, {% include product %} 도구에 추가할 수 있도록 [{% include product %} 커뮤니티](https://support.shotgunsoftware.com/hc/ko/articles/219039828)에서 공유할 수도 있습니다. 뛰어난 앱을 만들었으며, 이 앱을 {% include product %} 커뮤니티 페이지에서 공유하고 싶다면 [support@shotgunsoftware.com](mailto:support@shotgunsoftware.com)으로 이메일을 보내 주시기 바랍니다. -표준 툴킷 앱과 Shotgun 커뮤니티에서 생성된 앱에 대한 활발한 논의가 **[shotgun-dev Google 그룹](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups&hl=ko#!forum/shotgun-dev)**에서 진행되고 있습니다. Shotgun 커뮤니티에 새로운 정보 제공 사례가 늘어남에 따라 이러한 기술 및 도구 기반은 끊임없이 확장되고 있습니다. +표준 툴킷 앱과 {% include product %} 커뮤니티에서 생성된 앱에 대한 활발한 논의가 **[{% include product %}-dev Google 그룹](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups&hl=ko#!forum/shotgun-dev)**에서 진행되고 있습니다. {% include product %} 커뮤니티에 새로운 정보 제공 사례가 늘어남에 따라 이러한 기술 및 도구 기반은 끊임없이 확장되고 있습니다. ### 구성을 확장하는 방법 연구 -프로젝트에 사용할 구성을 선택할 때 Python 콘솔 앱을 Shotgun 데스크톱 드롭다운에서 찾을 수 있다는 것을 아셨을 것입니다. +프로젝트에 사용할 구성을 선택할 때 Python 콘솔 앱을 {% include product %} 데스크톱 드롭다운에서 찾을 수 있다는 것을 아셨을 것입니다. ![데스크톱 Python 콘솔](./images/installing_app/20_desktop_python_console.png) diff --git a/docs/ko/guides/pipeline-integrations/getting_started.md b/docs/ko/guides/pipeline-integrations/getting_started.md index 1729a6efb..9bdc7d131 100644 --- a/docs/ko/guides/pipeline-integrations/getting_started.md +++ b/docs/ko/guides/pipeline-integrations/getting_started.md @@ -7,4 +7,4 @@ lang: ko # Getting Started -Shotgun 툴킷은 스튜디오 파이프라인 생성을 위해 매우 세부적인 사항까지 커스터마이즈할 수 있는 일련의 도구를 제공합니다. 이 도구를 통해 아티스트는 컨텐츠 생성 소프트웨어를 종료하지 않고도 Shotgun의 정보에 액세스하고 아티스트 간에 작업을 공유할 수 있습니다. 이 안내서는 실습을 통해 커스텀 툴킷 파이프라인 설정을 시작할 수 있도록 디자인되었습니다. Shotgun 데스크톱 앱을 사용하여 편집 가능한 프로젝트 구성을 생성하고, 기존 앱에서 설정을 수정하고, 다른 아티스트 환경에 툴킷 앱을 추가하여 커스텀 파이프라인을 디자인할 수 있습니다. 각 안내서는 이전 안내서를 토대로 작성되지만 어디서나 이동할 수 있는 지침이 포함되어 있습니다. +{% include product %} 툴킷은 스튜디오 파이프라인 생성을 위해 매우 세부적인 사항까지 커스터마이즈할 수 있는 일련의 도구를 제공합니다. 이 도구를 통해 아티스트는 컨텐츠 생성 소프트웨어를 종료하지 않고도 {% include product %}의 정보에 액세스하고 아티스트 간에 작업을 공유할 수 있습니다. 이 안내서는 실습을 통해 커스텀 툴킷 파이프라인 설정을 시작할 수 있도록 디자인되었습니다. {% include product %} 데스크톱 앱을 사용하여 편집 가능한 프로젝트 구성을 생성하고, 기존 앱에서 설정을 수정하고, 다른 아티스트 환경에 툴킷 앱을 추가하여 커스텀 파이프라인을 디자인할 수 있습니다. 각 안내서는 이전 안내서를 토대로 작성되지만 어디서나 이동할 수 있는 지침이 포함되어 있습니다. diff --git a/docs/ko/guides/pipeline-integrations/workflows/pipeline-tutorial.md b/docs/ko/guides/pipeline-integrations/workflows/pipeline-tutorial.md index b3b9209d2..f56eb6cbd 100644 --- a/docs/ko/guides/pipeline-integrations/workflows/pipeline-tutorial.md +++ b/docs/ko/guides/pipeline-integrations/workflows/pipeline-tutorial.md @@ -9,7 +9,7 @@ lang: ko 이 튜토리얼에서는 애니메이션이나 시각 효과 프로덕션을 위한 단순하면서도 전형적인 파이프라인을 빌드하는 방법을 다룹니다. 이 튜토리얼을 수행하면 에셋을 모델링에서부터 모양 개발, 그리고 프로덕션 씬으로 푸시하는 데 필요한 모든 부분을 제공하는 파이프라인을 빌드하게 됩니다. -이 파이프라인에서 다루는 대부분의 워크플로우는 Shotgun의 기본 제공 통합에서 기본적으로 작동합니다. 이 튜토리얼은 스튜디오에서 커스텀 솔루션을 많이 빌드하는 파이프라인 부분에 대해 툴킷 플랫폼을 사용하여 아티스트 워크플로우를 커스터마이즈하는 프로세스를 안내합니다. +이 파이프라인에서 다루는 대부분의 워크플로우는 {% include product %}의 기본 제공 통합에서 기본적으로 작동합니다. 이 튜토리얼은 스튜디오에서 커스텀 솔루션을 많이 빌드하는 파이프라인 부분에 대해 툴킷 플랫폼을 사용하여 아티스트 워크플로우를 커스터마이즈하는 프로세스를 안내합니다. 다음은 이 튜토리얼에서 빌드할 파이프라인의 개략적인 뷰입니다. @@ -23,21 +23,21 @@ lang: ko ## 필수 요건 -* **작업 중인 Shotgun 프로젝트** - 이 튜토리얼에서는 프로덕션 데이터 트래킹 및 관리를 위해 Shotgun을 사용하는 환경이라고 가정합니다. +* **작업 중인 {% include product %} 프로젝트** - 이 튜토리얼에서는 프로덕션 데이터 트래킹 및 관리를 위해 {% include product %}을 사용하는 환경이라고 가정합니다. -* **Shotgun 통합 이해** - Shotgun은 통합 기능을 통해 수동 구성이 필요 없는 몇 가지 간단한 프로덕션 워크플로우를 제공합니다. 이 튜토리얼에 설명된 수동 구성 및 커스터마이제이션에 대해 자세히 알아보기 전에 이러한 워크플로우의 기능 및 범위를 이해해야 합니다. Shotgun 통합에 대한 자세한 정보는 [여기](https://support.shotgunsoftware.com/hc/ko/articles/115000068574)를 참조하십시오. +* **{% include product %} 통합 이해** - {% include product %}은 통합 기능을 통해 수동 구성이 필요 없는 몇 가지 간단한 프로덕션 워크플로우를 제공합니다. 이 튜토리얼에 설명된 수동 구성 및 커스터마이제이션에 대해 자세히 알아보기 전에 이러한 워크플로우의 기능 및 범위를 이해해야 합니다. {% include product %} 통합에 대한 자세한 정보는 [여기](https://support.shotgunsoftware.com/hc/ko/articles/115000068574)를 참조하십시오. -* **Maya 및 Nuke 환경** - 이 튜토리얼은 Nuke와 Maya를 사용하여 간단한 파이프라인을 빌드하도록 설계되었습니다. Shotgun에서 제공하는 통합을 커스터마이즈하기 위해서는 이러한 패키지를 기본적으로 이해하고 있어야 합니다. +* **Maya 및 Nuke 환경** - 이 튜토리얼은 Nuke와 Maya를 사용하여 간단한 파이프라인을 빌드하도록 설계되었습니다. {% include product %}에서 제공하는 통합을 커스터마이즈하기 위해서는 이러한 패키지를 기본적으로 이해하고 있어야 합니다. -* **Python 실무 지식** - 이 튜토리얼에서는 Python으로 작성된 "후크"를 통해 Shotgun 통합 기능을 수정해야 합니다. +* **Python 실무 지식** - 이 튜토리얼에서는 Python으로 작성된 "후크"를 통해 {% include product %} 통합 기능을 수정해야 합니다. * **YAML 사용 경험** - 빌드할 파이프라인의 대부분의 구성은 YAML 파일을 수정하여 처리됩니다. ## 추가 리소스 -* [Shotgun 지원 사이트](https://support.shotgunsoftware.com/hc/ko) +* [{% include product %} 지원 사이트](https://support.shotgunsoftware.com/hc/ko) -* [Shotgun 통합](https://www.shotgunsoftware.com/kr/integrations/) +* [{% include product %} 통합](https://www.shotgunsoftware.com/kr/integrations/) * [사용자 안내서](https://support.shotgunsoftware.com/hc/ko/articles/115000068574) @@ -47,7 +47,7 @@ lang: ko # 프로젝트 작성 및 설정 -이 튜토리얼에서는 Shotgun에 새 프로젝트를 만들고 프로덕션을 위해 시작할 준비가 된 것처럼 구성해야 합니다. 여기에는 필요한 모든 Shotgun 엔티티가 제대로 배치되고 링크되어 있는지 확인하는 것도 포함됩니다. 이 튜토리얼에서는 에셋, 시퀀스, 샷 및 태스크 엔티티가 필요하며 새 프로젝트에서 기본값으로 사용할 수 있어야 합니다. 다음을 만듭니다. +이 튜토리얼에서는 {% include product %}에 새 프로젝트를 만들고 프로덕션을 위해 시작할 준비가 된 것처럼 구성해야 합니다. 여기에는 필요한 모든 {% include product %} 엔티티가 제대로 배치되고 링크되어 있는지 확인하는 것도 포함됩니다. 이 튜토리얼에서는 에셋, 시퀀스, 샷 및 태스크 엔티티가 필요하며 새 프로젝트에서 기본값으로 사용할 수 있어야 합니다. 다음을 만듭니다. * 두 개의 **에셋**: @@ -61,7 +61,7 @@ lang: ko * 파이프라인 단계별 **태스크** -다음은 구성된 프로젝트 엔티티가 Shotgun에서 어떻게 표시되는지 보여 주는 일부 스크린샷입니다. +다음은 구성된 프로젝트 엔티티가 {% include product %}에서 어떻게 표시되는지 보여 주는 일부 스크린샷입니다. {% include figure src="./images/tutorial/image_1.png" caption="주전자 및 테이블 에셋" %} @@ -71,25 +71,25 @@ lang: ko ## 소프트웨어 시작 관리자 -다음으로, Shotgun 데스크톱에서 Maya 및 Nuke를 시작할 수 있는지 확인해야 합니다. 이러한 각 패키지는 데스크톱에서 해당 아이콘을 클릭하여 시작할 수 있습니다. 각 패키지의 적절한 버전이 시작되는지 확인합니다. +다음으로, {% include product %} 데스크톱에서 Maya 및 Nuke를 시작할 수 있는지 확인해야 합니다. 이러한 각 패키지는 데스크톱에서 해당 아이콘을 클릭하여 시작할 수 있습니다. 각 패키지의 적절한 버전이 시작되는지 확인합니다. -응용프로그램이 데스크톱에 표시되지 않거나 예상한 버전이 시작되지 않을 경우 소프트웨어 엔티티를 통해 Shotgun에서의 시작을 수동으로 구성해야 할 수 있습니다. +응용프로그램이 데스크톱에 표시되지 않거나 예상한 버전이 시작되지 않을 경우 소프트웨어 엔티티를 통해 {% include product %}에서의 시작을 수동으로 구성해야 할 수 있습니다. {% include figure src="./images/tutorial/image_4.png" caption="Shotgun에 정의된 기본 소프트웨어 엔티티" %} -소프트웨어 엔티티는 프로덕션에 사용할 DCC 패키지를 구동하는 데 사용됩니다. 기본적으로 통합은 표준 설치 위치에서 이러한 패키지를 검색하고 데스크톱을 통해 시작할 수 있도록 합니다. 둘 이상의 버전을 설치하거나 표준 위치가 아닌 곳에 설치한 경우 아티스트의 시작 환경을 조정하기 위해 Shotgun의 해당 소프트웨어 엔티티 항목을 업데이트해야 할 수도 있습니다. +소프트웨어 엔티티는 프로덕션에 사용할 DCC 패키지를 구동하는 데 사용됩니다. 기본적으로 통합은 표준 설치 위치에서 이러한 패키지를 검색하고 데스크톱을 통해 시작할 수 있도록 합니다. 둘 이상의 버전을 설치하거나 표준 위치가 아닌 곳에 설치한 경우 아티스트의 시작 환경을 조정하기 위해 {% include product %}의 해당 소프트웨어 엔티티 항목을 업데이트해야 할 수도 있습니다. 소프트웨어 엔티티 및 적절한 구성 방법에 대한 자세한 정보는 [통합 관리자 안내서](https://support.shotgunsoftware.com/hc/ko/articles/115000067493-Integrations-Admin-Guide#Configuring%20software%20launches)를 참조하십시오. 예상한 방식으로 DCC가 시작되면 다음 섹션으로 진행할 수 있습니다. # 구성 -구성은 프로젝트에 대한 아티스트 워크플로우를 정의합니다. 여기에는 아티스트가 시작하는 DCC 내에 포함할 Shotgun 통합, 프로젝트의 폴더 구조 정의 방법 및 아티스트가 데이터를 공유할 때 만든 파일 및 폴더에 대한 명명 규칙 지정이 포함됩니다. +구성은 프로젝트에 대한 아티스트 워크플로우를 정의합니다. 여기에는 아티스트가 시작하는 DCC 내에 포함할 {% include product %} 통합, 프로젝트의 폴더 구조 정의 방법 및 아티스트가 데이터를 공유할 때 만든 파일 및 폴더에 대한 명명 규칙 지정이 포함됩니다. -기본적으로 모든 새 프로젝트는 다양한 기성 소프트웨어 패키지를 사용하여 아티스트 간에 공유 파일에 대한 기본 워크플로우를 제공하는 기본 [Shotgun 통합](https://support.shotgunsoftware.com/hc/ko/articles/115000068574)을 사용하도록 구성됩니다. 다음 섹션에서는 프로젝트의 파이프라인 구성을 인계받고 스튜디오에 맞게 커스터마이즈하는 방법에 대해 설명합니다. +기본적으로 모든 새 프로젝트는 다양한 기성 소프트웨어 패키지를 사용하여 아티스트 간에 공유 파일에 대한 기본 워크플로우를 제공하는 기본 [{% include product %} 통합](https://support.shotgunsoftware.com/hc/ko/articles/115000068574)을 사용하도록 구성됩니다. 다음 섹션에서는 프로젝트의 파이프라인 구성을 인계받고 스튜디오에 맞게 커스터마이즈하는 방법에 대해 설명합니다. ## 프로젝트 구성 인계받기 -Shotgun 데스크톱(데스크톱)을 사용하여 프로젝트의 구성을 인계받습니다. 데스크톱 내에서 마우스 오른쪽 버튼을 클릭하거나 오른쪽 하단의 사용자 아이콘을 클릭하면 팝업 메뉴가 표시됩니다. **고급 프로젝트 설정...(Advanced project setup…)** 옵션을 선택하고 마법사를 수행하여 프로젝트 구성을 로컬로 설치합니다. 아래 이미지는 필요한 단계를 보여 줍니다. 통합 관리자 안내서에 설명된 [파이프라인 구성 가져오기](https://support.shotgunsoftware.com/hc/ko/articles/115000067493-Integrations-Admin-Guide#Taking%20over%20a%20Pipeline%20Configuration) 단계를 수행할 수도 있습니다. +{% include product %} 데스크톱(데스크톱)을 사용하여 프로젝트의 구성을 인계받습니다. 데스크톱 내에서 마우스 오른쪽 버튼을 클릭하거나 오른쪽 하단의 사용자 아이콘을 클릭하면 팝업 메뉴가 표시됩니다. **고급 프로젝트 설정...(Advanced project setup…)** 옵션을 선택하고 마법사를 수행하여 프로젝트 구성을 로컬로 설치합니다. 아래 이미지는 필요한 단계를 보여 줍니다. 통합 관리자 안내서에 설명된 [파이프라인 구성 가져오기](https://support.shotgunsoftware.com/hc/ko/articles/115000067493-Integrations-Admin-Guide#Taking%20over%20a%20Pipeline%20Configuration) 단계를 수행할 수도 있습니다. {% include figure src="./images/tutorial/image_5.png" caption="데스크톱 팝업 메뉴에서 **고급 프로젝트 설정...(Advanced project setup…)**을 선택합니다" %} @@ -97,7 +97,7 @@ Shotgun 데스크톱(데스크톱)을 사용하여 프로젝트의 구성을 인 {% include figure src="./images/tutorial/wizard_02.png" caption="**기본값 구성**(Default configuration)을 선택합니다." %} -이번에 처음으로 Shotgun 프로젝트를 설정하는 경우 프로젝트 데이터의 저장소 위치를 정의하라는 메시지가 표시될 수도 있습니다. 아니면 기존 저장소 위치를 선택할 수 있습니다. +이번에 처음으로 {% include product %} 프로젝트를 설정하는 경우 프로젝트 데이터의 저장소 위치를 정의하라는 메시지가 표시될 수도 있습니다. 아니면 기존 저장소 위치를 선택할 수 있습니다. {% include figure src="./images/tutorial/wizard_03.png" caption="새 저장소를 만듭니다." %} @@ -105,7 +105,7 @@ Shotgun 데스크톱(데스크톱)을 사용하여 프로젝트의 구성을 인 {% include figure src="./images/tutorial/wizard_05.png" caption="사용할 운영 체제에서 이 저장소에 액세스할 수 있는 경로를 설정합니다." %} -**사이트 기본 설정**(Site Preferences)의 **파일 관리**(File Management) 섹션에서 Shotgun 사이트에 대한 저장소를 보고 편집할 수 있습니다. 이러한 설정에 대한 자세한 내용은 [여기](https://support.shotgunsoftware.com/hc/ko/articles/219030938)에서 확인할 수 있습니다. +**사이트 기본 설정**(Site Preferences)의 **파일 관리**(File Management) 섹션에서 {% include product %} 사이트에 대한 저장소를 보고 편집할 수 있습니다. 이러한 설정에 대한 자세한 내용은 [여기](https://support.shotgunsoftware.com/hc/ko/articles/219030938)에서 확인할 수 있습니다. 저장소 위치를 선택했으므로 이제 해당 위치에서 새 프로젝트에 대한 디렉토리 이름을 선택합니다. @@ -121,7 +121,7 @@ Shotgun 데스크톱(데스크톱)을 사용하여 프로젝트의 구성을 인 위 화면에서 **설정 실행(Run Setup)**을 클릭하면 데스크톱에서 구성에 필요한 모든 구성 요소를 다운로드하고 설치하기 시작합니다. 설치 프로세스를 완료하는 데 몇 분 정도 걸릴 수 있습니다. 설치가 완료되면 전체 프로젝트 구성의 로컬 사본이 생기고 이를 다음 단계에서 수정합니다. -데스크톱 설치 튜토리얼에서 지정한 구성 위치는 Shotgun에서 해당 프로젝트에 대한 파이프라인 구성(Pipeline Configurations) 페이지에 기록됩니다. +데스크톱 설치 튜토리얼에서 지정한 구성 위치는 {% include product %}에서 해당 프로젝트에 대한 파이프라인 구성(Pipeline Configurations) 페이지에 기록됩니다. {% include figure src="./images/tutorial/image_10.png" caption="Shotgun에서 파이프라인 구성 엔티티 복제" %} @@ -157,9 +157,9 @@ Shotgun 데스크톱(데스크톱)을 사용하여 프로젝트의 구성을 인 # 파이프라인 빌드 -이제 파이프라인을 빌드할 준비가 되었습니다. Shotgun에서 프로젝트를 설정하고 데스크톱을 통해 Maya & Nuke를 시작할 수 있으며 프로젝트 구성을 제어했습니다. 또한 구성의 기본 구조를 이해하고 아티스트 워크플로우를 구체화할 준비가 되었습니다. +이제 파이프라인을 빌드할 준비가 되었습니다. {% include product %}에서 프로젝트를 설정하고 데스크톱을 통해 Maya & Nuke를 시작할 수 있으며 프로젝트 구성을 제어했습니다. 또한 구성의 기본 구조를 이해하고 아티스트 워크플로우를 구체화할 준비가 되었습니다. -다음 섹션에서는 각 파이프라인 단계를 수행하면서 기본 제공 기능을 중점적으로 설명하고 Shotgun 통합을 커스터마이즈하는 프로세스를 안내합니다. 이 섹션을 마칠 때쯤에는 완벽한 기능을 갖춘 간단한 전체 프로덕션 파이프라인을 갖게 됩니다. 또한 아티스트가 프로덕션에서 작업할 때 수행하는 단계도 파악할 수 있습니다. +다음 섹션에서는 각 파이프라인 단계를 수행하면서 기본 제공 기능을 중점적으로 설명하고 {% include product %} 통합을 커스터마이즈하는 프로세스를 안내합니다. 이 섹션을 마칠 때쯤에는 완벽한 기능을 갖춘 간단한 전체 프로덕션 파이프라인을 갖게 됩니다. 또한 아티스트가 프로덕션에서 작업할 때 수행하는 단계도 파악할 수 있습니다. {% include info title="참고" content="이 튜토리얼의 모든 코드 및 구성은 [**`tk-config-default2`** 리포지토리](https://github.com/shotgunsoftware/tk-config-default2/tree/pipeline_tutorial/)의 **`pipeline_tutorial`** 분기에서 찾을 수 있습니다. 파일이 있을 위치, 코드를 추가할 위치 등의 힌트가 필요한 경우 이 분기를 활용하십시오." %} @@ -167,9 +167,9 @@ Shotgun 데스크톱(데스크톱)을 사용하여 프로젝트의 구성을 인 간단한 파이프라인의 첫 번째 단계는 모델링입니다. 이 섹션에서는 프로젝트의 주전자 에셋에 대한 첫 번째 반복을 만듭니다. 이를 프로젝트의 폴더 구조로 디스크에 저장한 다음 게시합니다. -먼저 Shotgun 데스크톱에서 Maya를 시작합니다. +먼저 {% include product %} 데스크톱에서 Maya를 시작합니다. -Maya가 완전히 로드되면 파일 열기(File Open) 대화상자가 나타납니다. 이 대화상자를 사용하여 프로젝트 내의 기존 Maya 파일을 찾을 수 있습니다. 또한 Shotgun 통합에서 인식하는 새 파일을 만들 수 있습니다. +Maya가 완전히 로드되면 파일 열기(File Open) 대화상자가 나타납니다. 이 대화상자를 사용하여 프로젝트 내의 기존 Maya 파일을 찾을 수 있습니다. 또한 {% include product %} 통합에서 인식하는 새 파일을 만들 수 있습니다. 에셋(Assets) 탭을 선택하고 주전자의 모델링 태스크로 드릴다운합니다. 이 태스크에 대한 아티스트 작업 파일이 아직 없으므로 **+ 새 파일(+ New File)** 버튼을 클릭합니다. @@ -177,13 +177,13 @@ Maya가 완전히 로드되면 파일 열기(File Open) 대화상자가 나타 이 버튼을 클릭하여 비어 있는 새 Maya 세션을 만들고 현재 작업 중인 컨텍스트를 주전자 에셋의 모델 태스크로 설정합니다. -{%include info title="참고" content="이 튜토리얼에서 언제든지 Maya 또는 Nuke의 Shotgun 메뉴를 통해 Shotgun 패널을 시작할 수 있습니다. 이 패널에서는 DCC를 종료하지 않고 프로젝트 데이터에 뷰를 제공합니다. 현재 작업 중인 컨텍스트와 해당 컨텍스트 내의 최근 액티비티가 표시됩니다. 또한 패널로 직접 피드백에 대한 노트를 추가할 수 있습니다. 자세한 정보는 [Shotgun 패널 설명서](https://support.shotgunsoftware.com/hc/ko/articles/115000068574-Integrations-user-guide#The%20Shotgun%20Panel)를 참조하십시오." %} +{%include info title="참고" content="이 튜토리얼에서 언제든지 Maya 또는 Nuke의 Shotgun 메뉴를 통해 shotgun 패널을 시작할 수 있습니다. 이 패널에서는 DCC를 종료하지 않고 프로젝트 데이터에 뷰를 제공합니다. 현재 작업 중인 컨텍스트와 해당 컨텍스트 내의 최근 액티비티가 표시됩니다. 또한 패널로 직접 피드백에 대한 노트를 추가할 수 있습니다. 자세한 정보는 [Shotgun 패널 설명서](https://support.shotgunsoftware.com/hc/ko/articles/115000068574-Integrations-user-guide#The%20Shotgun%20Panel)를 참조하십시오." %} 다음으로, 주전자를 모델링하거나 제공된 주전자를 [다운로드](https://raw.githubusercontent.com/shotgunsoftware/tk-config-default2/pipeline_tutorial/resources/teapot.obj)하여 가져옵니다. {% include figure src="./images/tutorial/image_14.png" %} -주전자 모델이 만족스러우면 **Shotgun > 파일 저장...(File Save…)** 메뉴 액션을 선택합니다. 이 대화상자에 지정된 이름, 버전 및 유형으로 파일을 저장할지 묻는 메시지가 표시됩니다. +주전자 모델이 만족스러우면 **{% include product %} > 파일 저장...(File Save…)** 메뉴 액션을 선택합니다. 이 대화상자에 지정된 이름, 버전 및 유형으로 파일을 저장할지 묻는 메시지가 표시됩니다. {% include figure src="./images/tutorial/image_15.png" %} @@ -201,31 +201,31 @@ Maya가 완전히 로드되면 파일 열기(File Open) 대화상자가 나타 **저장(Save)** 버튼을 클릭하여 주전자 모델을 저장합니다. -이때 주의해야 할 중요한 점은 방금 완료한 단계가 아티스트가 파이프라인 전체에서 작업 파일을 열고 저장할 때 수행할 단계와 동일하다는 점입니다. 파일 열기(File Open) 및 파일 저장(File Save) 대화상자는 Workfiles 앱의 일부입니다. 이 "다중" 앱은 Shotgun 통합에서 지원하는 모든 DCC에서 실행되며 모든 아티스트에 대해 일관된 워크플로우를 제공합니다. +이때 주의해야 할 중요한 점은 방금 완료한 단계가 아티스트가 파이프라인 전체에서 작업 파일을 열고 저장할 때 수행할 단계와 동일하다는 점입니다. 파일 열기(File Open) 및 파일 저장(File Save) 대화상자는 Workfiles 앱의 일부입니다. 이 "다중" 앱은 {% include product %} 통합에서 지원하는 모든 DCC에서 실행되며 모든 아티스트에 대해 일관된 워크플로우를 제공합니다. 다음 단계는 주전자를 약간 변경하는 것입니다. 뚜껑 지오메트리가 나중에 리깅할 수 있도록 모델의 나머지 부분과 분리되는지 확인합니다. {% include figure src="./images/tutorial/image_16.png" %} -작업이 만족스러우면 **Shotgun > 파일 저장...(File Save…)** 메뉴 액션을 다시 실행합니다. 이번 대화상자에서는 기본적으로 버전 번호가 2로 설정됩니다. 파일 버전 자동 증분을 사용하면 아티스트가 수행한 전체 작업 내역을 관리할 수 있습니다. 저장(Save) 버튼을 클릭합니다. +작업이 만족스러우면 **{% include product %} > 파일 저장...(File Save…)** 메뉴 액션을 다시 실행합니다. 이번 대화상자에서는 기본적으로 버전 번호가 2로 설정됩니다. 파일 버전 자동 증분을 사용하면 아티스트가 수행한 전체 작업 내역을 관리할 수 있습니다. 저장(Save) 버튼을 클릭합니다. {% include figure src="./images/tutorial/image_17.png" %} 주전자 모델을 버전 2로 저장하고 나면 튜토리얼의 이번 섹션에서 마지막 단계를 진행할 준비가 된 것입니다. -이제 주전자 모델이 준비되면 서페이스 처리 및 리깅할 수 있도록 게시해야 합니다. 게시하려면 **Shotgun > 게시...(Publish…)** 메뉴 액션을 클릭합니다. Publish 앱 대화상자가 표시됩니다. +이제 주전자 모델이 준비되면 서페이스 처리 및 리깅할 수 있도록 게시해야 합니다. 게시하려면 **{% include product %} > 게시...(Publish…)** 메뉴 액션을 클릭합니다. Publish 앱 대화상자가 표시됩니다. {% include figure src="./images/tutorial/image_18.png" %} 대화상자에 게시될 항목의 트리가 표시됩니다. 트리에서 일부는 게시할 항목을 나타내고 일부는 게시 작업 중 수행할 액션을 나타냅니다. -대화상자의 왼쪽에 현재 Maya 세션을 나타내는 항목이 표시됩니다. 그 아래에 **Shotgun에 게시(Publish to Shotgun)** 하위 액션이 표시됩니다. **모든 세션 지오메트리(All Session Geometry)**를 나타내는 추가 항목이 현재 세션의 하위 항목으로 표시됩니다. 여기에도 **Shotgun에 게시(Publish to Shotgun)** 하위 액션이 있습니다. +대화상자의 왼쪽에 현재 Maya 세션을 나타내는 항목이 표시됩니다. 그 아래에 **{% include product %}에 게시(Publish to Shotgun)** 하위 액션이 표시됩니다. **모든 세션 지오메트리(All Session Geometry)**를 나타내는 추가 항목이 현재 세션의 하위 항목으로 표시됩니다. 여기에도 **{% include product %}에 게시(Publish to Shotgun)** 하위 액션이 있습니다. {% include info title="참고" content="**모든 세션 지오메트리**(All Session Geometry) 항목이 표시되지 않으면 Maya에서 [Alembic 내보내기 플러그인이 활성화되어 있는지](https://support.shotgunsoftware.com/hc/ko/articles/219039928-Publishing-Alembic-From-Maya#Before%20You%20Begin) 확인합니다." %} 트리 왼쪽의 항목을 클릭하여 Publish 앱을 탐색합니다. 수행할 항목을 선택하면 게시되는 항목에 대한 설명을 입력할 수 있습니다. 오른쪽의 카메라 아이콘을 클릭하여 항목과 관련된 스크린샷을 찍을 수 있습니다. -준비가 되었으면 오른쪽 하단에 있는**게시(Publish)** 버튼을 클릭하여 현재 작업 파일과 주전자 지오메트리를 게시합니다. 완료되면 Shotgun에서 주전자 에셋을 검색하여 게시가 성공적으로 완료되었는지 확인할 수 있습니다. +준비가 되었으면 오른쪽 하단에 있는**게시(Publish)** 버튼을 클릭하여 현재 작업 파일과 주전자 지오메트리를 게시합니다. 완료되면 {% include product %}에서 주전자 에셋을 검색하여 게시가 성공적으로 완료되었는지 확인할 수 있습니다. {% include figure src="./images/tutorial/image_19.png" %} @@ -259,15 +259,15 @@ File Save 대화상자와 달리, 게시할 때는 이름, 버전 또는 파일 이 섹션은 모델링 섹션에서 배운 내용을 기반으로 합니다. Loader 앱을 사용하여 이전 섹션에서 만든 주전자 모델을 로드하는 방법을 배우게 됩니다. 또한 Publish 앱을 커스터마이즈하여 주전자 셰이더를 게시하는 방법도 배우게 됩니다. -데스크톱에서 Maya를 실행하여 시작합니다. 이전 섹션의 작업 후에 계속 Maya가 열려 있는 경우 Maya를 다시 시작할 필요가 없습니다. Maya가 열려 있으면 **Shotgun > 파일 열기...(File Open…)** 메뉴 항목을 사용하여 Workfiles 앱을 엽니다. 모델링 섹션에서와 마찬가지로 에셋(Assets) 탭을 사용하여 주전자 에셋의 태스크로 드릴다운합니다. 이때 서페이스 처리 태스크를 선택하고 **+ 새 파일(+ New File)**을 클릭합니다. +데스크톱에서 Maya를 실행하여 시작합니다. 이전 섹션의 작업 후에 계속 Maya가 열려 있는 경우 Maya를 다시 시작할 필요가 없습니다. Maya가 열려 있으면 **{% include product %} > 파일 열기...(File Open…)** 메뉴 항목을 사용하여 Workfiles 앱을 엽니다. 모델링 섹션에서와 마찬가지로 에셋(Assets) 탭을 사용하여 주전자 에셋의 태스크로 드릴다운합니다. 이때 서페이스 처리 태스크를 선택하고 **+ 새 파일(+ New File)**을 클릭합니다. {% include figure src="./images/tutorial/image_21.png" width="450px" %} -이제 주전자의 서페이스 처리 태스크에서 작업하게 됩니다. 올바른 프로덕션 컨텍스트에 있는지 쉽게 확인하는 방법은 Shotgun 메뉴의 첫 번째 항목을 확인하는 것입니다. +이제 주전자의 서페이스 처리 태스크에서 작업하게 됩니다. 올바른 프로덕션 컨텍스트에 있는지 쉽게 확인하는 방법은 {% include product %} 메뉴의 첫 번째 항목을 확인하는 것입니다. {% include figure src="./images/tutorial/image_22.png" %} -다음으로 주전자 모델을 새 서페이스 처리 작업 파일로 로드해야 합니다. 이렇게 하려면 Maya의 **Shotgun > 로드...(Load…)** 메뉴 항목을 통해 Loader 앱을 시작합니다. +다음으로 주전자 모델을 새 서페이스 처리 작업 파일로 로드해야 합니다. 이렇게 하려면 Maya의 **{% include product %} > 로드...(Load…)** 메뉴 항목을 통해 Loader 앱을 시작합니다. {% include figure src="./images/tutorial/image_23.png" %} @@ -283,7 +283,7 @@ Loader 앱의 레이아웃은 Workfiles 앱과 유사하지만 지금은 작업 파이프라인을 빌드할 때 셰이더 관리는 시간이 오래 걸리는 복잡한 태스크일 수 있습니다. 이는 특히 스튜디오에만 해당되는 경우가 많습니다. 왜냐하면 제공되는 Maya 통합에서 셰이더 또는 텍스처 관리 기본 기능을 처리하지 않기 때문입니다. -계속하기 전에 **Shotgun > 파일 저장...(File Save…)** 메뉴 액션을 사용하여 현재 세션을 저장합니다. +계속하기 전에 **{% include product %} > 파일 저장...(File Save…)** 메뉴 액션을 사용하여 현재 세션을 저장합니다. ### 커스텀 셰이더 게시 @@ -445,9 +445,9 @@ Loader 앱의 레이아웃은 Workfiles 앱과 유사하지만 지금은 작업 {% include info title="참고" content="구성을 커스터마이즈하는 동안 Maya를 닫아도 괜찮습니다. 간단히 Maya를 다시 시작하고 파일 열기(File Open) 대화상자를 사용하여 서페이스 처리 작업 파일을 열 수 있습니다. 아래의 다시 로드 단계는 건너뛸 수 있습니다." %} -##### Shotgun 통합 다시 로드 +##### {% include product %} 통합 다시 로드 -커스터마이제이션을 시도하려면 Maya 세션에서 통합을 다시 로드해야 합니다. 이렇게 하려면 **Shotgun > [태스크 이름(Task Name)] > 작업 영역 정보...(Work Area Info…)** 메뉴 액션을 클릭합니다. +커스터마이제이션을 시도하려면 Maya 세션에서 통합을 다시 로드해야 합니다. 이렇게 하려면 **{% include product %} > [태스크 이름(Task Name)] > 작업 영역 정보...(Work Area Info…)** 메뉴 액션을 클릭합니다. {% include figure src="./images/tutorial/image_30.png" %} @@ -457,14 +457,14 @@ Loader 앱의 레이아웃은 Workfiles 앱과 유사하지만 지금은 작업 ### 셰이더 네트워크 게시 -이제 프로젝트 구성 변경 결과를 보겠습니다. Shotgun 메뉴에서 Publish 앱을 시작합니다. 다음과 같이 **Publish Shaders** 플러그인이 연결된 수집된 주전자 메쉬 항목이 표시됩니다. +이제 프로젝트 구성 변경 결과를 보겠습니다. {% include product %} 메뉴에서 Publish 앱을 시작합니다. 다음과 같이 **Publish Shaders** 플러그인이 연결된 수집된 주전자 메쉬 항목이 표시됩니다. {% include figure src="./images/tutorial/image_32.png" %} -작업 설명을 입력하고 게시된 파일과 연결할 서페이스 처리된 주전자의 썸네일을 캡처합니다. 마지막으로, 게시(Publish)를 클릭하여 주전자 셰이더를 디스크로 내보내고 파일을 Shotgun의 게시로 등록합니다. 완료되면 세션 게시 플러그인이 자동으로 작업 파일을 다음 사용 가능한 버전으로 저장했는지 확인합니다. 지금까지가 Shotgun 통합에서 지원되는 모든 DCC 내의 기본 동작입니다. +작업 설명을 입력하고 게시된 파일과 연결할 서페이스 처리된 주전자의 썸네일을 캡처합니다. 마지막으로, 게시(Publish)를 클릭하여 주전자 셰이더를 디스크로 내보내고 파일을 {% include product %}의 게시로 등록합니다. 완료되면 세션 게시 플러그인이 자동으로 작업 파일을 다음 사용 가능한 버전으로 저장했는지 확인합니다. 지금까지가 {% include product %} 통합에서 지원되는 모든 DCC 내의 기본 동작입니다. -이제 Shotgun에서 주전자 에셋을 검색하여 모두 예상대로 작동되는지 확인할 수 있습니다. +이제 {% include product %}에서 주전자 에셋을 검색하여 모두 예상대로 작동되는지 확인할 수 있습니다. {% include figure src="./images/tutorial/image_33.png" %} @@ -476,9 +476,9 @@ Loader 앱의 레이아웃은 Workfiles 앱과 유사하지만 지금은 작업 ## 리깅 워크플로우 -이제는 Shotgun에서 제공하는 Workfile 및 Publish 앱을 사용하여 작업 파일을 열거나 만들고 저장하고 게시하는 것이 어렵지 않을 것입니다. 또한 Loader 앱을 사용하여 업스트림에서 게시를 로드하기도 했습니다. 학습한 내용을 활용하여 다음 태스크를 완료합니다. +이제는 {% include product %}에서 제공하는 Workfile 및 Publish 앱을 사용하여 작업 파일을 열거나 만들고 저장하고 게시하는 것이 어렵지 않을 것입니다. 또한 Loader 앱을 사용하여 업스트림에서 게시를 로드하기도 했습니다. 학습한 내용을 활용하여 다음 태스크를 완료합니다. -* Shotgun 데스크톱에서 Maya 시작 +* {% include product %} 데스크톱에서 Maya 시작 * 주전자 에셋의 리깅 단계에서 새 작업 파일 만들기 @@ -488,7 +488,7 @@ Loader 앱의 레이아웃은 Workfiles 앱과 유사하지만 지금은 작업 * 주전자 리그 저장 및 게시 -Shotgun에 다음과 같이 나타납니다. +{% include product %}에 다음과 같이 나타납니다. {% include figure src="./images/tutorial/image_35.png" %} @@ -496,7 +496,7 @@ Shotgun에 다음과 같이 나타납니다. {% include figure src="./images/tutorial/image_36.png" %} -주전자의 리깅 단계에서 작업 파일을 다시 엽니다(**Shotgun > 파일 열기...(File Open…)**). 이제 **Shotgun > 씬 분할...(Scene Breakdown…)** 메뉴 액션을 시작합니다. 작업 파일에 참조한 모든 업스트림 게시를 보여 주는 Breakdown 앱이 시작됩니다. 이 경우 업스트림 주전자 모델만 있습니다. 다음과 같이 표시됩니다. +주전자의 리깅 단계에서 작업 파일을 다시 엽니다(**{% include product %} > 파일 열기...(File Open…)**). 이제 **{% include product %} > 씬 분할...(Scene Breakdown…)** 메뉴 액션을 시작합니다. 작업 파일에 참조한 모든 업스트림 게시를 보여 주는 Breakdown 앱이 시작됩니다. 이 경우 업스트림 주전자 모델만 있습니다. 다음과 같이 표시됩니다. {% include figure src="./images/tutorial/image_37.png" width="400px" %} @@ -518,7 +518,7 @@ Shotgun에 다음과 같이 나타납니다. 이전 섹션에서 학습한 내용을 활용하여 다음 태스크를 완료합니다. -* Shotgun 데스크톱에서 Maya 시작 +* {% include product %} 데스크톱에서 Maya 시작 * 샷의 레이아웃 단계에서 새 작업 파일 만들기(힌트: Loader에서 샷(Shots) 탭 사용) @@ -530,7 +530,7 @@ Shotgun에 다음과 같이 나타납니다. {% include figure src="./images/tutorial/image_41.gif" %} -샷 레이아웃이 만족스러우면 **Shotgun > 파일 저장...(File Save…)** 메뉴 액션을 통해 파일을 저장합니다. 이때 계속 진행하여 게시하면 게시할 수 있는 항목으로 전체 Maya 세션만 표시됩니다. +샷 레이아웃이 만족스러우면 **{% include product %} > 파일 저장...(File Save…)** 메뉴 액션을 통해 파일을 저장합니다. 이때 계속 진행하여 게시하면 게시할 수 있는 항목으로 전체 Maya 세션만 표시됩니다. 파이프라인에 추가하여 많은 유연성을 제공하는 쉬운 커스터마이제이션은 다른 패키지에 쉽게 가져올 수 있는 파일 형식으로 독립 실행형 카메라를 게시하는 기능입니다. 이렇게 하면 일반적으로 레이아웃에 카메라를 한 번 생성한 다음 애니메이션, 조명 및 합성 등의 다른 모든 파이프라인 단계를 수행하고 직접 사용할 수 있습니다. @@ -628,11 +628,11 @@ Shotgun에 다음과 같이 나타납니다. {% include figure src="./images/tutorial/image_45.png" %} -이미지에서 볼 수 있듯이, 새 카메라 항목이 수집되고 게시 플러그인이 연결됩니다. 계속 진행하여 **게시(Publish)**를 클릭하여 디스크에 카메라를 작성하고 Shotgun에 등록합니다. +이미지에서 볼 수 있듯이, 새 카메라 항목이 수집되고 게시 플러그인이 연결됩니다. 계속 진행하여 **게시(Publish)**를 클릭하여 디스크에 카메라를 작성하고 {% include product %}에 등록합니다. {% include info title="참고" content="Alembic 내보내기와 유사하게 카메라 게시 플러그인을 사용하려면 FBX 내보내기 플러그인을 로드해야 합니다. 카메라 게시 플러그인 항목이 표시되지 않으면 FBX 플러그인이 로드되었는지 확인하고 게시자를 다시 시작합니다." %} -Shotgun에 다음과 같이 나타납니다. +{% include product %}에 다음과 같이 나타납니다. {% include figure src="./images/tutorial/image_46.png" %} @@ -644,7 +644,7 @@ Shotgun에 다음과 같이 나타납니다. 이전 섹션에서 학습한 내용을 활용하여 다음 태스크를 완료합니다. -* Shotgun 데스크톱에서 Maya 시작 +* {% include product %} 데스크톱에서 Maya 시작 * 샷의 애니메이션 단계에서 새 작업 파일 만들기 @@ -662,7 +662,7 @@ Maya에 대해 앱이 구성된 섹션을 찾고 **`action_mappings`** 설정의 **`FBX Camera: [reference, import]`** -커스텀 카메라 게시 플러그인에서, 디스크에 카메라를 작성하는 데는 Maya의 **`FBXExport`** mel 명령이 사용되었으며 Shotgun에 파일을 등록하는 데 사용된 게시 유형은 **`FBX Camera`**입니다. 설정에 추가한 줄은 **`FBX Camera`** 유형의 게시에 대해 **`reference`** 및 **`import`** 액션을 표시하도록 로더에 지시합니다. 이러한 액션은 Loader 앱의 [tk-maya-actions.py](https://github.com/shotgunsoftware/tk-multi-loader2/blob/master/hooks/tk-maya_actions.py) 후크에 정의되어 있습니다. 이러한 액션은 Maya가 참조하거나 가져올 수 있는 모든 파일 유형을 처리하는 방식으로 구현됩니다. 커스텀 플러그인에 의해 생성된 **`.fbx`** 파일은 이 범주에 해당하므로 이 작업이 게시된 카메라를 로드하는 데 필요한 유일한 변경 사항입니다. +커스텀 카메라 게시 플러그인에서, 디스크에 카메라를 작성하는 데는 Maya의 **`FBXExport`** mel 명령이 사용되었으며 {% include product %}에 파일을 등록하는 데 사용된 게시 유형은 **`FBX Camera`**입니다. 설정에 추가한 줄은 **`FBX Camera`** 유형의 게시에 대해 **`reference`** 및 **`import`** 액션을 표시하도록 로더에 지시합니다. 이러한 액션은 Loader 앱의 [tk-maya-actions.py](https://github.com/shotgunsoftware/tk-multi-loader2/blob/master/hooks/tk-maya_actions.py) 후크에 정의되어 있습니다. 이러한 액션은 Maya가 참조하거나 가져올 수 있는 모든 파일 유형을 처리하는 방식으로 구현됩니다. 커스텀 플러그인에 의해 생성된 **`.fbx`** 파일은 이 범주에 해당하므로 이 작업이 게시된 카메라를 로드하는 데 필요한 유일한 변경 사항입니다. 이제 앱 설정은 다음과 같습니다. @@ -688,7 +688,7 @@ Maya에 대해 앱이 구성된 섹션을 찾고 **`action_mappings`** 설정의 먼저, 이전 섹션에서 학습한 내용을 활용하여 다음 태스크를 완료합니다. -* Shotgun 데스크톱에서 Maya 시작 +* {% include product %} 데스크톱에서 Maya 시작 * 샷의 조명 단계에서 새 작업 파일 만들기 @@ -783,11 +783,11 @@ Maya에 대해 앱이 구성된 섹션을 찾고 **`action_mappings`** 설정의 {% include info title="참고" content="여기에서 볼 수 있듯이 주전자 및 테이블 에셋 둘 다 서페이스 처리에 문제가 있습니다. 이 튜토리얼에서는 의도된 예술적 선택이었다고 가정합니다. 이러한 문제를 해결하려면 언제든지 이러한 에셋의 서페이스 처리 작업 파일을 로드하고 셰이더를 조정하여 다시 게시할 수 있습니다. 이 경우, 조명 작업 파일의 참조를 업데이트하고 다시 렌더링해야 합니다. 단계를 진행하면 참조를 다시 로드한 후 Breakdown 앱이 업데이트된 셰이더를 다시 연결하지 않는다는 사실을 알 수 있습니다. 셰이더 참조를 연결하도록 로더를 수정한 경험을 기반으로 필요한 로직을 추가하도록 Breakdown 앱의 씬 작업 후크를 업데이트할 수 있어야 합니다. 힌트: [이 파일](https://github.com/shotgunsoftware/tk-multi-breakdown/blob/master/hooks/tk-maya_scene_operations.py#L69)의 업데이트 메서드를 참조하십시오." %} -제공된 Shotgun 통합은 파일에 정의된 렌더 레이어를 확인하여 이미지 시퀀스를 수집합니다. 렌더가 완료되면 게시자를 시작합니다. 렌더링된 시퀀스가 트리의 항목으로 표시됩니다. +제공된 {% include product %} 통합은 파일에 정의된 렌더 레이어를 확인하여 이미지 시퀀스를 수집합니다. 렌더가 완료되면 게시자를 시작합니다. 렌더링된 시퀀스가 트리의 항목으로 표시됩니다. {% include figure src="./images/tutorial/image_55.png" %} -계속 진행하여 세션 및 렌더링된 이미지 파일 시퀀스를 게시합니다. Shotgun에 다음과 같이 나타납니다. +계속 진행하여 세션 및 렌더링된 이미지 파일 시퀀스를 게시합니다. {% include product %}에 다음과 같이 나타납니다. {% include figure src="./images/tutorial/image_56.png" %} @@ -795,13 +795,13 @@ Maya에 대해 앱이 구성된 섹션을 찾고 **`action_mappings`** 설정의 ## 합성 워크플로우 -이 마지막 튜토리얼 섹션에서는 Nuke에서 제공하는 기본 통합의 일부를 소개합니다. 이전 섹션에서 확인한 앱 외에도 Shotgun 인식 쓰기 노드와 리뷰를 위해 다른 작업자에게 빠르게 렌더를 보낼 수 있는 앱에 대해 알아봅니다. +이 마지막 튜토리얼 섹션에서는 Nuke에서 제공하는 기본 통합의 일부를 소개합니다. 이전 섹션에서 확인한 앱 외에도 {% include product %} 인식 쓰기 노드와 리뷰를 위해 다른 작업자에게 빠르게 렌더를 보낼 수 있는 앱에 대해 알아봅니다. 다음 단계를 수행하여 작업 파일을 준비합니다. -* Shotgun 데스크톱에서 Nuke를 시작합니다. +* {% include product %} 데스크톱에서 Nuke를 시작합니다. -* Maya에서와 마찬가지로, Shotgun > 파일 열기...(File Open…) 메뉴 액션을 사용하여 샷의 합성 단계에서 새 작업 파일을 만듭니다. +* Maya에서와 마찬가지로, {% include product %} > 파일 열기...(File Open…) 메뉴 액션을 사용하여 샷의 합성 단계에서 새 작업 파일을 만듭니다. Loader 앱을 통해 이전 섹션에서 렌더링 및 게시된 이미지 시퀀스를 로드합니다. @@ -814,13 +814,13 @@ Nuke 프로젝트 설정 출력 형식이 렌더링된 이미지와 일치하는 {% include figure src="./images/tutorial/image_58.png" %} -합성에 만족하면 **Shotgun > 파일 저장...(File Save…)** 메뉴 액션을 사용하여 작업 파일을 저장합니다. +합성에 만족하면 **{% include product %} > 파일 저장...(File Save…)** 메뉴 액션을 사용하여 작업 파일을 저장합니다. -다음으로, Nuke의 왼쪽 메뉴에 있는 Shotgun 로고를 클릭합니다. 해당 메뉴에서 Shotgun 인식 쓰기 노드 중 하나를 클릭합니다. +다음으로, Nuke의 왼쪽 메뉴에 있는 {% include product %} 로고를 클릭합니다. 해당 메뉴에서 {% include product %} 인식 쓰기 노드 중 하나를 클릭합니다. {% include figure src="./images/tutorial/image_59.png" width="400px" %} -Shotgun Write Node 앱에서는 기본 제공 Nuke Write node의 맨 위에 현재 Shotgun 컨텍스트를 기반으로 출력 경로를 자동으로 평가하는 레이어를 제공합니다. +{% include product %} Write Node 앱에서는 기본 제공 Nuke Write node의 맨 위에 현재 {% include product %} 컨텍스트를 기반으로 출력 경로를 자동으로 평가하는 레이어를 제공합니다. {% include figure src="./images/tutorial/image_60.png" %} @@ -828,26 +828,26 @@ Shotgun Write Node 앱에서는 기본 제공 Nuke Write node의 맨 위에 현 {% include figure src="./images/tutorial/image_61.png" %} -또 다른 유용한 통합은 Quick Review 앱입니다. 이 앱은 Quicktime을 빠르게 생성하고 리뷰를 위해 Shotgun에 업로드하는 출력 노드입니다. 이 앱은 Shotgun Write Node 옆의 왼쪽 메뉴에서 찾을 수 있습니다. +또 다른 유용한 통합은 Quick Review 앱입니다. 이 앱은 Quicktime을 빠르게 생성하고 리뷰를 위해 {% include product %}에 업로드하는 출력 노드입니다. 이 앱은 {% include product %} Write Node 옆의 왼쪽 메뉴에서 찾을 수 있습니다. {% include figure src="./images/tutorial/image_62.png" width="400px" %} -빠른 리뷰 노드를 만든 다음 Upload 버튼을 클릭하여 디스크로 입력을 렌더링하고 Quicktime을 생성하고 리뷰를 위해 결과를 Shotgun에 업로드합니다. 프레임을 제출하기 전에 몇 가지 표준 옵션이 제공됩니다. +빠른 리뷰 노드를 만든 다음 Upload 버튼을 클릭하여 디스크로 입력을 렌더링하고 Quicktime을 생성하고 리뷰를 위해 결과를 {% include product %}에 업로드합니다. 프레임을 제출하기 전에 몇 가지 표준 옵션이 제공됩니다. {% include figure src="./images/tutorial/image_63.png" %} -업로드된 Quicktime을 모두 보려면 Shotgun의 미디어(Media) 탭을 확인합니다. +업로드된 Quicktime을 모두 보려면 {% include product %}의 미디어(Media) 탭을 확인합니다. {% include figure src="./images/tutorial/image_64.png" %} -Shotgun의 미디어 리뷰에 대한 자세한 정보는 [공식 설명서](https://support.shotgunsoftware.com/hc/ko/sections/204245448-Review-and-approval)를 참조하십시오. +{% include product %}의 미디어 리뷰에 대한 자세한 정보는 [공식 설명서](https://support.shotgunsoftware.com/hc/ko/sections/204245448-Review-and-approval)를 참조하십시오. # 결론 -축하합니다. 모두 완료했습니다. 이 튜토리얼이 Shotgun 통합을 사용하여 고유한 커스텀 파이프라인을 빌드하는 시작점이 되었기를 바랍니다. 기본 통합을 확장하여 스튜디오의 특정 요구 사항을 충족하는 방법을 이해할 수 있어야 합니다. +축하합니다. 모두 완료했습니다. 이 튜토리얼이 {% include product %} 통합을 사용하여 고유한 커스텀 파이프라인을 빌드하는 시작점이 되었기를 바랍니다. 기본 통합을 확장하여 스튜디오의 특정 요구 사항을 충족하는 방법을 이해할 수 있어야 합니다. [shotgun-dev Google 그룹](https://groups.google.com/a/shotgunsoftware.com/forum/#!forum/shotgun-dev)에서 다른 스튜디오에서는 툴킷을 어떻게 사용하는지 질문하고 배울 수 있습니다. 최신 게시물을 보려면 등록하십시오. 기본 통합에서 제공되지 않는 기능이나 워크플로우가 있으면 언제든 자체 앱을 작성할 수 있습니다. 첫 번째 앱 작성을 시작하려면 [이 문서](https://support.shotgunsoftware.com/hc/ko/articles/219033158)를 참조하십시오. -언제나처럼 이 튜토리얼에 대한 추가 질문이나 Shotgun 또는 툴킷 플랫폼에 대한 일반적인 질문이 있으면 언제든지 [티켓을 제출해 주십시오](https://support.shotgunsoftware.com/hc/ko/requests/new). +언제나처럼 이 튜토리얼에 대한 추가 질문이나 {% include product %} 또는 툴킷 플랫폼에 대한 일반적인 질문이 있으면 언제든지 [티켓을 제출해 주십시오](https://support.shotgunsoftware.com/hc/ko/requests/new). diff --git a/docs/ko/guides/review/integrations.md b/docs/ko/guides/review/integrations.md index d3e953cae..1cc92f826 100644 --- a/docs/ko/guides/review/integrations.md +++ b/docs/ko/guides/review/integrations.md @@ -7,6 +7,6 @@ lang: ko # RV 통합 -RV는 서로 다른 기능 세트를 가진 여러 Shotgun 통합(Shotgun Integration, RV용 Screening Room 및 Shotgun Review)을 비롯해 Nuke 및 Maya를 위한 통합 도구가 함께 제공됩니다. +RV는 서로 다른 기능 세트를 가진 여러 {% include product %} 통합({% include product %} Integration, RV용 Screening Room 및 {% include product %} Review)을 비롯해 Nuke 및 Maya를 위한 통합 도구가 함께 제공됩니다. -앞쪽의 두 문서에서는 Nuke 및 Maya 통합의 설치 및 워크플로우에 대해 설명하며, 뒤쪽의 두 문서에서는 선택에 도움을 주기 위해 다양한 Shotgun 통합에 대해 설명합니다. +앞쪽의 두 문서에서는 Nuke 및 Maya 통합의 설치 및 워크플로우에 대해 설명하며, 뒤쪽의 두 문서에서는 선택에 도움을 주기 위해 다양한 {% include product %} 통합에 대해 설명합니다. diff --git a/docs/ko/guides/webhooks.md b/docs/ko/guides/webhooks.md index 687ab6196..e3ae523a7 100644 --- a/docs/ko/guides/webhooks.md +++ b/docs/ko/guides/webhooks.md @@ -9,7 +9,7 @@ lang: ko {% include info title="베타" content="웹후크는 현재 베타 테스트 중입니다. 베타 테스트에 참여하려면 다음 주소로 이메일을 보내 주십시오. [webhooks-beta@shotgunsoftware.com](mailto:webhooks-beta@shotgunsoftware.com)" %} -웹후크를 사용하면 사용자가 제어하는 서비스는 Shotgun에서 발생하는 이벤트에 대한 알림을 받을 수 있습니다. 웹후크를 만들 때 관심 있는 이벤트 유형을 지정하고 이벤트가 트리거될 때 데이터를 보낼 URL을 Shotgun에 알려 주십시오. Shotgun에서 관련 이벤트가 발생하면 이벤트를 정의하는 데이터 페이로드가 웹후크의 URL로 전송됩니다. 이런 방법으로 Shotgun과의 긴밀한 통합을 구축하고 워크플로우의 일부를 자동화할 수 있습니다. +웹후크를 사용하면 사용자가 제어하는 서비스는 {% include product %}에서 발생하는 이벤트에 대한 알림을 받을 수 있습니다. 웹후크를 만들 때 관심 있는 이벤트 유형을 지정하고 이벤트가 트리거될 때 데이터를 보낼 URL을 {% include product %}에 알려 주십시오. {% include product %}에서 관련 이벤트가 발생하면 이벤트를 정의하는 데이터 페이로드가 웹후크의 URL로 전송됩니다. 이런 방법으로 {% include product %}과의 긴밀한 통합을 구축하고 워크플로우의 일부를 자동화할 수 있습니다. ## 웹후크 사용 방법에는 어떤 것이 있습니까? @@ -17,7 +17,7 @@ lang: ko ### 엔티티 생성 시 디스크에 디렉토리 구조 만들기 -우리가 여러 번 확인한 워크플로우 중에는 Shotgun에서 새 엔티티가 생성될 때 디스크에 디렉토리 구조를 생성하는 것이 있습니다. Shotgun에서 엔티티가 생성되면 자동으로 아티스트 작업을 위한 새 샷이 준비되도록 할 수 있습니다. +우리가 여러 번 확인한 워크플로우 중에는 {% include product %}에서 새 엔티티가 생성될 때 디스크에 디렉토리 구조를 생성하는 것이 있습니다. {% include product %}에서 엔티티가 생성되면 자동으로 아티스트 작업을 위한 새 샷이 준비되도록 할 수 있습니다. ### 상태 관리 자동화 @@ -25,9 +25,9 @@ lang: ko 상태 관리 자동화의 또 다른 좋은 예는 새 노트가 작성될 때 태스크의 상태 변경을 트리거하는 것입니다. 아티스트 및 프로덕션 팀에게 감독이 리뷰 세션 후에 현재 작업에 대한 변경 또는 수정을 요청했음을 알려 주기에 좋은 방법입니다. -## 언제 Shotgun 이벤트 데몬 대신 웹후크를 사용해야 합니까? +## 언제 {% include product %} 이벤트 데몬 대신 웹후크를 사용해야 합니까? -웹후크와 [Shotgun 이벤트 데몬](https://github.com/shotgunsoftware/shotgunEvents/wiki)은 비슷한 기능을 제공하지만 몇 가지 중요한 차이점이 있습니다. 이벤트 데몬을 사용하려면 사용자 고유의 서비스를 실행, 모니터링 및 유지 관리해야 합니다. 모든 사용자 코드는 Python으로 작성해야 하며 그래야 Shotgun에 대한 사용자 고유의 연결을 시작할 수 있습니다. 웹후크는 이와 달리 연결에 응답하며 모든 프로그래밍 언어로 작성할 수 있습니다. 웹후크는 [AWS Lambda](https://aws.amazon.com/lambda/)와 같은 서버리스 환경에서 호스트되거나 [Zapier](https://zapier.com) 및 [IFTTT](https://ifttt.com)와 같이 온라인으로 사용 가능한 모든 자동화 플랫폼을 트리거할 수 있습니다. 웹후크를 사용한 경우에는 이 솔루션을 사용하는 것이 좋습니다. +웹후크와 [{% include product %} 이벤트 데몬](https://github.com/shotgunsoftware/shotgunEvents/wiki)은 비슷한 기능을 제공하지만 몇 가지 중요한 차이점이 있습니다. 이벤트 데몬을 사용하려면 사용자 고유의 서비스를 실행, 모니터링 및 유지 관리해야 합니다. 모든 사용자 코드는 Python으로 작성해야 하며 그래야 {% include product %}에 대한 사용자 고유의 연결을 시작할 수 있습니다. 웹후크는 이와 달리 연결에 응답하며 모든 프로그래밍 언어로 작성할 수 있습니다. 웹후크는 [AWS Lambda](https://aws.amazon.com/lambda/)와 같은 서버리스 환경에서 호스트되거나 [Zapier](https://zapier.com) 및 [IFTTT](https://ifttt.com)와 같이 온라인으로 사용 가능한 모든 자동화 플랫폼을 트리거할 수 있습니다. 웹후크를 사용한 경우에는 이 솔루션을 사용하는 것이 좋습니다. ## 웹후크 생성 @@ -66,7 +66,7 @@ True ### SSL 인증서 유효성 확인 -SSL 인증서 유효성 확인은 웹후크의 사용자 URL에 대한 모든 연결의 보안을 유지하는 데 도움이 되는 선택적 기능입니다. 이 옵션이 설정된 경우 웹후크의 URL로 전달이 이루어지면 Shotgun은 OpenSSL 인증서 유효성 확인 루틴을 사용하여 인증서를 확인합니다. +SSL 인증서 유효성 확인은 웹후크의 사용자 URL에 대한 모든 연결의 보안을 유지하는 데 도움이 되는 선택적 기능입니다. 이 옵션이 설정된 경우 웹후크의 URL로 전달이 이루어지면 {% include product %}은 OpenSSL 인증서 유효성 확인 루틴을 사용하여 인증서를 확인합니다. ## 웹후크 상태 @@ -77,7 +77,7 @@ SSL 인증서 유효성 확인은 웹후크의 사용자 URL에 대한 모든 | 상태 | 예시 | 설명 | |--------|:-------:|:-----------:| | 활성(Active) | ![활성](./images/webhooks/webhook_status_active.png) | 웹후크가 안정적인 방식으로 작동합니다. 지난 24시간 동안 이 웹후크에 전달이 없으면 해당 대상에 도달하지 못한 것입니다. | -| 불안정(Unstable) | ![불안정](./images/webhooks/webhook_status_unstable.png) | 웹후크가 불안정한 방식으로 작동합니다. 지난 24시간 동안 일부 전달이 대상에 도달하지 못했지만 Shotgun에서 웹후크가 작동하지 않는 것으로 간주할 정도는 아닙니다. | +| 불안정(Unstable) | ![불안정](./images/webhooks/webhook_status_unstable.png) | 웹후크가 불안정한 방식으로 작동합니다. 지난 24시간 동안 일부 전달이 대상에 도달하지 못했지만 {% include product %}에서 웹후크가 작동하지 않는 것으로 간주할 정도는 아닙니다. | | 실패(Failed) | ![실패](./images/webhooks/webhook_status_failed.png) | 웹후크가 작동하지 않는 것으로 간주되고 더 이상 전달을 시도하지 않습니다. 이는 짧은 기간 동안 너무 많은 전달 실패에 따른 결과이며 시스템은 웹후크가 더 이상 실행 가능하지 않은 것으로 판단합니다. **지난 24시간 동안 10번의 전달에 실패한 경우 웹후크가 실패로 간주됩니다**. | | 비활성화됨(Disabled) | ![비활성화됨](./images/webhooks/webhook_status_disabled.png) | 웹후크가 비활성화된 상태이며 다시 활성 상태가 될 때까지 전달이 더 이상 시도되지 않습니다. | @@ -101,7 +101,7 @@ SSL 인증서 유효성 확인은 웹후크의 사용자 URL에 대한 모든 #### 페이로드 -웹후크 URL로 전송한 페이로드에는 Shotgun에서 발생한 이벤트 및 이벤트를 트리거한 사용자에 대한 정보가 포함됩니다. JSON 형식으로 제공됩니다. +웹후크 URL로 전송한 페이로드에는 {% include product %}에서 발생한 이벤트 및 이벤트를 트리거한 사용자에 대한 정보가 포함됩니다. JSON 형식으로 제공됩니다. {% include warning title="페이로드 크기" content="전달 페이로드의 최대 크기는 1MB입니다. Shotgun에서 트리거된 이벤트의 페이로드 크기가 1MB보다 크면 `new_value` 및 `old_value` 키가 제거되고 발생 이벤트, 원인 및 Shotgun에서 전체 이벤트 로그 항목을 검색하는 방법을 설명하는 메시지가 포함된 `warning` 키가 추가됩니다." %} @@ -144,11 +144,11 @@ SSL 인증서 유효성 확인은 웹후크의 사용자 URL에 대한 모든 ##### 세션 UUID -Shotgun에서 이벤트를 트리거한 `session_uuid`가 이벤트 페이로드의 일부로 제공됩니다. 이 값은 [Shotgun의 Python API](https://developer.shotgunsoftware.com/python-api/reference.html?highlight=session_uuid#shotgun_api3.shotgun.Shotgun.set_session_uuid)에 제공될 수 있으며, 그러면 이 session_uuid를 사용하여 열려 있는 모든 브라우저 세션에 API에서 생성한 이벤트에 대한 업데이트가 표시됩니다. +{% include product %}에서 이벤트를 트리거한 `session_uuid`가 이벤트 페이로드의 일부로 제공됩니다. 이 값은 [{% include product %}의 Python API](https://developer.shotgunsoftware.com/python-api/reference.html?highlight=session_uuid#shotgun_api3.shotgun.Shotgun.set_session_uuid)에 제공될 수 있으며, 그러면 이 session_uuid를 사용하여 열려 있는 모든 브라우저 세션에 API에서 생성한 이벤트에 대한 업데이트가 표시됩니다. ### 확인 응답 -확인 응답을 포함하도록 전달을 업데이트할 수 있습니다. 전달이 만들어지면 요청의 일부로 헤더가 제공됩니다. 이러한 헤더에는 `x-sg-delivery-id` 키에 저장된 전달 레코드의 ID가 포함됩니다. 이 ID는 [Shotgun REST API](https://developer.shotgunsoftware.com/rest-api)를 사용하여 확인 응답이 포함되도록 전달 레코드를 업데이트하는 데 사용할 수 있습니다. +확인 응답을 포함하도록 전달을 업데이트할 수 있습니다. 전달이 만들어지면 요청의 일부로 헤더가 제공됩니다. 이러한 헤더에는 `x-sg-delivery-id` 키에 저장된 전달 레코드의 ID가 포함됩니다. 이 ID는 [{% include product %} REST API](https://developer.shotgunsoftware.com/rest-api)를 사용하여 확인 응답이 포함되도록 전달 레코드를 업데이트하는 데 사용할 수 있습니다. {% include warning title="확인 응답 크기" content="확인 응답에 허용되는 최대 크기는 4KB입니다." %} @@ -169,7 +169,7 @@ Shotgun에서 이벤트를 트리거한 `session_uuid`가 이벤트 페이로드 #### 확인 응답의 역할은 무엇입니까? -확인 응답은 웹후크의 URL에서 성공적으로 수신한 전달 처리의 성공 또는 실패에 대한 대역 외 상세 보고를 허용합니다. 이를 통해 Shotgun에서 전달 수신 상태를, 해당 전달과 관련된 이벤트 처리의 성공 또는 실패와 구분할 수 있습니다. 이런 방법으로, 성공적으로 전달된 이벤트에서 디버깅을 위해 유용한 추가 정보를 포함할 수 있습니다. 에셋 생성 시 트리거되는 웹후크가 좋은 예입니다. 이 웹후크의 역할이 새로운 각 에셋에 대해 디스크에 디렉토리 구조를 만드는 것인 경우 웹후크의 URL은 성공적으로 전달받을 수 있지만 디스크 또는 네트워크 문제로 인해 관련 디렉토리는 만들 수 없을 수 있습니다. 이 경우 디렉토리 구조가 생성되지 않은 사실과 그 원인을 나타내는 자세한 오류 메시지와 함께 전달 레코드가 업데이트됩니다. +확인 응답은 웹후크의 URL에서 성공적으로 수신한 전달 처리의 성공 또는 실패에 대한 대역 외 상세 보고를 허용합니다. 이를 통해 {% include product %}에서 전달 수신 상태를, 해당 전달과 관련된 이벤트 처리의 성공 또는 실패와 구분할 수 있습니다. 이런 방법으로, 성공적으로 전달된 이벤트에서 디버깅을 위해 유용한 추가 정보를 포함할 수 있습니다. 에셋 생성 시 트리거되는 웹후크가 좋은 예입니다. 이 웹후크의 역할이 새로운 각 에셋에 대해 디스크에 디렉토리 구조를 만드는 것인 경우 웹후크의 URL은 성공적으로 전달받을 수 있지만 디스크 또는 네트워크 문제로 인해 관련 디렉토리는 만들 수 없을 수 있습니다. 이 경우 디렉토리 구조가 생성되지 않은 사실과 그 원인을 나타내는 자세한 오류 메시지와 함께 전달 레코드가 업데이트됩니다. ## 웹후크 테스트 diff --git a/docs/ko/quick-answers/administering.md b/docs/ko/quick-answers/administering.md index 00cbad1c8..98ece8405 100644 --- a/docs/ko/quick-answers/administering.md +++ b/docs/ko/quick-answers/administering.md @@ -10,11 +10,11 @@ lang: ko 툴킷 설정 관리 및 구성을 기반으로 한 빠른 답변 모음입니다. -#### Shotgun 데스크톱: -- [Shotgun 데스크톱을 사용하여 툴킷 프로젝트를 다시 설정하는 방법은 무엇입니까?](./administering/resetup-project-with-sg-desktop.md) -- [Windows에서 Shotgun 데스크톱을 자동으로 설치하려면 어떻게 해야 합니까?](./administering/install-desktop-silent.md) -- [Linux에서 Shotgun 데스크톱의 데스크톱/시작 관리자 아이콘을 어떻게 설정합니까?](./administering/create-shotgun-desktop-shortcut.md) -- [Shotgun 데스크톱의 브라우저 통합을 어떻게 비활성화할 수 있습니까?](./administering/disable-browser-integration.md) +#### {% include product %} 데스크톱: +- [{% include product %} 데스크톱을 사용하여 툴킷 프로젝트를 다시 설정하는 방법은 무엇입니까?](./administering/resetup-project-with-sg-desktop.md) +- [Windows에서 {% include product %} 데스크톱을 자동으로 설치하려면 어떻게 해야 합니까?](./administering/install-desktop-silent.md) +- [Linux에서 {% include product %} 데스크톱의 데스크톱/시작 관리자 아이콘을 어떻게 설정합니까?](./administering/create-shotgun-desktop-shortcut.md) +- [{% include product %} 데스크톱의 브라우저 통합을 어떻게 비활성화할 수 있습니까?](./administering/disable-browser-integration.md) #### 구성 관리: diff --git a/docs/ko/quick-answers/administering/convert-from-single-root-to-multi.md b/docs/ko/quick-answers/administering/convert-from-single-root-to-multi.md index 424389a3c..30e04e08b 100644 --- a/docs/ko/quick-answers/administering/convert-from-single-root-to-multi.md +++ b/docs/ko/quick-answers/administering/convert-from-single-root-to-multi.md @@ -10,19 +10,19 @@ lang: ko 기본 구성은 단일 로컬 저장소 루트를 사용하도록 설정됩니다(즉, 모든 프로젝트 파일이 `/sgtk/projects` 같은 단일 루트 지점에 저장됨). 그리고 일부 프로젝트 파일을 저장할 새 저장소 루트를 추가할 수 있습니다. 보통 디스크 공간이 부족하거나 일부 미디어를 더 빠른 저장소에 저장하고 싶을 때 이렇게 하게 됩니다. 그럼 이제 이름이 "secondary"인 다른 루트를 추가해 보겠습니다. 수행해야 할 단계는 다음과 같습니다. -## Shotgun에서 로컬 저장소 추가 +## {% include product %}에서 로컬 저장소 추가 -- Shotgun에서 **관리자(Admin) > 사이트 기본 설정(Site Preferences)** 페이지로 이동 +- {% include product %}에서 **관리자(Admin) > 사이트 기본 설정(Site Preferences)** 페이지로 이동 - **파일 관리(File Management)** 섹션 열기 - **[+] 로컬 파일 저장소 추가([+] Add Local File Storage)** 클릭 - 해당하는 모든 플랫폼에서 이름("secondary") 및 저장소 루트 경로 입력. *특정 플랫폼을 사용하고 있지 않다면 그냥 비워 두어도 됩니다.* - 페이지 위나 아래에 있는 **페이지 저장(Save Page)** 버튼 클릭 -![Shotgun 파일 관리 기본 설정](images/shotgun-pref-file-management.png) +![{% include product %} 파일 관리 기본 설정](images/shotgun-pref-file-management.png) ## 파이프라인 구성에 새 루트 추가 -툴킷은 파이프라인 구성에서 사용되는 로컬 저장소에 관한 정보를 `config/core/roots.yml` 파일에 캐시합니다. Shotgun에서 지금 막 생성한 새로운 **secondary** 저장소 루트를 추가하려면 이 파일을 편집합니다. +툴킷은 파이프라인 구성에서 사용되는 로컬 저장소에 관한 정보를 `config/core/roots.yml` 파일에 캐시합니다. {% include product %}에서 지금 막 생성한 새로운 **secondary** 저장소 루트를 추가하려면 이 파일을 편집합니다. primary: { linux_path: /mnt/hgfs/sgtk/projects, @@ -90,4 +90,4 @@ lang: ko {% include info title="참고" content="기본 저장소 루트를 사용하는 템플릿에 대한 `root_name`을 지정할 필요가 없습니다. 기본 루트는 `roots.yml` 파일에서 `default: true`를 지정하여 표시됩니다. `roots.yml`에 기본값이 명시적으로 정의되지 않은 경우 **primary**라는 루트를 기본값으로 간주합니다." %} -1 *새 값을 설정하고 나면 툴킷이 이전 값을 사용하여 생성된 모든 이전 파일에 액세스할 수 없게 되기 때문에 경로를 업데이트하는 것이 반드시 이상적이라고 할 수는 없습니다. 즉, 템플릿 경로를 변경하고 나면 툴킷이 이전 작업 파일을 찾을 수 없습니다. 이것이 우려된다면 새 위치를 지정하여 새 템플릿(예: houdini_shot_publish_v2)을 생성한 다음, 새 버전을 사용하도록 앱을 업그레이드하면 됩니다. 모든 앱이 이 같은 폴백 컨셉을 처리할 수 있는 것은 아니지만 일부 앱이라도 이전 파일을 인식할 수 있게 됩니다. 게시는 항상 Shotgun의 게시에 링크되어 있기 때문에 영향을 받지 않습니다.* +1 *새 값을 설정하고 나면 툴킷이 이전 값을 사용하여 생성된 모든 이전 파일에 액세스할 수 없게 되기 때문에 경로를 업데이트하는 것이 반드시 이상적이라고 할 수는 없습니다. 즉, 템플릿 경로를 변경하고 나면 툴킷이 이전 작업 파일을 찾을 수 없습니다. 이것이 우려된다면 새 위치를 지정하여 새 템플릿(예: houdini_shot_publish_v2)을 생성한 다음, 새 버전을 사용하도록 앱을 업그레이드하면 됩니다. 모든 앱이 이 같은 폴백 컨셉을 처리할 수 있는 것은 아니지만 일부 앱이라도 이전 파일을 인식할 수 있게 됩니다. 게시는 항상 {% include product %}의 게시에 링크되어 있기 때문에 영향을 받지 않습니다.* diff --git a/docs/ko/quick-answers/administering/create-shotgun-desktop-shortcut.md b/docs/ko/quick-answers/administering/create-shotgun-desktop-shortcut.md index 43e7ffd00..87bde0ff8 100644 --- a/docs/ko/quick-answers/administering/create-shotgun-desktop-shortcut.md +++ b/docs/ko/quick-answers/administering/create-shotgun-desktop-shortcut.md @@ -5,10 +5,10 @@ pagename: create-shotgun-desktop-shortcut lang: ko --- -# Linux에서 Shotgun 데스크톱의 데스크톱/시작 관리자 아이콘을 어떻게 설정합니까? +# Linux에서 {% include product %} 데스크톱의 데스크톱/시작 관리자 아이콘을 어떻게 설정합니까? -현재 Shotgun 데스크톱 설치 관리자는 단축키를 자동으로 생성하지 않고 항목을 자동으로 실행하지도 않기 때문에 설치 후에 수동으로 해주어야 합니다. 아이콘을 추가하는 과정은 간단하지만, 어느 Linux 버전을 사용 중인지에 따라 달라질 수 있습니다. +현재 {% include product %} 데스크톱 설치 관리자는 단축키를 자동으로 생성하지 않고 항목을 자동으로 실행하지도 않기 때문에 설치 후에 수동으로 해주어야 합니다. 아이콘을 추가하는 과정은 간단하지만, 어느 Linux 버전을 사용 중인지에 따라 달라질 수 있습니다. -Shotgun 데스크톱 설치 관리자를 실행하고 나면 Shotgun 데스크톱 실행 파일이 `/opt/Shotgun folder`에 생성됩니다. 실행 파일 이름은 Shotgun입니다. -설치 관리자와 함께 배포되는 아이콘은 없습니다. [Shotgun 데스크톱 엔진 github 리포지토리](https://github.com/shotgunsoftware/tk-desktop/blob/aac6fe004bd003bf26316b9859bd4ebc42eb82dc/resources/default_systray_icon.png)에서 다운로드하십시오. +{% include product %} 데스크톱 설치 관리자를 실행하고 나면 {% include product %} 데스크톱 실행 파일이 `/opt/Shotgun folder`에 생성됩니다. 실행 파일 이름은 Shotgun입니다. +설치 관리자와 함께 배포되는 아이콘은 없습니다. [{% include product %} 데스크톱 엔진 github 리포지토리](https://github.com/shotgunsoftware/tk-desktop/blob/aac6fe004bd003bf26316b9859bd4ebc42eb82dc/resources/default_systray_icon.png)에서 다운로드하십시오. 아이콘을 다운로드하고, 실행 파일(`/opt/Shotgun/Shotgun`)로 경로를 지정하고 나면 수동으로 필요한 데스크톱 또는 메뉴 시작 관리자를 생성하십시오. 이 프로세스는 Linux 버전에 따라 달라질 수 있지만 보통 데스크톱을 마우스 오른쪽 버튼으로 클릭한 다음 적절한 메뉴 옵션을 찾아 데스크톱 시작 관리자를 생성할 수 있습니다. \ No newline at end of file diff --git a/docs/ko/quick-answers/administering/disable-browser-integration.md b/docs/ko/quick-answers/administering/disable-browser-integration.md index 4cf51f0ba..705a2b46c 100644 --- a/docs/ko/quick-answers/administering/disable-browser-integration.md +++ b/docs/ko/quick-answers/administering/disable-browser-integration.md @@ -5,15 +5,15 @@ pagename: disable-browser-integration lang: ko --- -# Shotgun 데스크톱의 브라우저 통합을 어떻게 비활성화할 수 있습니까? +# {% include product %} 데스크톱의 브라우저 통합을 어떻게 비활성화할 수 있습니까? 브라우저 통합을 비활성화하려면 다음의 간단한 두 단계를 수행하십시오. 1. 다음 위치에서 텍스트 파일을 생성하거나 엽니다. - Windows: %APPDATA%\Shotgun\preferences\toolkit.ini - Macosx: ~/Library/Preferences/Shotgun/toolkit.ini - Linux: ~/.shotgun/preferences/toolkit.ini + Windows: %APPDATA%\{% include product %}\preferences\toolkit.ini + Macosx: ~/Library/Preferences/{% include product %}/toolkit.ini + Linux: ~/.{% include product %}/preferences/toolkit.ini 2. 다음 섹션을 추가합니다. @@ -24,4 +24,4 @@ lang: ko **대체 방법** -툴킷 파이프라인 구성을 인계받은 경우 대체 방법은 [환경에서 `tk-shotgun` 엔진](https://github.com/shotgunsoftware/tk-config-default2/blob/master/env/project.yml#L48)을 제거하여 어떤 액션도 로드할 수 없도록 하는 것입니다. \ No newline at end of file +툴킷 파이프라인 구성을 인계받은 경우 대체 방법은 [환경에서 `tk-{% include product %}` 엔진](https://github.com/shotgunsoftware/tk-config-default2/blob/master/env/project.yml#L48)을 제거하여 어떤 액션도 로드할 수 없도록 하는 것입니다. \ No newline at end of file diff --git a/docs/ko/quick-answers/administering/install-desktop-silent.md b/docs/ko/quick-answers/administering/install-desktop-silent.md index c9012f68c..f3c212315 100644 --- a/docs/ko/quick-answers/administering/install-desktop-silent.md +++ b/docs/ko/quick-answers/administering/install-desktop-silent.md @@ -5,9 +5,9 @@ pagename: install-desktop-silent lang: ko --- -# Windows에서 Shotgun 데스크톱을 자동으로 설치하려면 어떻게 해야 합니까? +# Windows에서 {% include product %} 데스크톱을 자동으로 설치하려면 어떻게 해야 합니까? -Shotgun 데스크톱 설치 프로그램을 자동으로 실행하려면 다음 방법으로 Shotgun 데스크톱 설치 프로그램을 실행하십시오. +{% include product %} 데스크톱 설치 프로그램을 자동으로 실행하려면 다음 방법으로 {% include product %} 데스크톱 설치 프로그램을 실행하십시오. `ShotgunInstaller_Current.exe /S` diff --git a/docs/ko/quick-answers/administering/move-configuration-location.md b/docs/ko/quick-answers/administering/move-configuration-location.md index 7f2366a8b..b21c1e826 100644 --- a/docs/ko/quick-answers/administering/move-configuration-location.md +++ b/docs/ko/quick-answers/administering/move-configuration-location.md @@ -9,7 +9,7 @@ lang: ko {% include info title="참고" content="이 문서의 내용은 [중앙 집중식 구성 설정](https://developer.shotgunsoftware.com/tk-core/initializing.html#centralized-configurations)에만 적용됩니다. [분산 구성](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)은 개별 클라이언트 시스템에 로컬로 캐시되고 툴킷에서 자동으로 관리됩니다." %} -파이프라인 구성을 새 위치로 옮길 수 있는 가장 쉬운 방법은 `tank move_configuration` 명령을 사용하는 것입니다. 이렇게 하면 파일을 이동하고, Shotgun을 업데이트하고, 새 위치를 가리키도록 구성 파일을 업데이트하는 작업이 모두 이루어집니다.  +파이프라인 구성을 새 위치로 옮길 수 있는 가장 쉬운 방법은 `tank move_configuration` 명령을 사용하는 것입니다. 이렇게 하면 파일을 이동하고, {% include product %}을 업데이트하고, 새 위치를 가리키도록 구성 파일을 업데이트하는 작업이 모두 이루어집니다.  이 명령은 단일 운영 체제의 위치만 옮기거나 이전에는 특정 운영 체제를 사용하지 않았지만 이제 운영 체제를 추가하고 싶은 경우에도 유용합니다. 이동하거나 추가해야 하는 항목과 그렇지 않은 항목은 툴킷이 감지하여 진행할 작업을 미리 보여 주기 때문에 진행하기 전에 확인할 수 있습니다. @@ -27,10 +27,10 @@ lang: ko $ cd /sgtk/software/shotgun/scarlet $ ./tank move_configuration - Welcome to the Shotgun Pipeline Toolkit! + Welcome to the {% include product %} Pipeline Toolkit! For documentation, see https://toolkit.shotgunsoftware.com Starting Toolkit for your current path '/sgtk/software/shotgun/scarlet' - - The path is not associated with any Shotgun object. + - The path is not associated with any {% include product %} object. - Falling back on default project settings. - Using configuration 'Primary' and Core v0.15.22 - Setting the Context to Scarlet. @@ -71,10 +71,10 @@ lang: ko $ cd /sgtk/software/shotgun/scarlet $ ./tank move_configuration "/mnt/hgfs/sgtk/software/shotgun/scarlet_new" "z:\sgtk\software\shotgun\scarlet_new" "/sgtk/software/shotgun/scarlet_new" - Welcome to the Shotgun Pipeline Toolkit! + Welcome to the {% include product %} Pipeline Toolkit! For documentation, see https://toolkit.shotgunsoftware.com Starting toolkit for path '/sgtk/software/shotgun/scarlet' - - The path is not associated with any Shotgun object. + - The path is not associated with any {% include product %} object. - Falling back on default project settings. - Using configuration 'Primary' and Core v0.15.22 - Setting the Context to Scarlet. @@ -129,7 +129,7 @@ lang: ko Copying /sgtk/software/shotgun/scarlet/install/frameworks... Copying /sgtk/software/shotgun/scarlet/install/frameworks/app_store... Updating cached locations in /sgtk/software/shotgun/scarlet_new/config/core/install_location.yml... - Updating Shotgun Configuration Record... + Updating {% include product %} Configuration Record... Deleting original configuration files... All done! Your configuration has been successfully moved. @@ -151,7 +151,7 @@ lang: ko 해당하는 모든 플랫폼에서 이 파일의 경로가 새 파이프라인 구성 위치를 가리키도록 업데이트합니다. 플랫폼을 사용하고 있지 않다면 빈 문자열 `''`을 입력합니다. - # Shotgun Pipeline Toolkit configuration file + # {% include product %} Pipeline Toolkit configuration file # This file was automatically created by setup_project # This file reflects the paths in the primary pipeline @@ -162,9 +162,9 @@ lang: ko # End of file. -3. Shotgun에서 이 프로젝트에 대한 해당 파이프라인 구성 엔티티를 찾아 Linux 경로, Mac 경로 및 Windows 경로 필드 값이 위에서 변경한 사항과 일치하도록 수정합니다. +3. {% include product %}에서 이 프로젝트에 대한 해당 파이프라인 구성 엔티티를 찾아 Linux 경로, Mac 경로 및 Windows 경로 필드 값이 위에서 변경한 사항과 일치하도록 수정합니다. -![Shotgun에서 파이프라인 구성 위치](images/new-pipeline-configuration-locations.png) +![{% include product %}에서 파이프라인 구성 위치](images/new-pipeline-configuration-locations.png) 이제 파이프라인 구성이 새 위치에서 기대한 대로 작동할 것입니다. diff --git a/docs/ko/quick-answers/administering/move-project-directories.md b/docs/ko/quick-answers/administering/move-project-directories.md index 2ee467df3..fa67e7cf1 100644 --- a/docs/ko/quick-answers/administering/move-project-directories.md +++ b/docs/ko/quick-answers/administering/move-project-directories.md @@ -12,11 +12,11 @@ lang: ko 간혹 프로젝트 파일(씬 파일, 렌더 등)을 새 루트 저장소 위치로 옮겨야 할 때가 있습니다(예: `/mnt/smalldrive`에서 `/mnt/bigdrive/foo`로). 이동은 단일 루트 구성을 사용 중이든 다중 루트 구성을 사용 중이든 상관없이 가능합니다. 이름이 **"asset_storage"**인 저장소를 옮기는 예를 살펴보겠습니다. - 이전 위치에서 새 위치로 프로젝트 파일을 복사(또는 이동)합니다. -- Shotgun에서 **관리자(Admin) > 사이트 기본 설정(Site Preferences)** 페이지로 이동해 **파일 관리(File Management)** 섹션을 엽니다. - ![사이트 기본 설정의 Shotgun 저장소 루트 섹션](./images/shotgun-storage-roots.png) +- {% include product %}에서 **관리자(Admin) > 사이트 기본 설정(Site Preferences)** 페이지로 이동해 **파일 관리(File Management)** 섹션을 엽니다. + ![사이트 기본 설정의 {% include product %} 저장소 루트 섹션](./images/shotgun-storage-roots.png) - 각 플랫폼의 경로와 함께 이름이 "primary"인 로컬 파일 저장소를 프로젝트 파일의 새 저장소로 업데이트합니다. 특정 플랫폼을 사용하고 있지 않다면 그냥 비워 두십시오. - 페이지 위나 아래에 있는 **"변경 사항 저장(Save Changes)"** 버튼을 클릭합니다. -- 지금 막 Shotgun에 저장한 새로운 경로 값과 일치하도록 프로젝트 구성의 `config/core/roots.yml` 파일을 업데이트합니다. +- 지금 막 {% include product %}에 저장한 새로운 경로 값과 일치하도록 프로젝트 구성의 `config/core/roots.yml` 파일을 업데이트합니다. 툴킷이 게시 경로를 저장소 루트의 상대 경로로 저장합니다. 이전 저장소 루트도 마찬가지로 경로가 다음과 같이 확장되었습니다. @@ -26,7 +26,7 @@ lang: ko [asset-storage]/assets/Character/betty => /mnt/bigdrive/foo/assets/Character/betty -그리고 Shotgun 또는 툴킷에서 어떤 다른 게시 정보를 업데이트하는 일은 신경 쓸 필요가 없습니다! +그리고 {% include product %} 또는 툴킷에서 어떤 다른 게시 정보를 업데이트하는 일은 신경 쓸 필요가 없습니다! {% include warning title="경고" content="위 단계에서는 기존 저장소 루트 경로를 재지정한다고 가정합니다. 대신 기존 경로를 삭제하거나 새 경로를 만드는 경우 모든 폴더를 다시 등록하고 `PublishedFiles` 엔티티를 다시 게시해야 합니다." %} @@ -36,4 +36,4 @@ lang: ko ## 버전 -Shotgun에 이 변경 사항의 영향을 받는 영상 경로 또는 프레임 경로 필드에 정보를 저장하는 버전 엔티티가 있는 경우 이 필드는 미디어에 대한 절대 경로를 포함하고 있는 문자열 필드이기 때문에 해당 버전 역시 새 위치를 가리키도록 업데이트되어야 합니다. \ No newline at end of file +{% include product %}에 이 변경 사항의 영향을 받는 영상 경로 또는 프레임 경로 필드에 정보를 저장하는 버전 엔티티가 있는 경우 이 필드는 미디어에 대한 절대 경로를 포함하고 있는 문자열 필드이기 때문에 해당 버전 역시 새 위치를 가리키도록 업데이트되어야 합니다. \ No newline at end of file diff --git a/docs/ko/quick-answers/administering/resetup-project-with-sg-desktop.md b/docs/ko/quick-answers/administering/resetup-project-with-sg-desktop.md index 63cee6150..f4e72b086 100644 --- a/docs/ko/quick-answers/administering/resetup-project-with-sg-desktop.md +++ b/docs/ko/quick-answers/administering/resetup-project-with-sg-desktop.md @@ -5,16 +5,16 @@ pagename: resetup-project-with-sg-desktop lang: ko --- -# Shotgun 데스크톱을 사용하여 툴킷 프로젝트를 다시 설정하는 방법은 무엇입니까? +# {% include product %} 데스크톱을 사용하여 툴킷 프로젝트를 다시 설정하는 방법은 무엇입니까? -프로젝트에 대한 툴킷 구성을 이미 설정하고 새로 시작해야 하는 경우 Shotgun 데스크톱의 고급 설정 마법사는 이전의 설정 구성을 제거하기 전에는 프로젝트를 다시 설정할 수 없습니다. +프로젝트에 대한 툴킷 구성을 이미 설정하고 새로 시작해야 하는 경우 {% include product %} 데스크톱의 고급 설정 마법사는 이전의 설정 구성을 제거하기 전에는 프로젝트를 다시 설정할 수 없습니다. 수동으로 해당 설정을 제거하는 단계는 다음과 같습니다. -1. Shotgun에서 프로젝트에 연결된 모든 `PipelineConfiguration` 엔티티를 삭제합니다.

![PipelineConfiguration 엔티티 페이지에 액세스](images/pipeline-configuration-entity-page.png)

-2. Shotgun의 `Project` 엔티티에서 `Tank Name` 필드를 빈 값으로 설정합니다.

![프로젝트 탱크 이름 필드 지우기](images/clear-project-tank-name.png)

+1. {% include product %}에서 프로젝트에 연결된 모든 `PipelineConfiguration` 엔티티를 삭제합니다.

![PipelineConfiguration 엔티티 페이지에 액세스](images/pipeline-configuration-entity-page.png)

+2. {% include product %}의 `Project` 엔티티에서 `Tank Name` 필드를 빈 값으로 설정합니다.

![프로젝트 탱크 이름 필드 지우기](images/clear-project-tank-name.png)

3. 디스크에서 해당하는 파이프라인 구성 디렉토리를 모두 제거합니다. -4. Shotgun 데스크톱에서 설정할 프로젝트를 선택합니다. *프로젝트를 보고 있던 중이라면 프로젝트 목록 보기로 이동했다가 다시 프로젝트로 돌아옵니다.* +4. {% include product %} 데스크톱에서 설정할 프로젝트를 선택합니다. *프로젝트를 보고 있던 중이라면 프로젝트 목록 보기로 이동했다가 다시 프로젝트로 돌아옵니다.* 6. 이제 프로젝트 설정 프로세스를 다시 실행할 수 있습니다. **대체 방법** diff --git a/docs/ko/quick-answers/administering/sg-desktop-run-on-ubuntu.md b/docs/ko/quick-answers/administering/sg-desktop-run-on-ubuntu.md index 8a53c54ad..f202782db 100644 --- a/docs/ko/quick-answers/administering/sg-desktop-run-on-ubuntu.md +++ b/docs/ko/quick-answers/administering/sg-desktop-run-on-ubuntu.md @@ -5,15 +5,15 @@ pagename: sg-desktop-run-on-ubuntu lang: ko --- -# Shotgun 데스크톱이 Ubuntu 같은 Debian 시스템에서도 작동합니까? +# {% include product %} 데스크톱이 Ubuntu 같은 Debian 시스템에서도 작동합니까? -현재는 Shotgun 데스크톱용 Debian 기반 배포판을 지원하지 않습니다. -과거에 몇몇 고객이 이를 구현하려고 했던 적이 있었는데, cpio를 사용하여 RPM에서 Shotgun 데스크톱을 추출한 다음 라이브러리 종속성을 충족하려고 했지만 그리 좋은 결과를 내진 못했습니다. 추가 내용은 [dev 그룹에서 이 스레드를 확인할 수 있습니다](https://groups.google.com/a/shotgunsoftware.com/d/msg/shotgun-dev/nNBg4CKNBLc/naiGlJowBAAJ). +현재는 {% include product %} 데스크톱용 Debian 기반 배포판을 지원하지 않습니다. +과거에 몇몇 고객이 이를 구현하려고 했던 적이 있었는데, cpio를 사용하여 RPM에서 {% include product %} 데스크톱을 추출한 다음 라이브러리 종속성을 충족하려고 했지만 그리 좋은 결과를 내진 못했습니다. 추가 내용은 [dev 그룹에서 이 스레드를 확인할 수 있습니다](https://groups.google.com/a/shotgunsoftware.com/d/msg/shotgun-dev/nNBg4CKNBLc/naiGlJowBAAJ). Python 자체가 많은 시스템 레벨 라이브러리 위에 위치하기 때문에 명시적인 라이브러리 종속성 목록은 없습니다. 지금으로서는 Debian 지원에 대한 공식적인 계획이 없습니다. Ubuntu를 위한 빌드에는 문제가 있지만 한편으로는 결코 사소하다고 할 수 없는 변화를 구현하다 보면 추가 운영 체제를 QA 및 지원해야 할 필요도 있습니다. -Shotgun 데스크톱 없이 툴킷을 수동으로 실행 및 활성화하려는 경우([여기 문서에서 설명](https://support.shotgunsoftware.com/hc/ko/articles/219033208#Step%208.%20Run%20the%20activation%20script)) - 설명서 페이지에서 `activate_shotgun_pipeline_toolkit.py` 스크립트를 다운로드하십시오. 이 안내서의 8단계에 있으며, "다운로드하려면 클릭..."(click to download...) 헤더를 클릭하면 됩니다. +{% include product %} 데스크톱 없이 툴킷을 수동으로 실행 및 활성화하려는 경우([여기 문서에서 설명](https://support.shotgunsoftware.com/hc/ko/articles/219033208#Step%208.%20Run%20the%20activation%20script)) - 설명서 페이지에서 `activate_shotgun_pipeline_toolkit.py` 스크립트를 다운로드하십시오. 이 안내서의 8단계에 있으며, "다운로드하려면 클릭..."(click to download...) 헤더를 클릭하면 됩니다. diff --git a/docs/ko/quick-answers/administering/what-is-path-cache.md b/docs/ko/quick-answers/administering/what-is-path-cache.md index f556e9887..8b37fb95b 100644 --- a/docs/ko/quick-answers/administering/what-is-path-cache.md +++ b/docs/ko/quick-answers/administering/what-is-path-cache.md @@ -7,15 +7,15 @@ lang: ko # 경로 캐시가 무엇입니까? 파일 시스템 위치가 무엇입니까? -경로 캐시는 툴킷이 디스크의 폴더와 Shotgun의 엔티티 간 연결을 트래킹하는 데 사용합니다. -마스터 캐시는 `FilesystemLocation` 엔티티 유형을 사용하여 Shotgun에 저장됩니다. 그러면 각 사용자는 [디스크의 툴킷 캐시 디렉토리에 로컬로 저장](./where-is-my-cache.md)되는 각자의 경로 캐시 버전을 갖게 되고, 이 경로 캐시는 응용프로그램이 시작되거나 폴더가 생성될 때마다 백그라운드에서 동기화됩니다. +경로 캐시는 툴킷이 디스크의 폴더와 {% include product %}의 엔티티 간 연결을 트래킹하는 데 사용합니다. +마스터 캐시는 `FilesystemLocation` 엔티티 유형을 사용하여 {% include product %}에 저장됩니다. 그러면 각 사용자는 [디스크의 툴킷 캐시 디렉토리에 로컬로 저장](./where-is-my-cache.md)되는 각자의 경로 캐시 버전을 갖게 되고, 이 경로 캐시는 응용프로그램이 시작되거나 폴더가 생성될 때마다 백그라운드에서 동기화됩니다. -보통 경로 캐시는 수동으로 수정하지 않는 것이 좋습니다. 저희의 내부 프로세스를 통해 여러분의 로컬 캐시가 Shotgun의 파일 시스템 위치 엔티티와 동기화될 뿐 아니라, 모든 사용자의 컴퓨터가 Shotgun과 동기화 상태를 유지할 수 있도록 이벤트 로그 항목도 생성됩니다. +보통 경로 캐시는 수동으로 수정하지 않는 것이 좋습니다. 저희의 내부 프로세스를 통해 여러분의 로컬 캐시가 {% include product %}의 파일 시스템 위치 엔티티와 동기화될 뿐 아니라, 모든 사용자의 컴퓨터가 {% include product %}과 동기화 상태를 유지할 수 있도록 이벤트 로그 항목도 생성됩니다. 경로 캐시를 수정하는 데 사용할 수 있는 몇 가지 tank 명령이 있습니다. - `tank unregister_folders` 명령은 경로 캐시 연결을 제거합니다. -- `tank synchronize_folders` 명령은 로컬 경로 캐시와 Shotgun의 동기화를 실행합니다. +- `tank synchronize_folders` 명령은 로컬 경로 캐시와 {% include product %}의 동기화를 실행합니다. 보통은 이 명령을 실행할 필요가 없지만 상황에 따라서는 실행하는 것이 유용할 수 있습니다. 예를 들어, `unregister_folders` 명령은 프로젝트 내 엔티티의 이름을 바꾸거나 엔티티를 다시 생성하기 전에 실행해야 합니다. \ No newline at end of file diff --git a/docs/ko/quick-answers/administering/where-is-my-cache.md b/docs/ko/quick-answers/administering/where-is-my-cache.md index 3d2c2a1dc..f4d60acee 100644 --- a/docs/ko/quick-answers/administering/where-is-my-cache.md +++ b/docs/ko/quick-answers/administering/where-is-my-cache.md @@ -10,7 +10,7 @@ lang: ko ## 루트 캐시 위치 -툴킷은 일부 데이터를 로컬 캐시에 저장하여 Shotgun 서버에 대한 불필요한 호출을 방지합니다. 여기에는 [경로 캐시](./what-is-path-cache.md), 번들 캐시 및 썸네일이 포함됩니다. 대부분의 사용자는 기본 위치로도 문제 없지만 이를 변경해야 한다면 [cache_location 코어 후크](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/cache_location.py)를 사용하여 구성할 수 있습니다. +툴킷은 일부 데이터를 로컬 캐시에 저장하여 {% include product %} 서버에 대한 불필요한 호출을 방지합니다. 여기에는 [경로 캐시](./what-is-path-cache.md), 번들 캐시 및 썸네일이 포함됩니다. 대부분의 사용자는 기본 위치로도 문제 없지만 이를 변경해야 한다면 [cache_location 코어 후크](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/cache_location.py)를 사용하여 구성할 수 있습니다. 기본 캐시 루트 위치는 다음과 같습니다. @@ -36,7 +36,7 @@ lang: ko **분산 구성** -번들 캐시는 Shotgun 사이트의 프로젝트 전반에 사용되는 전체 응용프로그램, 엔진, 프레임워크의 캐시 모음입니다. 분산 구성의 번들 캐시는 다음 위치에 저장됩니다. +번들 캐시는 {% include product %} 사이트의 프로젝트 전반에 사용되는 전체 응용프로그램, 엔진, 프레임워크의 캐시 모음입니다. 분산 구성의 번들 캐시는 다음 위치에 저장됩니다. Mac: `~/Library/Caches/Shotgun/bundle_cache` diff --git a/docs/ko/quick-answers/developing/create-publishes-via-api.md b/docs/ko/quick-answers/developing/create-publishes-via-api.md index 4e8d63754..1a10992df 100644 --- a/docs/ko/quick-answers/developing/create-publishes-via-api.md +++ b/docs/ko/quick-answers/developing/create-publishes-via-api.md @@ -7,16 +7,16 @@ lang: ko # API를 통해 게시물을 작성하려면 어떻게 해야 합니까? -sgtk API는 Shotgun에서 `PublishedFiles` 엔티티를 등록할 수 있는 [편의 메서드](https://developer.shotgunsoftware.com/tk-core/utils.html#sgtk.util.register_publish)를 제공합니다. +sgtk API는 {% include product %}에서 `PublishedFiles` 엔티티를 등록할 수 있는 [편의 메서드](https://developer.shotgunsoftware.com/tk-core/utils.html#sgtk.util.register_publish)를 제공합니다. 또한 [자체 API](https://developer.shotgunsoftware.com/tk-multi-publish2/)와 함께 Publish 앱도 제공합니다. Publish API는 궁극적으로 Core sgtk API 메서드를 사용하여 PublishedFile을 등록하지만 사용자 지정 가능한 컬렉션, 유효성 확인 및 게시 관련 프레임워크도 제공합니다. 이와 관련하여 Publish API 설명서와 함께 [파이프라인 튜토리얼](https://developer.shotgunsoftware.com/ko/cb8926fc/)에 자체 게시 플러그인 작성 예제도 제공합니다. ## register_publish() API 메서드 사용 -로우 Shotgun API 호출을 사용하여 Shotgun에서 게시 레코드를 생성하는 것도 가능하지만 툴킷의 편의 메서드를 이용하는 것이 훨씬 좋습니다. +로우 {% include product %} API 호출을 사용하여 {% include product %}에서 게시 레코드를 생성하는 것도 가능하지만 툴킷의 편의 메서드를 이용하는 것이 훨씬 좋습니다. 게시를 생성하는 모든 툴킷 앱은 [`sgtk.util.register_publish()`](https://developer.shotgunsoftware.com/tk-core/utils.html#sgtk.util.register_publish)라는 API 유틸리티 메서드를 사용 중입니다. -기본적으로 이 메서드는 Shotgun에서 새로운 PublishedFile 엔티티를 생성하며, 툴킷 컨셉을 사용하여 생성을 쉽게 만들어줍니다. 여러분의 코드로 무언가를 실행하려면 다음의 행을 이용해야 할 것입니다. +기본적으로 이 메서드는 {% include product %}에서 새로운 PublishedFile 엔티티를 생성하며, 툴킷 컨셉을 사용하여 생성을 쉽게 만들어줍니다. 여러분의 코드로 무언가를 실행하려면 다음의 행을 이용해야 할 것입니다. ```python # Get access to the Toolkit API diff --git a/docs/ko/quick-answers/developing/setting-software-environment-variables.md b/docs/ko/quick-answers/developing/setting-software-environment-variables.md index ac42fc86c..2e37c30c3 100644 --- a/docs/ko/quick-answers/developing/setting-software-environment-variables.md +++ b/docs/ko/quick-answers/developing/setting-software-environment-variables.md @@ -7,10 +7,10 @@ lang: ko # 소프트웨어를 실행하기 전에 환경 변수는 어떻게 설정합니까? -Shotgun 툴킷을 사용하면 실행 프로세스 중에 후크를 사용하여 환경을 구성하고 커스텀 코드를 실행할 수 있습니다. +{% include product %} 툴킷을 사용하면 실행 프로세스 중에 후크를 사용하여 환경을 구성하고 커스텀 코드를 실행할 수 있습니다. -Nuke 또는 Maya와 같은 소프트웨어를 실행할 때 Shotgun 데스크톱 또는 브라우저 통합을 통해 `tk-multi-launchapp`이 실행됩니다. -이 앱은 소프트웨어 실행을 담당하며 Shotgun 통합이 예상대로 시작되게 합니다. 이 프로세스 중에 후크를 통해 표시되는 두 지점을 사용하여 커스텀 코드를 실행할 수 있습니다. +Nuke 또는 Maya와 같은 소프트웨어를 실행할 때 {% include product %} 데스크톱 또는 브라우저 통합을 통해 `tk-multi-launchapp`이 실행됩니다. +이 앱은 소프트웨어 실행을 담당하며 {% include product %} 통합이 예상대로 시작되게 합니다. 이 프로세스 중에 후크를 통해 표시되는 두 지점을 사용하여 커스텀 코드를 실행할 수 있습니다. ## before_app_launch.py diff --git a/docs/ko/quick-answers/developing/setting_software_environment_variables.md b/docs/ko/quick-answers/developing/setting_software_environment_variables.md deleted file mode 100644 index ef6b3da17..000000000 --- a/docs/ko/quick-answers/developing/setting_software_environment_variables.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -layout: default -title: 소프트웨어를 실행하기 전에 환경 변수는 어떻게 설정합니까? -pagename: setting_software_environment_variables -lang: ko ---- - -# 소프트웨어를 실행하기 전에 환경 변수는 어떻게 설정합니까? - -Shotgun 툴킷을 사용하면 실행 프로세스 중에 후크를 사용하여 환경을 구성하고 커스텀 코드를 실행할 수 있습니다. - -Nuke 또는 Maya와 같은 소프트웨어를 실행할 때 Shotgun 데스크톱 또는 브라우저 통합을 통해 `tk-multi-launchapp`이 실행됩니다. -이 앱은 소프트웨어 실행을 담당하며 Shotgun 통합이 예상대로 시작되게 합니다. 이 프로세스 중에 후크를 통해 표시되는 두 지점을 사용하여 커스텀 코드를 실행할 수 있습니다. - -## before_app_launch.py - -[`before_app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/6a884aa144851148e8369e9f35a2471087f98d16/hooks/before_app_launch.py) 후크는 소프트웨어가 실행되기 직전에 호출됩니다. -이를 통해 실행된 소프트웨어에 전달될 모든 커스텀 환경 변수를 완벽하게 설정할 수 있습니다. - -예시: - -```python -import os -import tank - -class BeforeAppLaunch(tank.Hook): - - def execute(self, app_path, app_args, version, engine_name, **kwargs): - - if engine_name == "tk-maya": - os.environ["MY_CUSTOM_MAYA_ENV_VAR"] = "Some Maya specific setting" -``` - -{% include warning title="경고" content="Shotgun에서 설정된 환경 변수를 완전히 다시 정의하지 않도록 주의해야 합니다. -예를 들어 `NUKE_PATH`(Nuke) 또는 `PYTHONPATH`(Maya)에 경로를 추가해야 하는 경우 경로를 변경하는 대신 기존 값에 경로를 추가해야 합니다. -이 경우 다음과 같이 편리한 방법을 사용할 수 있습니다. - -```python -tank.util.append_path_to_env_var(\"NUKE_PATH\", \"/my/custom/path\") -``` -" %} - -## 커스텀 래퍼 - -일부 스튜디오에서는 환경 변수 설정 및 소프트웨어 실행을 처리하는 커스텀 래퍼를 사용합니다. -이와 같은 커스텀 코드를 사용하여 환경을 설정하려는 경우 `Software` 엔티티의 [경로 필드](https://support.shotgunsoftware.com/hc/ko/articles/115000067493-Integrations-Admin-Guide#Example:%20Add%20your%20own%20Software)를 실행 가능한 래퍼로 지정하면 `tk-multi-launchapp`이 대신 실행합니다. - -{% include warning title="경고" content="이 경우 Shotgun에서 설정한 환경 변수를 유지해야 합니다. 그러지 않으면 통합이 시작되지 않습니다." %} \ No newline at end of file diff --git a/docs/ko/quick-answers/developing/toolkit-core-event-daemon.md b/docs/ko/quick-answers/developing/toolkit-core-event-daemon.md index 1f0ba3543..8be979c71 100644 --- a/docs/ko/quick-answers/developing/toolkit-core-event-daemon.md +++ b/docs/ko/quick-answers/developing/toolkit-core-event-daemon.md @@ -13,7 +13,7 @@ lang: ko 툴킷의 sgtk API는 프로젝트 중심입니다. 즉, 사용할 프로젝트에서 특별히 가져와야 합니다. 이는 단일 Python 세션에서 다중 프로젝트에 대해 sgtk API 작업을 사용하는 경우 Python은 이름이 동일한 모듈을 한 번만 가져올 수 있기 때문에 문제가 발생할 수 있음을 의미합니다. -[shotgun 이벤트 데몬](https://github.com/shotgunsoftware/shotgunEvents)을 사용 중인 경우 특정 이벤트에 대해서는 플러그인 내에서 툴킷 액션을 수행하고 싶을 수 있습니다. 하지만 Python은 모듈을 한 번만 가져오기 때문에 이렇게 하는 것은 위험할 수 있습니다. 따라서 프로젝트 A용 Toolkit Core API를 플러그인을 처음 실행할 때 가져오면 그 버전이 데몬의 사용 기간 동안 가져온 채로 유지되는 버전이 됩니다. 즉, 플러그인으로 발송된 다음 이벤트가 프로젝트 B의 이벤트인 경우 프로젝트 A용 Core API를 사용하여 프로젝트 B를 위한 새 툴킷 객체의 인스턴스화를 시도하면 툴킷에서 오류가 발생할 수 있습니다. +[{% include product %} 이벤트 데몬](https://github.com/shotgunsoftware/shotgunEvents)을 사용 중인 경우 특정 이벤트에 대해서는 플러그인 내에서 툴킷 액션을 수행하고 싶을 수 있습니다. 하지만 Python은 모듈을 한 번만 가져오기 때문에 이렇게 하는 것은 위험할 수 있습니다. 따라서 프로젝트 A용 Toolkit Core API를 플러그인을 처음 실행할 때 가져오면 그 버전이 데몬의 사용 기간 동안 가져온 채로 유지되는 버전이 됩니다. 즉, 플러그인으로 발송된 다음 이벤트가 프로젝트 B의 이벤트인 경우 프로젝트 A용 Core API를 사용하여 프로젝트 B를 위한 새 툴킷 객체의 인스턴스화를 시도하면 툴킷에서 오류가 발생할 수 있습니다. **중앙 집중식 구성을 사용하는 경우의 문제 예시:** diff --git a/docs/ko/quick-answers/troubleshooting.md b/docs/ko/quick-answers/troubleshooting.md index b4a40a2c0..3afe106d8 100644 --- a/docs/ko/quick-answers/troubleshooting.md +++ b/docs/ko/quick-answers/troubleshooting.md @@ -19,14 +19,14 @@ lang: ko - [Python API에서 SSL: CERTIFICATE_VERIFY_FAILED 문제 수정](./troubleshooting/fix-ssl-certificate-verify-failed.md) #### 소프트웨어 통합. -- [Houdini Shotgun 통합이 시작되지 않는 이유는 무엇일까요?](./troubleshooting/houdini-integrations-not-starting.md) -- [SG 데스크톱에서 Nuke/Maya 등을 실행했는데 Shotgun 메뉴에 해당 항목이 없습니다](./troubleshooting/menu-entries-missing-in-launched-dcc.md) +- [Houdini {% include product %} 통합이 시작되지 않는 이유는 무엇일까요?](./troubleshooting/houdini-integrations-not-starting.md) +- [SG 데스크톱에서 Nuke/Maya 등을 실행했는데 {% include product %} 메뉴에 해당 항목이 없습니다](./troubleshooting/menu-entries-missing-in-launched-dcc.md) - [NUKE_PATH 환경 변수를 설정하면 Nuke 통합이 시작되지 않는 이유가 무엇입니까?](./troubleshooting/nuke-path-environment-variable.md) - [두 개의 익스텐션이 설치된 경우 Photoshop 통합 문제 해결](./troubleshooting/two-photoshop-shotgun-extensions.md) -- [Shotgun 툴킷 사용 시 3ds Max를 시작하면 충돌 오류가 발생하는 이유는 무엇입니까?](./troubleshooting/3dsmax-crashes-on-startup.md) +- [{% include product %} 툴킷 사용 시 3ds Max를 시작하면 충돌 오류가 발생하는 이유는 무엇입니까?](./troubleshooting/3dsmax-crashes-on-startup.md) #### 브라우저 통합 - [Chrome에서 로컬 파일 링크를 사용할 수 없으며, 툴킷 응용프로그램도 실행할 수 없습니다](./troubleshooting/cant-use-file-linking-toolkit-app-chrome.md) - [Firefox에서 로컬 파일 링크를 사용할 수 없으며, 툴킷 응용프로그램도 실행할 수 없습니다.](./troubleshooting/cant-use-file-linking-toolkit-app-firefox.md) -- [Shotgun 데스크톱/브라우저 통합을 Linux에서 실행할 수 없습니다](./troubleshooting/browser-integration-fails-linux.md) +- [{% include product %} 데스크톱/브라우저 통합을 Linux에서 실행할 수 없습니다](./troubleshooting/browser-integration-fails-linux.md) diff --git a/docs/ko/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md b/docs/ko/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md index d5b637d1a..f8afbf2db 100644 --- a/docs/ko/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md +++ b/docs/ko/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md @@ -5,9 +5,9 @@ pagename: 3dsmax-crashes-on-startup lang: ko --- -# Shotgun 툴킷 사용 시 3ds Max를 시작하면 충돌 오류가 발생하는 이유는 무엇입니까? +# {% include product %} 툴킷 사용 시 3ds Max를 시작하면 충돌 오류가 발생하는 이유는 무엇입니까? -Shotgun 데스크톱이나 Shotgun 웹 사이트에서 3ds Max를 실행하면 하얀색 대화상자가 움직이지 않는 상태로 3ds Max가 멈추거나 다음 메시지가 나타날 수 있습니다. +{% include product %} 데스크톱이나 {% include product %} 웹 사이트에서 3ds Max를 실행하면 하얀색 대화상자가 움직이지 않는 상태로 3ds Max가 멈추거나 다음 메시지가 나타날 수 있습니다. Microsoft Visual C++ Runtime Library (Not Responding) Runtime Error! @@ -54,4 +54,4 @@ class BeforeAppLaunch(tank.get_hook_baseclass()): 그런 다음, 파이프라인 구성에서 `config/env/includes/app_launchers.yml`을 열고 `launch_3dsmax` 항목을 찾습니다. `hook_before_app_launch: default`를 `hook_before_app_launch: '{config}/before_app_launch.py'`로 바꿔야 합니다. -이제 Shotgun 및 Shotgun 데스크톱에서 3ds Max가 올바로 실행될 것입니다. 그래도 문제가 발생하면 support@shotgunsoftware.com으로 문의하시기 바랍니다. +이제 {% include product %} 및 {% include product %} 데스크톱에서 3ds Max가 올바로 실행될 것입니다. 그래도 문제가 발생하면 support@shotgunsoftware.com으로 문의하시기 바랍니다. diff --git a/docs/ko/quick-answers/troubleshooting/browser-integration-fails-linux.md b/docs/ko/quick-answers/troubleshooting/browser-integration-fails-linux.md index 6dc8342fd..e57c26fde 100644 --- a/docs/ko/quick-answers/troubleshooting/browser-integration-fails-linux.md +++ b/docs/ko/quick-answers/troubleshooting/browser-integration-fails-linux.md @@ -5,9 +5,9 @@ pagename: browser-integration-fails-linux lang: ko --- -# Shotgun 데스크톱/브라우저 통합을 Linux에서 실행할 수 없습니다 +# {% include product %} 데스크톱/브라우저 통합을 Linux에서 실행할 수 없습니다 -Linux에서 Shotgun 데스크톱을 처음 실행하면 다음 오류 메시지 중 하나가 나타날 수 있습니다. 그러면 해당 오류에 대해 아래 단계를 수행하여 오류가 해결되는지 확인해 보십시오. +Linux에서 {% include product %} 데스크톱을 처음 실행하면 다음 오류 메시지 중 하나가 나타날 수 있습니다. 그러면 해당 오류에 대해 아래 단계를 수행하여 오류가 해결되는지 확인해 보십시오. 여전히 해결되지 않으면 support@shotgunsoftware.com으로 문의하시기 바랍니다. ### 목차 @@ -51,13 +51,13 @@ libffi를 설치해야 합니다. 설치하려면 다음 명령을 관리자 권 yum install libffi ``` -libffi를 설치했는데도 여전히 작동하지 않으면 다음 symlink를 생성한 후 Shotgun 데스크톱을 다시 실행해 보십시오. +libffi를 설치했는데도 여전히 작동하지 않으면 다음 symlink를 생성한 후 {% include product %} 데스크톱을 다시 실행해 보십시오. ``` sudo ln -s /usr/lib64/libffi.so.6.0.1 /usr/lib64/libffi.so.5 ``` -위 방법으로 성공한 사용자들도 있고, 그렇지 못한 사용자들도 있습니다. 최신 버전 Shotgun 데스크톱에는 웹 소켓 서버에 대한 종속성이 일부 추가되었습니다. 현재 Shotgun 팀에서 해당 내용을 살펴보고 있습니다. +위 방법으로 성공한 사용자들도 있고, 그렇지 못한 사용자들도 있습니다. 최신 버전 {% include product %} 데스크톱에는 웹 소켓 서버에 대한 종속성이 일부 추가되었습니다. 현재 {% include product %} 팀에서 해당 내용을 살펴보고 있습니다. ## 인증서 유효성 확인 실패 관련 문제 @@ -71,7 +71,7 @@ certutil: function failed: SEC_ERROR_BAD_DATABASE: security library: bad databas **솔루션** -컴퓨터에 Google Chrome이 설치되어 있다면 이를 실행한 다음 Shotgun 데스크톱을 다시 실행합니다. 그래도 문제가 발생하면 support@shotgunsoftware.com으로 문의하시기 바랍니다. +컴퓨터에 Google Chrome이 설치되어 있다면 이를 실행한 다음 {% include product %} 데스크톱을 다시 실행합니다. 그래도 문제가 발생하면 support@shotgunsoftware.com으로 문의하시기 바랍니다. Chrome이 없으면 터미널을 열고 다음 명령을 실행합니다. @@ -93,7 +93,7 @@ $ certutil -N -d "sql:$HOME/.pki/nssdb" ``` 암호를 입력하지 마십시오. -Shotgun 데스크톱을 실행하면 이제 올바로 작동할 것입니다. +{% include product %} 데스크톱을 실행하면 이제 올바로 작동할 것입니다. ## 호환되지 않는 Qt 버전 diff --git a/docs/ko/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md b/docs/ko/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md index cfd1ee48f..163936a00 100644 --- a/docs/ko/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md +++ b/docs/ko/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md @@ -9,7 +9,7 @@ lang: ko ## 개요 -간혹 Shotgun의 액션 메뉴에 사용 가능한 툴킷 응용프로그램 목록이 표시되지 않거나, Shotgun 데스크톱이 실행 중인데도 로컬 파일 링크를 사용하면 오류가 발생할 수 있습니다. 이 문서는 Chrome에서 Shotgun 데스크톱의 브라우저 통합 문제를 해결하고, 원하는 기능들이 제대로 작동하도록 지원하는 안내서입니다. [Firefox](./cant-use-file-linking-toolkit-app-firefox.md)의 경우 별도의 안내서가 있습니다. +간혹 {% include product %}의 액션 메뉴에 사용 가능한 툴킷 응용프로그램 목록이 표시되지 않거나, {% include product %} 데스크톱이 실행 중인데도 로컬 파일 링크를 사용하면 오류가 발생할 수 있습니다. 이 문서는 Chrome에서 {% include product %} 데스크톱의 브라우저 통합 문제를 해결하고, 원하는 기능들이 제대로 작동하도록 지원하는 안내서입니다. [Firefox](./cant-use-file-linking-toolkit-app-firefox.md)의 경우 별도의 안내서가 있습니다. - [문제 진단](#diagnosing-the-issue) - [인증서 문제를 빠르게 해결하는 방법](#how-to-quickly-fix-certificate-issues) @@ -18,13 +18,13 @@ lang: ko ## 문제 진단 -### Shotgun 데스크톱이 실행 중입니까? +### {% include product %} 데스크톱이 실행 중입니까? 예, 알고 있습니다. 이미 확인하셨을 것이라 생각했지만 다시 한번 확인했습니다. :) -### Shotgun 데스크톱을 시작한 후에 Chrome을 다시 시작했습니까? +### {% include product %} 데스크톱을 시작한 후에 Chrome을 다시 시작했습니까? -Shotgun 데스크톱이 인증서를 등록(Shotgun 데스크톱을 처음 실행할 때에만 등록하면 되고, 이후부터는 문제 없음)하기 전에 Chrome을 실행했다면 Chrome이 오래된 인증서 사본을 사용하면서 Shotgun 데스크톱 연결을 거부합니다. 모든 탭을 닫는다고 해서 Chrome이 닫히는 것은 아니므로 주소 표시줄에 [chrome://restart](chrome://restart/)를 입력하고 Enter 키를 누르는 것이 좋습니다. 이렇게 하면 모든 Chrome 관련 프로세스가 종료되고, Chrome이 다시 시작됩니다. +{% include product %} 데스크톱이 인증서를 등록({% include product %} 데스크톱을 처음 실행할 때에만 등록하면 되고, 이후부터는 문제 없음)하기 전에 Chrome을 실행했다면 Chrome이 오래된 인증서 사본을 사용하면서 {% include product %} 데스크톱 연결을 거부합니다. 모든 탭을 닫는다고 해서 Chrome이 닫히는 것은 아니므로 주소 표시줄에 [chrome://restart](chrome://restart/)를 입력하고 Enter 키를 누르는 것이 좋습니다. 이렇게 하면 모든 Chrome 관련 프로세스가 종료되고, Chrome이 다시 시작됩니다. ### 방화벽 소프트웨어를 사용 중입니까? @@ -32,7 +32,7 @@ Shotgun 데스크톱이 인증서를 등록(Shotgun 데스크톱을 처음 실 ### Chrome이 인증서를 거부합니까? -https://localhost:9000으로 이동하여 Chrome이 인증서를 수락하는지 확인할 수 있습니다. 이 주소는 Shotgun 웹 사이트가 로컬 파일 링크를 수행하고 툴킷 응용프로그램을 실행하기 위해 액세스하는 주소입니다. 보통 다음 메시지가 나타나야 합니다. +https://localhost:9000으로 이동하여 Chrome이 인증서를 수락하는지 확인할 수 있습니다. 이 주소는 {% include product %} 웹 사이트가 로컬 파일 링크를 수행하고 툴킷 응용프로그램을 실행하기 위해 액세스하는 주소입니다. 보통 다음 메시지가 나타나야 합니다. ![Autobahn Python 메시지](images/autobahn-python.png) @@ -44,7 +44,7 @@ https://localhost:9000으로 이동하여 Chrome이 인증서를 수락하는지 ## 인증서 문제를 빠르게 해결하는 방법 -이 문제를 방지하는 가장 쉬운 방법은 **고급(ADVANCED)**, **localhost로 진행(Proceed to localhost)**(안전하지 않음)을 클릭하는 것입니다. 이렇게 하면 Chrome에서 여러분이 인증서를 수락하려고 한다는 것을 인식하고, Shotgun 웹 사이트가 Shotgun 데스크톱과 통신하도록 허용합니다. +이 문제를 방지하는 가장 쉬운 방법은 **고급(ADVANCED)**, **localhost로 진행(Proceed to localhost)**(안전하지 않음)을 클릭하는 것입니다. 이렇게 하면 Chrome에서 여러분이 인증서를 수락하려고 한다는 것을 인식하고, {% include product %} 웹 사이트가 {% include product %} 데스크톱과 통신하도록 허용합니다. {% include info title="참고" content="웹 브라우저와 Shotgun 데스크톱 간에 연결이 이루어지도록 할 수 있는 방법은 이것뿐입니다. 신뢰 설정은 두 응용프로그램 간 트래픽 흐름을 가능하도록 할 뿐, **인터넷 상의 다른 모든 서버에 대한 신뢰를 의미하는 것은 아닙니다**. 아쉽게도 이 프로세스는 문제가 있는 모든 컴퓨터마다 반복해야 합니다. 이렇게 해도 문제가 해결되지 않거나 모든 사용자들에게 알려주기에는 너무 복잡한 방법이라고 생각되는 경우 다음 단계를 살펴보시기 바랍니다." %} @@ -54,11 +54,11 @@ https://localhost:9000으로 이동하여 Chrome이 인증서를 수락하는지 Chrome은 자체 서명 인증서에 관한 보안을 정기적으로 업그레이드하며, 이 업데이트로 인해 종종 브라우저 통합이 끊어집니다. 불행히도 이런 종류의 문제는 인증서의 certificate_path를 다시 생성하는 방법으로만 해결할 수 있습니다. -인증서를 다시 생성하려면 Shotgun 데스크톱의 사용자 메뉴에 있는 **고급(Advanced)** 섹션에서 **인증서 재생성(Regenerate Certificates)** 옵션을 선택해야 합니다. (이 옵션이 보이지 않으면 `tk-desktop` 엔진을 업데이트하여 잠금 해제합니다.) +인증서를 다시 생성하려면 {% include product %} 데스크톱의 사용자 메뉴에 있는 **고급(Advanced)** 섹션에서 **인증서 재생성(Regenerate Certificates)** 옵션을 선택해야 합니다. (이 옵션이 보이지 않으면 `tk-desktop` 엔진을 업데이트하여 잠금 해제합니다.) -인증서 재생성을 확인하고 나면 인증서를 처음 생성했을 때처럼 일련의 대화상자가 나타납니다. Windows 및 macOS에서는 Windows 인증서 저장소 또는 macOS 키체인을 업데이트하라는 메시지가 두 번 나타납니다. 한 번은 이전 인증서를 제거하라는 메시지가 나타나고, 새 인증서를 등록하라는 메시지가 한 번 더 나타납니다. Linux에서는 등록이 자동으로 이루어집니다. 등록이 끝나면 Shotgun 데스크톱을 다시 시작합니다. +인증서 재생성을 확인하고 나면 인증서를 처음 생성했을 때처럼 일련의 대화상자가 나타납니다. Windows 및 macOS에서는 Windows 인증서 저장소 또는 macOS 키체인을 업데이트하라는 메시지가 두 번 나타납니다. 한 번은 이전 인증서를 제거하라는 메시지가 나타나고, 새 인증서를 등록하라는 메시지가 한 번 더 나타납니다. Linux에서는 등록이 자동으로 이루어집니다. 등록이 끝나면 {% include product %} 데스크톱을 다시 시작합니다. -Shotgun 데스크톱이 다시 시작되어 실행되면 주소 표시줄에 [chrome://restart](chrome://restart/)를 입력해 Chrome을 다시 시작함으로써 Chrome이 완전히 종료되고 인증서 캐시가 지워지도록 하는 것이 좋습니다. +{% include product %} 데스크톱이 다시 시작되어 실행되면 주소 표시줄에 [chrome://restart](chrome://restart/)를 입력해 Chrome을 다시 시작함으로써 Chrome이 완전히 종료되고 인증서 캐시가 지워지도록 하는 것이 좋습니다. 컴퓨터가 인터넷에 연결되어 있지 않아 업데이트를 다운로드할 수 없다면 support@shotgunsoftware.com에 문의하시기 바랍니다. @@ -98,4 +98,4 @@ Windows 키를 클릭하고 **mmc**를 입력한 다음 Enter 키를 누릅니 ## 다른 OS에서 문제 해결 -다른 OS에서 Shotgun 데스크톱 통합과 관련한 문제가 발생한다면 [지원 팀](https://support.shotgunsoftware.com/hc/ko/requests/new)에 연락해 도움을 받고, 이 게시글도 업데이트하도록 해 주십시오. \ No newline at end of file +다른 OS에서 {% include product %} 데스크톱 통합과 관련한 문제가 발생한다면 [지원 팀](https://support.shotgunsoftware.com/hc/ko/requests/new)에 연락해 도움을 받고, 이 게시글도 업데이트하도록 해 주십시오. \ No newline at end of file diff --git a/docs/ko/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md b/docs/ko/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md index a588efed9..4a4c8789a 100644 --- a/docs/ko/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md +++ b/docs/ko/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md @@ -9,12 +9,12 @@ lang: ko ## 개요 -간혹 Shotgun의 액션 메뉴에 사용 가능한 툴킷 응용프로그램 목록이 표시되지 않거나, Shotgun 데스크톱이 실행 중인데도 로컬 파일 링크를 사용하면 오류가 발생할 수 있습니다. -이 문서는 Firefox에서 Shotgun 데스크톱의 브라우저 통합 문제를 해결하고, 원하는 기능들이 제대로 작동하도록 하는 데 도움을 주기 위한 안내서입니다. [Chrome](./cant-use-file-linking-toolkit-app-chrome.md)의 경우 별도의 안내서가 있습니다. +간혹 {% include product %}의 액션 메뉴에 사용 가능한 툴킷 응용프로그램 목록이 표시되지 않거나, {% include product %} 데스크톱이 실행 중인데도 로컬 파일 링크를 사용하면 오류가 발생할 수 있습니다. +이 문서는 Firefox에서 {% include product %} 데스크톱의 브라우저 통합 문제를 해결하고, 원하는 기능들이 제대로 작동하도록 하는 데 도움을 주기 위한 안내서입니다. [Chrome](./cant-use-file-linking-toolkit-app-chrome.md)의 경우 별도의 안내서가 있습니다. ## 문제 진단 -### Shotgun 데스크톱이 실행 중입니까? +### {% include product %} 데스크톱이 실행 중입니까? 예, 알고 있습니다. 이미 확인하셨을 것이라 생각했지만 다시 한번 확인했습니다. :) @@ -24,7 +24,7 @@ lang: ko ### Firefox가 인증서를 거부합니까? -https://localhost:9000으로 이동하여 Firefox가 인증서를 수락하는지 확인할 수 있습니다. 이 주소는 Shotgun 웹 사이트가 로컬 파일 링크를 수행하고 툴킷 응용프로그램을 실행하기 위해 액세스하려고 시도하는 주소입니다. 보통 다음 메시지가 나타나야 합니다. +https://localhost:9000으로 이동하여 Firefox가 인증서를 수락하는지 확인할 수 있습니다. 이 주소는 {% include product %} 웹 사이트가 로컬 파일 링크를 수행하고 툴킷 응용프로그램을 실행하기 위해 액세스하려고 시도하는 주소입니다. 보통 다음 메시지가 나타나야 합니다. ![Autobahn Python 메시지](images/autobahn-python.png) @@ -40,9 +40,9 @@ https://localhost:9000으로 이동하여 Firefox가 인증서를 수락하는 ![Firefox에 예외 추가](images/add-exception-firefox.png) -****인증서 가져오기(Get Certificate)**를 클릭한 다음 **보안 예외 확인(Confirm Security Exception)을 클릭합니다. 인증서를 신뢰할 수 없다는 메시지는 무시해도 됩니다. 인증서가 인증 기관이 아닌 Shotgun 데스크톱에 의해 생성된 경우에 보통 발생하는 일입니다. +****인증서 가져오기(Get Certificate)**를 클릭한 다음 **보안 예외 확인(Confirm Security Exception)을 클릭합니다. 인증서를 신뢰할 수 없다는 메시지는 무시해도 됩니다. 인증서가 인증 기관이 아닌 {% include product %} 데스크톱에 의해 생성된 경우에 보통 발생하는 일입니다. -이제 Shotgun 사이트에서 로컬 파일 링크에 액세스하고 툴킷 응용프로그램을 실행할 수 있습니다. 예외를 추가한 뒤에도 계속 문제가 발생하면 support@shotgunsoftware.com으로 문의하십시오. +이제 {% include product %} 사이트에서 로컬 파일 링크에 액세스하고 툴킷 응용프로그램을 실행할 수 있습니다. 예외를 추가한 뒤에도 계속 문제가 발생하면 support@shotgunsoftware.com으로 문의하십시오. ## "보안 연결 실패" 문제를 해결하는 방법 diff --git a/docs/ko/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md b/docs/ko/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md index 67f4de851..053c02770 100644 --- a/docs/ko/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md +++ b/docs/ko/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md @@ -7,7 +7,7 @@ lang: ko # Python API에서 SSL: CERTIFICATE_VERIFY_FAILED 문제 수정 -Python API는 Shotgun에서 사용하는 다양한 웹 서비스에 연결하기 위해 사용자 시스템에 있고 API와 함께 번들로 제공되는 인증서 목록을 사용합니다. 그러나 새 인증서 인증 기관이 릴리즈되어 Python API 또는 OS와 함께 번들로 제공되지 않을 수 있습니다. +Python API는 {% include product %}에서 사용하는 다양한 웹 서비스에 연결하기 위해 사용자 시스템에 있고 API와 함께 번들로 제공되는 인증서 목록을 사용합니다. 그러나 새 인증서 인증 기관이 릴리즈되어 Python API 또는 OS와 함께 번들로 제공되지 않을 수 있습니다. Python API는 최신 인증서 사본을 제공하지만 2019년 2월 21일부터 최신 API 버전을 사용하는 경우에도 API에서 Amazon S3 업로드에 대해 해당 인증서를 사용하지 못하도록 하는 버그가 있습니다. 자세한 내용은 [이 AWS 블로그 게시물](https://aws.amazon.com/blogs/security/how-to-prepare-for-aws-move-to-its-own-certificate-authority/)을 참조하십시오. 다음 솔루션을 통해 상황을 일시적으로 해결할 수 있습니다. @@ -34,7 +34,7 @@ Python API는 최신 인증서 사본을 제공하지만 2019년 2월 21일부 1. Python API **v3.0.39**로 업그레이드합니다. -2. a. `SHOTGUN_API_CACERTS`를 `/path/to/shotgun_api3/lib/httplib2/cacerts.txt`로 설정합니다. +2. a. `{% include product %}_API_CACERTS`를 `/path/to/shotgun_api3/lib/httplib2/cacerts.txt`로 설정합니다. 또는 @@ -46,7 +46,7 @@ Python API는 최신 인증서 사본을 제공하지만 2019년 2월 21일부 2. [https://github.com/certifi/python-certifi/blob/master/certifi/cacert.pem](ttps://github.com/certifi/python-certifi/blob/master/certifi/cacert.pem)에서 최신 인증서 목록을 다운로드합니다. -3. `SHOTGUN_API_CACERTS`를 이 파일을 저장한 위치로 설정합니다. 하지만 툴킷은 Python API에서처럼 연결을 만들 때 `ca_certs` 매개변수 지정을 허용하지 않습니다. +3. `{% include product %}_API_CACERTS`를 이 파일을 저장한 위치로 설정합니다. 하지만 툴킷은 Python API에서처럼 연결을 만들 때 `ca_certs` 매개변수 지정을 허용하지 않습니다. ### Python API 또는 툴킷을 업데이트할 수 없는 경우 diff --git a/docs/ko/quick-answers/troubleshooting/houdini-integrations-not-starting.md b/docs/ko/quick-answers/troubleshooting/houdini-integrations-not-starting.md index eab266e2a..89d6ef5b8 100644 --- a/docs/ko/quick-answers/troubleshooting/houdini-integrations-not-starting.md +++ b/docs/ko/quick-answers/troubleshooting/houdini-integrations-not-starting.md @@ -5,14 +5,14 @@ pagename: houdini-integrations-not-starting lang: ko --- -# Houdini Shotgun 통합이 시작되지 않는 이유는 무엇일까요? +# Houdini {% include product %} 통합이 시작되지 않는 이유는 무엇일까요? -여기서는 Houdini에서 Shotgun 통합을 시작할 수 없는 가장 일반적인 원인을 살펴봅니다. 이 경우, Houdini는 Shotgun 데스크톱, Shotgun 웹 사이트 또는 tank 명령으로 오류 없이 시작됩니다. 하지만 Houdini가 시작된 후에 Shotgun 메뉴 또는 쉘프가 나타나지 않습니다. +여기서는 Houdini에서 {% include product %} 통합을 시작할 수 없는 가장 일반적인 원인을 살펴봅니다. 이 경우, Houdini는 {% include product %} 데스크톱, {% include product %} 웹 사이트 또는 tank 명령으로 오류 없이 시작됩니다. 하지만 Houdini가 시작된 후에 {% include product %} 메뉴 또는 쉘프가 나타나지 않습니다. -원인은 Shotgun이 재정의된 `HOUDINI_PATH` 환경 변수를 사용하여 시작 스크립트 경로를 전달하기 때문인 경우가 많습니다. +원인은 {% include product %}이 재정의된 `HOUDINI_PATH` 환경 변수를 사용하여 시작 스크립트 경로를 전달하기 때문인 경우가 많습니다. -Shotgun에서 Houdini가 시작되면 시작 앱 로직에서는 Shotgun 부트스트랩 스크립트 경로를 `HOUDINI_PATH` 환경 변수에 추가합니다. 그러나 Houdini에 [houdini.env 파일](http://www.sidefx.com/docs/houdini/basics/config_env.html#setting-environment-variables)이 있는 경우 문제가 발생할 수 있습니다. +{% include product %}에서 Houdini가 시작되면 시작 앱 로직에서는 {% include product %} 부트스트랩 스크립트 경로를 `HOUDINI_PATH` 환경 변수에 추가합니다. 그러나 Houdini에 [houdini.env 파일](http://www.sidefx.com/docs/houdini/basics/config_env.html#setting-environment-variables)이 있는 경우 문제가 발생할 수 있습니다. 이 파일을 통해 사용자는 Houdini가 로드될 때 제공되는 환경 변수를 설정할 수 있지만 파일에 정의된 모든 값이 현재 세션의 기존 환경 변수를 덮어씁니다. 이 문제를 해결하려면 기존의 `HOUDINI_PATH` 환경 변수를 해당 변수에 대한 새 정의에 포함해야 합니다. @@ -25,7 +25,7 @@ Shotgun에서 Houdini가 시작되면 시작 앱 로직에서는 Shotgun 부트 HOUDINI_PATH = /example/of/an/existing/path;$HOUDINI_PATH;& -그러면 Houdini가 시작될 때 Shotgun 설정 값을 유지할 수 있습니다. +그러면 Houdini가 시작될 때 {% include product %} 설정 값을 유지할 수 있습니다. {% include warning title="주의" content="Windows에서 `$HOUDINI_PATH`에 문제가 발생하는 경우가 있습니다. 간혹 Shotgun 통합을 여러 번 부트스트랩하며 다음과 같은 오류가 발생합니다. diff --git a/docs/ko/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md b/docs/ko/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md index 2fef2892d..08c42805a 100644 --- a/docs/ko/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md +++ b/docs/ko/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md @@ -5,24 +5,24 @@ pagename: menu-entries-missing-in-launched-dcc lang: ko --- -# SG 데스크톱에서 Nuke/Maya 등을 실행했는데 Shotgun 메뉴에 해당 항목이 없습니다 +# SG 데스크톱에서 Nuke/Maya 등을 실행했는데 {% include product %} 메뉴에 해당 항목이 없습니다 -Shotgun 메뉴에 표시되는 액션은 상황에 맞게 구성됩니다. 즉, 사용 가능한 액션 목록은 상황에 따라 다를 수 있습니다. +{% include product %} 메뉴에 표시되는 액션은 상황에 맞게 구성됩니다. 즉, 사용 가능한 액션 목록은 상황에 따라 다를 수 있습니다. 잘못된 상황에 있기 때문에 앱이 표시되지 않을 수 있습니다. ## 예시 -[Shotgun 데스크톱](https://support.shotgunsoftware.com/hc/ko/articles/219039818)에서 응용프로그램을 실행하면 기본적으로 프로젝트 환경으로 이동합니다. 이 환경은 `config/env/project.yml`에 있는 파이프라인 구성의 구성 파일에 의해 관리됩니다. 대부분의 사용자 작업이 이 환경에서 수행되지 않을 것이므로 이 환경에는 작업에 사용하는 앱이 대부분 구성되어 있지 않습니다. +[{% include product %} 데스크톱](https://support.shotgunsoftware.com/hc/ko/articles/219039818)에서 응용프로그램을 실행하면 기본적으로 프로젝트 환경으로 이동합니다. 이 환경은 `config/env/project.yml`에 있는 파이프라인 구성의 구성 파일에 의해 관리됩니다. 대부분의 사용자 작업이 이 환경에서 수행되지 않을 것이므로 이 환경에는 작업에 사용하는 앱이 대부분 구성되어 있지 않습니다. **기본 Maya 프로젝트 액션:** -![Shotgun 메뉴 프로젝트 액션](images/shotgun-menu-project-actions.png) +![{% include product %} 메뉴 프로젝트 액션](images/shotgun-menu-project-actions.png) -[Shotgun Workfiles 앱](https://support.shotgunsoftware.com/hc/ko/articles/219033088-Your-Work-Files)을 사용하여 작업할 에셋, 샷 또는 태스크를 선택할 수 있습니다. 이렇게 하면 적합한 새 환경이 로드되고 Shotgun 메뉴에 더 많은 앱과 메뉴 항목이 활성화됩니다. +[{% include product %} Workfiles 앱](https://support.shotgunsoftware.com/hc/ko/articles/219033088-Your-Work-Files)을 사용하여 작업할 에셋, 샷 또는 태스크를 선택할 수 있습니다. 이렇게 하면 적합한 새 환경이 로드되고 {% include product %} 메뉴에 더 많은 앱과 메뉴 항목이 활성화됩니다. **기본 Maya 에셋 태스크 액션** -![Shotgun 메뉴 프로젝트 액션](images/shotgun-menu-asset-step-actions.png) +![{% include product %} 메뉴 프로젝트 액션](images/shotgun-menu-asset-step-actions.png) 올바른 환경에 있는데도 액션이 표시되지 않을 경우 다음 단계는 관련 [로그](where-are-my-log-files.md)에 오류가 있는지 확인하는 것입니다. 전체 출력을 얻으려면 [디버그 로깅을 활성화](turn-debug-logging-on.md)해야 합니다. \ No newline at end of file diff --git a/docs/ko/quick-answers/troubleshooting/nuke-path-environment-variable.md b/docs/ko/quick-answers/troubleshooting/nuke-path-environment-variable.md index 05d86fcce..1e4b4c20d 100644 --- a/docs/ko/quick-answers/troubleshooting/nuke-path-environment-variable.md +++ b/docs/ko/quick-answers/troubleshooting/nuke-path-environment-variable.md @@ -10,7 +10,7 @@ lang: ko 통합은 Nuke 시작 프로세스 중에 부트스트랩 스크립트가 실행되도록 Nuke 시작 시 `NUKE_PATH` 환경 변수를 설정합니다. [`before_launch_app.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/6a884aa144851148e8369e9f35a2471087f98d16/hooks/before_app_launch.py) 후크를 실행하기 전에 특별히 `NUKE_PATH`를 정의하는 [`tk-multi-launchapp`](https://support.shotgunsoftware.com/hc/ko/articles/219032968-Application-Launcher#Set%20Environment%20Variables%20and%20Automate%20Behavior%20at%20Launch)입니다. -`os.environ['NUKE_PATH'] = "/my/custom/path"` 등을 사용하여 시작 프로세스 중에 이 환경 변수를 설정하면 환경 변수에서 시작 스크립트 경로를 제거하기 때문에 Shotgun 통합을 시작할 수도 없습니다. +`os.environ['NUKE_PATH'] = "/my/custom/path"` 등을 사용하여 시작 프로세스 중에 이 환경 변수를 설정하면 환경 변수에서 시작 스크립트 경로를 제거하기 때문에 {% include product %} 통합을 시작할 수도 없습니다. 경로를 툴킷 부트스트랩으로 유지하는 동안에는 경로를 `NUKE_PATH` 환경 변수에 추가하거나 접두사로 붙이는 다음 함수를 `tank.util`에 사용하십시오. diff --git a/docs/ko/quick-answers/troubleshooting/performance-troubleshooting.md b/docs/ko/quick-answers/troubleshooting/performance-troubleshooting.md index fb3a7d369..9143940b3 100644 --- a/docs/ko/quick-answers/troubleshooting/performance-troubleshooting.md +++ b/docs/ko/quick-answers/troubleshooting/performance-troubleshooting.md @@ -7,18 +7,18 @@ lang: ko # 성능 문제 해결 -툴킷 사용 시 속도가 느려지는 문제가 발생할 수 있습니다. 이러한 문제의 원인으로는 서버 속도, 인터넷 연결 등의 클라이언트 측 인프라 문제부터 툴킷 또는 Shotgun 구성 시 성능이 고려되지 않은 구성 관련 문제, 그리고 최적화를 추가적으로 적용할 코드 영역까지 다양할 수 있습니다. +툴킷 사용 시 속도가 느려지는 문제가 발생할 수 있습니다. 이러한 문제의 원인으로는 서버 속도, 인터넷 연결 등의 클라이언트 측 인프라 문제부터 툴킷 또는 {% include product %} 구성 시 성능이 고려되지 않은 구성 관련 문제, 그리고 최적화를 추가적으로 적용할 코드 영역까지 다양할 수 있습니다. 다음은 확인해야 할 사항의 목록으로, 아래에서 자세히 살펴보겠습니다. -- 앱, 엔진, 프레임워크, 코어 및 Shotgun 데스크톱이 [최신 상태](#keeping-up-to-date)인지 확인합니다. +- 앱, 엔진, 프레임워크, 코어 및 {% include product %} 데스크톱이 [최신 상태](#keeping-up-to-date)인지 확인합니다. - 일반적인 사용 중에 [디버그 로깅](./turn-debug-logging-on.md)이 활성화되지 않은 것을 확인합니다. - [필요한 폴더만 생성하며,](#folder-creation-is-slow) 폴더가 실제로 필요할 때만 생성되도록 제한합니다. 너무 많은 폴더를 스키마에 추가하면 속도가 느려집니다. -- 서버에 사용자 캐시를 저장하면 속도가 느려질 수 있습니다. 로컬 드라이브 위치를 가리키도록 [`SHOTGUN_HOME` 환경 변수](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)를 설정하여 사용자의 Shotgun 캐시를 리디렉션할 수 있습니다. +- 서버에 사용자 캐시를 저장하면 속도가 느려질 수 있습니다. 로컬 드라이브 위치를 가리키도록 [`{% include product %}_HOME` 환경 변수](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)를 설정하여 사용자의 {% include product %} 캐시를 리디렉션할 수 있습니다. - 아티스트에게 필요하지 않은 컨텐츠는 필터링하여 제외하도록 [Workfiles 및 Loader 앱](#file-open-file-save-or-the-loader-app-is-slow)을 구성합니다. 엔티티 목록을 아티스트의 현재 태스크와 관련이 있는 항목으로 간결하게 유지하려면 상태를 기준으로 필터링해 보십시오. - 커스텀 후크가 있는지 그리고 이러한 커스텀 후크로 인해 오버헤드가 증가하지는 않는지 확인하십시오. -아래 목록에는 모범 사례와 속도 저하 문제가 발생하는 일반적인 사례가 정리되어 있습니다. 전체 사례가 수록된 완전한 목록은 아니며 새로운 패턴이 발견되는 대로 목록에 추가하겠습니다. 이 안내서가 문제 원인을 파악하는 데 도움이 되지 않을 경우 언제든지 [지원 티켓](https://support.shotgunsoftware.com/hc/ko/requests/new)을 제출해 주십시오. Shotgun 팀이 도와드리겠습니다. +아래 목록에는 모범 사례와 속도 저하 문제가 발생하는 일반적인 사례가 정리되어 있습니다. 전체 사례가 수록된 완전한 목록은 아니며 새로운 패턴이 발견되는 대로 목록에 추가하겠습니다. 이 안내서가 문제 원인을 파악하는 데 도움이 되지 않을 경우 언제든지 [지원 티켓](https://support.shotgunsoftware.com/hc/ko/requests/new)을 제출해 주십시오. {% include product %} 팀이 도와드리겠습니다. 목차: - [일반적인 모범 사례](#general-good-practice) @@ -40,13 +40,13 @@ lang: ko ### 캐시 위치 -Shotgun 툴킷[은 사용자의 홈 디렉토리에 데이터를 캐시합니다](../administering/where-is-my-cache.md). 이 캐시에는 여러 가지 SQLite 데이터베이스와 캐시된 앱 및 구성이 포함될 수 있습니다. 대개 사용자의 홈 디렉토리는 시스템의 로컬 하드 드라이브에 저장되지만, 스튜디오에서 이를 네트워크 저장소로 리디렉션하는 경우가 많습니다. 이렇게 되면 성능에 영향을 미칠 수 있습니다. 특히, 브라우저 통합 및 폴더 생성/조회 등에 사용되는 SQLite 데이터베이스에 주로 영향을 미칩니다. +{% include product %} 툴킷[은 사용자의 홈 디렉토리에 데이터를 캐시합니다](../administering/where-is-my-cache.md). 이 캐시에는 여러 가지 SQLite 데이터베이스와 캐시된 앱 및 구성이 포함될 수 있습니다. 대개 사용자의 홈 디렉토리는 시스템의 로컬 하드 드라이브에 저장되지만, 스튜디오에서 이를 네트워크 저장소로 리디렉션하는 경우가 많습니다. 이렇게 되면 성능에 영향을 미칠 수 있습니다. 특히, 브라우저 통합 및 폴더 생성/조회 등에 사용되는 SQLite 데이터베이스에 주로 영향을 미칩니다. -사용자 디렉토리가 서버 위치에 저장되는 경우 [`SHOTGUN_HOME` 환경 변수](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)를 사용하여 Shotgun 툴킷 캐시의 경로를 변경하는 것이 좋습니다. `SHOTGUN_HOME` 환경 변수는 툴킷이 번들 캐시, 썸네일, 그리고 데이터의 빠른 조회에 사용되는 SQLite 데이터베이스 등과 같은 다양한 데이터를 캐시하는 위치를 설정하는 데 사용됩니다. +사용자 디렉토리가 서버 위치에 저장되는 경우 [`{% include product %}_HOME` 환경 변수](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)를 사용하여 {% include product %} 툴킷 캐시의 경로를 변경하는 것이 좋습니다. `{% include product %}_HOME` 환경 변수는 툴킷이 번들 캐시, 썸네일, 그리고 데이터의 빠른 조회에 사용되는 SQLite 데이터베이스 등과 같은 다양한 데이터를 캐시하는 위치를 설정하는 데 사용됩니다. ### 디버깅 -Shotgun 툴킷에서 디버그 로깅을 활성화할 수 있습니다. 그러면 다양한 프로세스에 대한 출력을 더욱 상세하게 얻을 수 있습니다. 문제를 진단하는 데 아주 유용한 기능이지만, 디버그 설정은 일상적인 사용 중에는 활성화되도록 설계되지 않았습니다. 로깅 출력이 늘어나면 성능에 상당한 영향을 미칠 수 있습니다. +{% include product %} 툴킷에서 디버그 로깅을 활성화할 수 있습니다. 그러면 다양한 프로세스에 대한 출력을 더욱 상세하게 얻을 수 있습니다. 문제를 진단하는 데 아주 유용한 기능이지만, 디버그 설정은 일상적인 사용 중에는 활성화되도록 설계되지 않았습니다. 로깅 출력이 늘어나면 성능에 상당한 영향을 미칠 수 있습니다. 성능 문제가 발생하면, 특히 특정 시스템 또는 사용자에 국한되어 성능 문제가 발생하는 경우 먼저 [디버그 로깅](./turn-debug-logging-on.md)이 활성화되지 않은 것을 확인하십시오. @@ -72,23 +72,23 @@ Shotgun 툴킷에서 디버그 로깅을 활성화할 수 있습니다. 그러 {% include info title="참고" content="분산 구성을 사용하고 싶지만 시스템별로 종속 항목을 다운로드하는 것이 염려된다면 번들 캐시를 중앙 집중화하여 모든 사용자가 공유하도록 할 수 있습니다." %} -분산 구성을 사용하는 경우 사용자는 캐시에 없는 항목만 다운로드하면 되며, 한 사용자가 다운로드한 항목을 다른 사용자도 활용할 수 있게 됩니다. 이렇게 하려면 각 시스템에서 공유 위치를 가리키도록 [`SHOTGUN_BUNDLE_CACHE_PATH` 환경 변수](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)를 설정하면 됩니다. +분산 구성을 사용하는 경우 사용자는 캐시에 없는 항목만 다운로드하면 되며, 한 사용자가 다운로드한 항목을 다른 사용자도 활용할 수 있게 됩니다. 이렇게 하려면 각 시스템에서 공유 위치를 가리키도록 [`{% include product %}_BUNDLE_CACHE_PATH` 환경 변수](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)를 설정하면 됩니다. ## 소프트웨어의 시작 속도가 느림 -Maya, Nuke, Houdini 등의 소프트웨어를 시작할 때 Shotgun 없이 시작할 때보다 시간이 오래 걸리는 것을 알아차리셨을 것입니다. Shotgun 없이 시작하는 경우보다 시간이 약간 더 오래 걸리는 것은 당연하겠지만, 용납할 수 없을 정도로 오래 걸리는 경우도 있을 수 있습니다. 소프트웨어에 따라 다르지만 대개 1분 안에 시작되어야 합니다. 소프트웨어를 시작하는 데는 많은 프로세스가 관련되기 때문에 이 문제를 진단하는 것은 더 어려울 수 있습니다. +Maya, Nuke, Houdini 등의 소프트웨어를 시작할 때 {% include product %} 없이 시작할 때보다 시간이 오래 걸리는 것을 알아차리셨을 것입니다. {% include product %} 없이 시작하는 경우보다 시간이 약간 더 오래 걸리는 것은 당연하겠지만, 용납할 수 없을 정도로 오래 걸리는 경우도 있을 수 있습니다. 소프트웨어에 따라 다르지만 대개 1분 안에 시작되어야 합니다. 소프트웨어를 시작하는 데는 많은 프로세스가 관련되기 때문에 이 문제를 진단하는 것은 더 어려울 수 있습니다. ### 진단 먼저, 이 문제가 어떠한 상황에서 발생하는지 파악해야 합니다. -1. **Shotgun 없이 시작할 때도 속도가 느립니까?** - 뻔한 이야기일 수 있지만 Shotgun과 함께 시작할 때만 문제가 발생하는지 확인하는 것이 좋습니다. -2. **시작 방법에 상관없이 동일하게 속도가 느립니까? 즉, SG 데스크톱에서 시작할 때나, 브라우저 통합을 사용하여 SG 사이트에서 시작할 때 느린 속도에 차이가 없습니까?** - Shotgun 사이트에서 시작할 때는 속도가 느리지만 SG 데스크톱에서 시작할 때는 속도가 느리지 않은 경우 브라우저 통합 문제이거나 디스크에 폴더를 생성하는 것과 관련한 문제가 있음을 나타낼 수 있습니다. 프로젝트 이외의 컨텍스트에서 시작하는 경우 디스크에 추가로 폴더를 생성해 보면 시간이 어디서 많이 걸리는지 확인할 수 있습니다. 소프트웨어가 시작될 때마다 필요한 폴더가 존재하는지 확인한다는 사실도 주목해야 합니다. +1. **{% include product %} 없이 시작할 때도 속도가 느립니까?** - 뻔한 이야기일 수 있지만 {% include product %}과 함께 시작할 때만 문제가 발생하는지 확인하는 것이 좋습니다. +2. **시작 방법에 상관없이 동일하게 속도가 느립니까? 즉, SG 데스크톱에서 시작할 때나, 브라우저 통합을 사용하여 SG 사이트에서 시작할 때 느린 속도에 차이가 없습니까?** - {% include product %} 사이트에서 시작할 때는 속도가 느리지만 SG 데스크톱에서 시작할 때는 속도가 느리지 않은 경우 브라우저 통합 문제이거나 디스크에 폴더를 생성하는 것과 관련한 문제가 있음을 나타낼 수 있습니다. 프로젝트 이외의 컨텍스트에서 시작하는 경우 디스크에 추가로 폴더를 생성해 보면 시간이 어디서 많이 걸리는지 확인할 수 있습니다. 소프트웨어가 시작될 때마다 필요한 폴더가 존재하는지 확인한다는 사실도 주목해야 합니다. 3. **모든 프로젝트에서 이 문제가 발생합니까?** - 그렇지 않다면 구성이 설정된 방식과 관련하여 문제가 있을 가능성이 큽니다. 4. **하루 중 특정 시간에만 이 문제가 발생합니까?** - 그렇다면 하루 중 특정 시간에 서버 사용량이 많은 경우와 같이 인프라에 대한 수요가 높다는 것을 나타낼 수 있습니다. 5. **모든 시스템/OS에서 이 문제가 발생합니까?** - 특정 시스템에서만 속도가 느린 경우 툴킷 외부에 문제의 원인이 있을 가능성이 있습니다. 이 경우, 먼저 해당 시스템에서 툴킷 캐시를 지우는 것이 좋습니다. OS마다 제공되는 소프트웨어 버전 및 Python 패키지가 다르며, 특정 빌드에서 성능 문제가 발생하는 경우가 있을 수 있습니다. 특히, Samba(SMB) 공유를 사용하는 Windows에서 성능 문제를 확인했습니다. 이러한 문제에 대한 수정 사항은 없지만, Windows를 사용하는 경우 유의하시기 바랍니다. - 문제가 특정 OS, Python 패키지 또는 소프트웨어 버전으로 국한된다고 판단되는 경우 Shotgun [지원 팀](https://support.shotgunsoftware.com/hc/ko/requests/new)에서 추가적인 조사를 진행할 수 있도록 알려주시기 바랍니다. -6. **모든 사용자에게 이 문제가 발생합니까?** - 위와 마찬가지로 동일한 시스템의 다른 사용자에게는 이 문제가 발생하지 않을 수 있습니다. 이 경우, 사용자의 로컬 Shotgun 캐시를 먼저 지우십시오. 또한, 정상적으로 프로덕션 환경에서 사용할 때 디버그 로깅이 활성화되지 않은 것을 확인하십시오. 활성화할 경우 성능에 영향을 미치게 됩니다. -7. **느린 시작 문제가 특정 앱/소프트웨어에만 국한됩니까? 아니면 모든 앱/소프트웨어가 비정상적으로 느리게 시작됩니까?** - 특정 소프트웨어만 느리게 시작되는 경우 구성 문제가 있을 수 있습니다. 성능에 영향을 미칠 수 있는 커스텀 후크가 시작 전이나 후에 실행되도록 설정되었는지 확인하는 것이 좋습니다. 시작에 사용되는 일반 후크는 [`before_app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/master/hooks/before_app_launch.py), [`app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/master/hooks/app_launch.py)이며 코어 후크는 [`engine_init.py`](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/engine_init.py)입니다. 최신 버전의 소프트웨어가 출시될 때 Shotgun 통합이 갑자기 훨씬 더 느리게 시작되는 등의 문제가 발생할 수도 있습니다. 이러한 경우 [지원 팀](https://support.shotgunsoftware.com/hc/ko/requests/new)에 문의하여 이에 대해 알고 있는지, 그리고 알려진 수정 사항이 있는지 확인해야 합니다. 이때 현재 사용 중인 소프트웨어의 버전 번호(해당하는 경우 패치/서비스 팩 포함)와 현재 실행 중인 tk 엔진 및 코어의 버전을 알려 주십시오. + 문제가 특정 OS, Python 패키지 또는 소프트웨어 버전으로 국한된다고 판단되는 경우 {% include product %} [지원 팀](https://support.shotgunsoftware.com/hc/ko/requests/new)에서 추가적인 조사를 진행할 수 있도록 알려주시기 바랍니다. +6. **모든 사용자에게 이 문제가 발생합니까?** - 위와 마찬가지로 동일한 시스템의 다른 사용자에게는 이 문제가 발생하지 않을 수 있습니다. 이 경우, 사용자의 로컬 {% include product %} 캐시를 먼저 지우십시오. 또한, 정상적으로 프로덕션 환경에서 사용할 때 디버그 로깅이 활성화되지 않은 것을 확인하십시오. 활성화할 경우 성능에 영향을 미치게 됩니다. +7. **느린 시작 문제가 특정 앱/소프트웨어에만 국한됩니까? 아니면 모든 앱/소프트웨어가 비정상적으로 느리게 시작됩니까?** - 특정 소프트웨어만 느리게 시작되는 경우 구성 문제가 있을 수 있습니다. 성능에 영향을 미칠 수 있는 커스텀 후크가 시작 전이나 후에 실행되도록 설정되었는지 확인하는 것이 좋습니다. 시작에 사용되는 일반 후크는 [`before_app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/master/hooks/before_app_launch.py), [`app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/master/hooks/app_launch.py)이며 코어 후크는 [`engine_init.py`](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/engine_init.py)입니다. 최신 버전의 소프트웨어가 출시될 때 {% include product %} 통합이 갑자기 훨씬 더 느리게 시작되는 등의 문제가 발생할 수도 있습니다. 이러한 경우 [지원 팀](https://support.shotgunsoftware.com/hc/ko/requests/new)에 문의하여 이에 대해 알고 있는지, 그리고 알려진 수정 사항이 있는지 확인해야 합니다. 이때 현재 사용 중인 소프트웨어의 버전 번호(해당하는 경우 패치/서비스 팩 포함)와 현재 실행 중인 tk 엔진 및 코어의 버전을 알려 주십시오. ### 문제가 시작 전에 발생합니까? 아니면 시작 후에 발생합니까? @@ -99,13 +99,13 @@ Maya, Nuke, Houdini 등의 소프트웨어를 시작할 때 Shotgun 없이 시 일반적으로, 성능 문제가 프로세스의 첫 번째 단계에서 발생하는지 아니면 두 번째 단계에서 발생하는지는 로그를 확인하지 않고도 알 수 있습니다. - 소프트웨어의 시작 화면이 시작하는 데 오래 걸리는 경우 첫 번째 단계에 문제가 있을 가능성이 큽니다. -- 소프트웨어가 시작 과정의 초반에는 상대적으로 속도가 빨랐다가 초기화가 완료되고 Shotgun 메뉴가 표시된 후 느려지는지 확인하십시오. 이 경우 두 번째 단계에 문제가 있는 것입니다. +- 소프트웨어가 시작 과정의 초반에는 상대적으로 속도가 빨랐다가 초기화가 완료되고 {% include product %} 메뉴가 표시된 후 느려지는지 확인하십시오. 이 경우 두 번째 단계에 문제가 있는 것입니다. 이를 파악하고 나면 로그에서 무엇을 확인해야 할지 알 수 있습니다. ### 로그 확인 -이제 이 문제가 시작의 첫 번째 단계에서 발생했는지 아니면 두 번째 단계에서 발생했는지 파악되었을 것이므로 이에 따라 로그에서 확인할 부분을 결정할 수 있습니다. 로그는 엔진별로 나뉘어 있으므로 문제가 시작 전 단계에서 발생한 경우 SG 데스크톱에서 시작했는지 아니면 SG 사이트에서 시작했는지에 따라 각각 `tk-desktop.log` 또는 `tk-shotgun.log`를 확인해야 합니다. +이제 이 문제가 시작의 첫 번째 단계에서 발생했는지 아니면 두 번째 단계에서 발생했는지 파악되었을 것이므로 이에 따라 로그에서 확인할 부분을 결정할 수 있습니다. 로그는 엔진별로 나뉘어 있으므로 문제가 시작 전 단계에서 발생한 경우 SG 데스크톱에서 시작했는지 아니면 SG 사이트에서 시작했는지에 따라 각각 `tk-desktop.log` 또는 `tk-{% include product %}.log`를 확인해야 합니다. 다음으로 수행해야 하는 작업은 디버그 로깅을 활성화하는 것입니다. {% include info title="참고" content="[위에서 설명한 대로](#debugging) 디버그 로깅이 이미 활성화된 경우 이것이 속도 저하 문제의 원인이 될 수 있으므로 디버그 로깅이 활성화되지 않은 상태에서도 테스트해야 합니다." %} @@ -117,14 +117,14 @@ Maya, Nuke, Houdini 등의 소프트웨어를 시작할 때 Shotgun 없이 시 2019-05-01 11:28:01,847 [82801 INFO sgtk.env.asset.tk-shotgun.tk-shotgun-folders] 1 Asset processed - Processed 66 folders on disk. -시간이 건너뛴 부분을 찾고 나면 해당 로그 행에서 폴더를 생성 중이었는지 아니면 Shotgun에 연결 중이었는지와 같이 해당 단계에서 어떠한 작업이 수행 중이었는지 확인할 수 있습니다. +시간이 건너뛴 부분을 찾고 나면 해당 로그 행에서 폴더를 생성 중이었는지 아니면 {% include product %}에 연결 중이었는지와 같이 해당 단계에서 어떠한 작업이 수행 중이었는지 확인할 수 있습니다. 로그를 읽는 것이 어렵거나 내용이 이해되지 않는 경우에는 [지원 팀](https://support.shotgunsoftware.com/hc/ko/requests/new)에 문의하여 도움을 받으십시오. ### 소프트웨어의 실행 속도가 느려지는 일반적인 원인 |-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **인터넷 속도가 느림** | 툴킷 사용의 거의 모든 부분에서 Shotgun 사이트에 연결하고 통신해야 하므로 인터넷 속도가 느릴 경우 영향을 받을 수 있습니다. 이 경우, 소프트웨어를 시작할 때뿐 아니라 다른 경우에도 속도 문제가 나타날 수 있습니다. 그러나, 연결 속도가 아닌 안정성에 문제가 있다면 프로세스 전반에 걸쳐 Shotgun 통신이 꽤 많이 필요하기 때문에 시작 단계에서 성능 문제가 나타날 가능성이 더 큽니다. | +| **인터넷 속도가 느림** | 툴킷 사용의 거의 모든 부분에서 {% include product %} 사이트에 연결하고 통신해야 하므로 인터넷 속도가 느릴 경우 영향을 받을 수 있습니다. 이 경우, 소프트웨어를 시작할 때뿐 아니라 다른 경우에도 속도 문제가 나타날 수 있습니다. 그러나, 연결 속도가 아닌 안정성에 문제가 있다면 프로세스 전반에 걸쳐 {% include product %} 통신이 꽤 많이 필요하기 때문에 시작 단계에서 성능 문제가 나타날 가능성이 더 큽니다. | | **서버 액세스가 느림** | 이 경우 시작 시간에 확실히 영향을 미칠 수 있습니다. [중앙 집중식 구성](#centralized-configs-vs-distributed-configs)(구성이 중앙 서버에 저장됨)을 사용하는 경우 구성 파일을 읽을 때마다 많은 입출력이 발생할 수 있습니다. 또한, 소프트웨어를 시작하면 시작 컨텍스트에 대해 폴더 생성 작업이 트리거됩니다. 즉, 폴더가 생성되었는지 확인하고 생성되지 않은 경우 폴더가 새로 만들어집니다. | | **폴더 생성** | 위에 설명한 대로 폴더 생성은 속도 저하 문제를 일으키는 일반적인 원인이 될 수 있습니다. [자세한 내용은 아래에서 폴더 생성과 관련한 성능 문제 해결 단원을 참조하십시오.](#folder-creation-is-slow) | @@ -204,7 +204,7 @@ sgtk.create_filesystem_structure(entity["type"], entity["id"], engine="publish") ### 폴더 등록 -향후 컨텍스트를 조회할 때 경로가 사용될 수 있도록 폴더 생성 프로세스 중에 폴더가 [등록](../administering/what-is-path-cache.md)됩니다. [위에서 설명한 대로](#folder-creation-is-slow) 이 프로세스 부분을 실행하기 위해서는 레지스트리가 저장된 중앙 위치인 Shotgun 사이트와의 통신이 필요합니다. 하지만, 도구에서 더욱 신속하게 조회할 수 있도록 이러한 레지스트리는 로컬로도 캐시됩니다. +향후 컨텍스트를 조회할 때 경로가 사용될 수 있도록 폴더 생성 프로세스 중에 폴더가 [등록](../administering/what-is-path-cache.md)됩니다. [위에서 설명한 대로](#folder-creation-is-slow) 이 프로세스 부분을 실행하기 위해서는 레지스트리가 저장된 중앙 위치인 {% include product %} 사이트와의 통신이 필요합니다. 하지만, 도구에서 더욱 신속하게 조회할 수 있도록 이러한 레지스트리는 로컬로도 캐시됩니다. #### SQLite 데이터베이스 diff --git a/docs/ko/quick-answers/troubleshooting/turn-debug-logging-on.md b/docs/ko/quick-answers/troubleshooting/turn-debug-logging-on.md index f2dcee61f..8c448ce17 100644 --- a/docs/ko/quick-answers/troubleshooting/turn-debug-logging-on.md +++ b/docs/ko/quick-answers/troubleshooting/turn-debug-logging-on.md @@ -7,13 +7,13 @@ lang: ko # 디버그 로깅을 어떻게 켭니까? -## Shotgun 데스크톱을 통해 디버깅 활성화 +## {% include product %} 데스크톱을 통해 디버깅 활성화 -디버깅을 활성화하는 가장 쉬운 방법은 Shotgun 데스크톱 앱을 통해 켜는 것입니다. Shotgun 데스크톱에 로그인하고 나면 설정할 수 있습니다. 앱 오른쪽 아래에 있는 프로파일 사진을 클릭하고 **고급(Advanced) -> 디버그 로깅 토글(Toggle Debug Logging)**을 선택합니다. 이 설정은 세션 간에 영속적이기 때문에 작업을 마치면 끄는 것을 잊지 마십시오. +디버깅을 활성화하는 가장 쉬운 방법은 {% include product %} 데스크톱 앱을 통해 켜는 것입니다. {% include product %} 데스크톱에 로그인하고 나면 설정할 수 있습니다. 앱 오른쪽 아래에 있는 프로파일 사진을 클릭하고 **고급(Advanced) -> 디버그 로깅 토글(Toggle Debug Logging)**을 선택합니다. 이 설정은 세션 간에 영속적이기 때문에 작업을 마치면 끄는 것을 잊지 마십시오. ![SG 데스크톱에서 디버그 로깅 토글](images/desktop-enable-debug-logging.png) -이 기능을 켜면 Shotgun 데스크톱에서 실행한 앱 또는 브라우저 통합을 통한 툴킷 명령도 이 디버그 상태를 상속한다는 점에도 유의하십시오. +이 기능을 켜면 {% include product %} 데스크톱에서 실행한 앱 또는 브라우저 통합을 통한 툴킷 명령도 이 디버그 상태를 상속한다는 점에도 유의하십시오. ## 환경 변수 설정 diff --git a/docs/ko/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md b/docs/ko/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md index 663ce834c..f539a589e 100644 --- a/docs/ko/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md +++ b/docs/ko/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md @@ -9,13 +9,13 @@ lang: ko ## 어떤 문제가 있습니까? -After Effects 통합 릴리즈에는 Shotgun과 통합되는 모든 Adobe 앱에서 사용할 수 있는 공통 플러그인이 있습니다. 이를 구현하는 과정에서, 이전 Photoshop 통합과의 호환성을 유지하고 스튜디오에서 확실하게 해당 업데이트로 전환할 수 있도록 하기 위해 익스텐션의 이름을 변경해야 했습니다. +After Effects 통합 릴리즈에는 {% include product %}과 통합되는 모든 Adobe 앱에서 사용할 수 있는 공통 플러그인이 있습니다. 이를 구현하는 과정에서, 이전 Photoshop 통합과의 호환성을 유지하고 스튜디오에서 확실하게 해당 업데이트로 전환할 수 있도록 하기 위해 익스텐션의 이름을 변경해야 했습니다. -하지만 이로 인해 업그레이드할 때 두 개의 Shotgun 익스텐션이 설치될 수 있습니다. +하지만 이로 인해 업그레이드할 때 두 개의 {% include product %} 익스텐션이 설치될 수 있습니다. -![Photoshop 메뉴에 여러 개의 Shotgun 익스텐션 표시](./images/photoshop-extension-panel.png) +![Photoshop 메뉴에 여러 개의 {% include product %} 익스텐션 표시](./images/photoshop-extension-panel.png) -**Shotgun Adobe 패널**은 새로운 익스텐션으로, `v1.7.0` 이상의 Photoshop 통합을 사용하는 경우에 사용해야 합니다. +**{% include product %} Adobe 패널**은 새로운 익스텐션으로, `v1.7.0` 이상의 Photoshop 통합을 사용하는 경우에 사용해야 합니다. ## 문제를 어떻게 해결할 수 있습니까? @@ -24,7 +24,7 @@ After Effects 통합 릴리즈에는 Shotgun과 통합되는 모든 Adobe 앱에 - OSX: `~/Library/Application Support/Adobe/CEP/extensions/com.sg.basic.ps` - Windows: `%AppData%\Adobe\CEP\extensions\com.sg.basic.ps` -![Photoshop 메뉴에 여러 개의 Shotgun 익스텐션 표시](./images/shotgun-desktop-console-photoshop-extension.png) +![Photoshop 메뉴에 여러 개의 {% include product %} 익스텐션 표시](./images/shotgun-desktop-console-photoshop-extension.png) Photoshop을 종료하고 해당 디렉토리를 제거하고 난 후 다시 시작하면 하나의 익스텐션만 확인됩니다. diff --git a/docs/ko/quick-answers/troubleshooting/where-are-my-log-files.md b/docs/ko/quick-answers/troubleshooting/where-are-my-log-files.md index f93cac6c3..e41952d49 100644 --- a/docs/ko/quick-answers/troubleshooting/where-are-my-log-files.md +++ b/docs/ko/quick-answers/troubleshooting/where-are-my-log-files.md @@ -7,7 +7,7 @@ lang: ko # 로그 파일은 어디에 있습니까? -기본적으로 Shotgun 데스크톱 및 통합은 로그 파일을 다음 디렉토리에 저장합니다. +기본적으로 {% include product %} 데스크톱 및 통합은 로그 파일을 다음 디렉토리에 저장합니다. **Mac** @@ -23,6 +23,6 @@ lang: ko 로그 파일 이름의 형식은 `tk-.log`입니다. 예를 들면 `tk-desktop.log` 또는 `tk-maya.log`입니다. -[`SHOTGUN_HOME` 환경 변수](http://developer.shotgunsoftware.com/tk-core/utils.html#localfilestoragemanager)를 설정하여 사용자의 캐시 위치를 재정의한 경우 로그 파일이 `$SHOTGUN_HOME/logs`에 위치하게 됩니다. +[`{% include product %}_HOME` 환경 변수](http://developer.shotgunsoftware.com/tk-core/utils.html#localfilestoragemanager)를 설정하여 사용자의 캐시 위치를 재정의한 경우 로그 파일이 `$SHOTGUN_HOME/logs`에 위치하게 됩니다. {% include info title="참고" content="Shotgun 데스크톱에서도 이 디렉토리에 액세스할 수 있습니다. 프로젝트를 선택하고, 프로젝트 이름 오른쪽에 있는 아래쪽 화살표 버튼을 클릭하고, **로그 폴더 열기(Open Log Folder)**를 선택하면 됩니다." %} diff --git a/docs/ko/quick-answers/workflow/version-publishedfile-difference.md b/docs/ko/quick-answers/workflow/version-publishedfile-difference.md index 7e6e908eb..3ed9551fa 100644 --- a/docs/ko/quick-answers/workflow/version-publishedfile-difference.md +++ b/docs/ko/quick-answers/workflow/version-publishedfile-difference.md @@ -7,9 +7,9 @@ lang: ko # 버전과 게시된 파일 간의 차이점은 무엇입니까? -**"게시"**는 디스크에 저장되어 응용프로그램 내에서 사용할 수 있는 파일(또는 이미지 시퀀스)이나 데이터를 의미합니다. exr 시퀀스, abc, Maya 파일 등이 여기에 포함될 수 있습니다. 게시는 Shotgun 내에서 `PublishedFile` 엔티티로 표현됩니다. +**"게시"**는 디스크에 저장되어 응용프로그램 내에서 사용할 수 있는 파일(또는 이미지 시퀀스)이나 데이터를 의미합니다. exr 시퀀스, abc, Maya 파일 등이 여기에 포함될 수 있습니다. 게시는 {% include product %} 내에서 `PublishedFile` 엔티티로 표현됩니다. -**"버전"**(Shotgun 내 `Version` 엔티티)은 게시의 시각적 표현이며 리뷰 및 노트 작성에 사용됩니다. `Version` 엔티티에는 게시된 파일이라고 하는 필드가 있습니다. 이 필드에는 서로 연결할 게시 레코드의 수를 입력할 수 있습니다. 이를 통해 어떠한 리뷰 `Version`이 게시 그룹과 연결되는지 트래킹할 수 있습니다. 게시할 때 이 관계를 입력하는 것이 좋습니다. 버전은 Shotgun 내에서 `Version` 엔티티로 표현됩니다. +**"버전"**({% include product %} 내 `Version` 엔티티)은 게시의 시각적 표현이며 리뷰 및 노트 작성에 사용됩니다. `Version` 엔티티에는 게시된 파일이라고 하는 필드가 있습니다. 이 필드에는 서로 연결할 게시 레코드의 수를 입력할 수 있습니다. 이를 통해 어떠한 리뷰 `Version`이 게시 그룹과 연결되는지 트래킹할 수 있습니다. 게시할 때 이 관계를 입력하는 것이 좋습니다. 버전은 {% include product %} 내에서 `Version` 엔티티로 표현됩니다. 궁극적인 아이디어는 게시할 때 파일 모음, 그러니까 대개 파일 형식은 다르지만 실질적으로 같은 내용을 가진 파일(Maya 파일, obj, alembic 등)을 생성할 수 있도록 하는 것입니다. 그리고 결국 이 파일들은 모두 같은 것을 서로 다르게 표현한 것입니다. 그런 후 이 파일들은 게시 데이터 미리보기 및 노트 작성을 위해 단일 리뷰 `Version`과 연결됩니다. diff --git a/docs/ko/reference/pipeline-integrations/env-config-ref.md b/docs/ko/reference/pipeline-integrations/env-config-ref.md index 63a19d847..e6ec12f24 100644 --- a/docs/ko/reference/pipeline-integrations/env-config-ref.md +++ b/docs/ko/reference/pipeline-integrations/env-config-ref.md @@ -15,7 +15,7 @@ lang: ko ## 환경이란? -Shotgun 툴킷 플랫폼은 스튜디오 파이프라인을 구축하는 데 일반적으로 사용되는 컨텐츠 작성 소프트웨어를 위해 완전히 커스터마이즈 가능한 통합 세트를 제공합니다. 프로젝트 구성 내에서 통합이 있는 소프트웨어 패키지, 각각 사용 가능한 툴킷 앱, 각 앱에 대한 옵션을 지정하여 스튜디오의 요구 사항에 맞게 아티스트 워크플로우를 구축할 수 있습니다. +{% include product %} 툴킷 플랫폼은 스튜디오 파이프라인을 구축하는 데 일반적으로 사용되는 컨텐츠 작성 소프트웨어를 위해 완전히 커스터마이즈 가능한 통합 세트를 제공합니다. 프로젝트 구성 내에서 통합이 있는 소프트웨어 패키지, 각각 사용 가능한 툴킷 앱, 각 앱에 대한 옵션을 지정하여 스튜디오의 요구 사항에 맞게 아티스트 워크플로우를 구축할 수 있습니다. 하지만 대부분의 스튜디오 파이프라인에서는 아티스트 유형별로 다른 워크플로우를 사용하는 것이 일반적입니다. 간단한 예로, 에셋 작업 중인 아티스트의 경우 텍스처 페인팅 소프트웨어(예: Mari)를 사용하게 하고 샷 작업 중인 아티스트의 경우에는 컴포지팅 소프트웨어(예: Nuke)를 사용하게 할 수 있습니다. @@ -107,7 +107,7 @@ engines: ### 위치 설명자 -모든 툴킷 번들에는 번들의 *설명자*라고 불리는 `location` 설정이 있습니다. 설명자를 통해 툴킷은 지정된 번들의 위치를 파악하고 해당 유형에 따라 직접 액세스할지 아니면 로컬로 캐시할지 여부를 파악합니다. 툴킷 번들을 가져올 수 있는 위치는 Shotgun 앱 스토어, git 리포지토리, 디스크의 경로 또는 Shotgun 사이트에 업로드된 ZIP 파일 등입니다. 이러한 각 위치에 해당하는 설명자 유형이 있으며 여기에는 해당 유형과 관련된 설정이 포함됩니다. 위 예제의 `tk-maya` 엔진에 대한 설명자는 다음과 같습니다. +모든 툴킷 번들에는 번들의 *설명자*라고 불리는 `location` 설정이 있습니다. 설명자를 통해 툴킷은 지정된 번들의 위치를 파악하고 해당 유형에 따라 직접 액세스할지 아니면 로컬로 캐시할지 여부를 파악합니다. 툴킷 번들을 가져올 수 있는 위치는 {% include product %} 앱 스토어, git 리포지토리, 디스크의 경로 또는 {% include product %} 사이트에 업로드된 ZIP 파일 등입니다. 이러한 각 위치에 해당하는 설명자 유형이 있으며 여기에는 해당 유형과 관련된 설정이 포함됩니다. 위 예제의 `tk-maya` 엔진에 대한 설명자는 다음과 같습니다. ```yaml location: @@ -116,7 +116,7 @@ engines: version: v0.9.4 ``` -이 예는 `app_store` 유형의 설명자로, 툴킷이 Shotgun 앱 스토어에서 지정된 번들을 가져오도록 합니다. `app_store` 유형의 설명자에는 `name` 및 `version` 설정이 있습니다. +이 예는 `app_store` 유형의 설명자로, 툴킷이 {% include product %} 앱 스토어에서 지정된 번들을 가져오도록 합니다. `app_store` 유형의 설명자에는 `name` 및 `version` 설정이 있습니다. 한편, 커스텀 번들을 개발 중이고 스튜디오의 특정 워크플로우에 대한 툴킷 앱을 작성 중인 경우 디스크의 경로에서 직접 가져오고 싶을 수 있습니다. 이 경우 다음과 같이 `dev` 유형의 설명자를 사용합니다. diff --git a/docs/ko/shotgun.md b/docs/ko/shotgun.md index bd932810b..85a8894e0 100644 --- a/docs/ko/shotgun.md +++ b/docs/ko/shotgun.md @@ -5,13 +5,13 @@ pagename: shotgun-index lang: ko --- -# Shotgun 개발 +# {% include product %} 개발 프로덕션을 관리하려면 시시각각으로 변동되는 모든 요소를 동기화된 상태로 유지하기 위해 많은 노력이 필요합니다. -Shotgun REST API 또는 Python API를 이용해 데이터에 직접 연결하고 이벤트 트리거 프레임워크를 이용해 반복적인 작업을 자동화하고 액션 메뉴 항목을 이용해 Shotgun의 웹 인터페이스에서 직접 앱을 실행하십시오. +{% include product %} REST API 또는 Python API를 이용해 데이터에 직접 연결하고 이벤트 트리거 프레임워크를 이용해 반복적인 작업을 자동화하고 액션 메뉴 항목을 이용해 {% include product %}의 웹 인터페이스에서 직접 앱을 실행하십시오. -귀하 또는 귀하가 권한을 제공한 사용자가 사용하는 서비스에서 작동하거나 해당 서비스와 함께 작동하는 자체 서비스, 응용프로그램, 모듈 및 구성요소를 개발할 때 Shotgun API를 사용할 수 있습니다. +귀하 또는 귀하가 권한을 제공한 사용자가 사용하는 서비스에서 작동하거나 해당 서비스와 함께 작동하는 자체 서비스, 응용프로그램, 모듈 및 구성요소를 개발할 때 {% include product %} API를 사용할 수 있습니다. {% include warning title="인증 키" content="사용자가 로그온하지 않고 서비스 또는 해당 기능에 액세스할 수 있는 인증 키 또는 기타 수단을 포함하는 API 정보를 공개하지 마십시오. 또한 귀하가 권한을 제공한 사용자가 공개하는 것도 허용하지 마십시오. 또는 귀하가 직접 API를 사용하여 액세스하거나 사용자들이 로그온하지 않고 서비스 또는 해당 기능에 액세스할 수 있도록 허용하십시오." %} diff --git a/docs/ko/toolkit.md b/docs/ko/toolkit.md index e173864aa..973119a73 100644 --- a/docs/ko/toolkit.md +++ b/docs/ko/toolkit.md @@ -7,7 +7,7 @@ lang: ko # 툴킷 플랫폼 -툴킷은 아티스트 응용프로그램과 파이프라인 도구를 Shotgun과 통합할 수 있게 해 주는 확장 가능한 플랫폼입니다. +툴킷은 아티스트 응용프로그램과 파이프라인 도구를 {% include product %}과 통합할 수 있게 해 주는 확장 가능한 플랫폼입니다. Toolkit Core API는 모든 통합이 구축되는 플랫폼입니다. Core API는 앱, 엔진 및 플랫폼 기반뿐 아니라 파일 시스템 구성과 도구 배포까지 처리합니다. diff --git a/docs/zh_CN/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md b/docs/zh_CN/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md index e1453422c..4abf18898 100644 --- a/docs/zh_CN/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md +++ b/docs/zh_CN/guides/pipeline-integrations/administration/offline-and-disabled-auto-updates.md @@ -10,19 +10,19 @@ lang: zh_CN ## Auto updates ### What parts auto update? -By default Shotgun Desktop will automatically check for updates, and install them to the local machine if it finds any. +By default {% include product %} Desktop will automatically check for updates, and install them to the local machine if it finds any. It checks for updates on two components: -- `tk-framework-desktopstartup` - A frame work which aids the launch of Shotgun Desktop. +- `tk-framework-desktopstartup` - A frame work which aids the launch of {% include product %} Desktop. - `tk-config-basic` - The default site config. -The configuration acts as a manifest for the versions of the apps, engines, frameworks, and core version that should be used by Shotgun Desktop. +The configuration acts as a manifest for the versions of the apps, engines, frameworks, and core version that should be used by {% include product %} Desktop. By updating the config, you are potentially updating any of these components as well. -Any updates that are found are downloaded and stored in the user's local cache, rather than modifying the original Shotgun Desktop installed files. +Any updates that are found are downloaded and stored in the user's local cache, rather than modifying the original {% include product %} Desktop installed files. -Shotgun Create as an application has it's own update mechanism separate from Shotgun Desktop which is not covered here. -However the integration features provided in Shotgun Create work in a similar way, and will also auto update `tk-config-basic` into the same user cache. +{% include product %} Create as an application has it's own update mechanism separate from {% include product %} Desktop which is not covered here. +However the integration features provided in {% include product %} Create work in a similar way, and will also auto update `tk-config-basic` into the same user cache. ### What doesn't auto update? @@ -44,12 +44,12 @@ The following sections describes how to address each of these scenarios. ### Initial Setup If your studio has restricted internet access or no internet access then you will need to ensure that you have all the required parts cached locally. -You will still need one machine that can connect to the internet in order to download Shotgun Create or Shotgun Desktop. +You will still need one machine that can connect to the internet in order to download {% include product %} Create or {% include product %} Desktop. -Shotgun Create and Shotgun Desktop come prepackaged with all the dependencies required to run the basic integrations. -When you start either of them up, it will automatically try to look for updates, but if it cannot connect to the Shotgun App Store, it will simply run the most recent version that exists locally. +{% include product %} Create and {% include product %} Desktop come prepackaged with all the dependencies required to run the basic integrations. +When you start either of them up, it will automatically try to look for updates, but if it cannot connect to the {% include product %} App Store, it will simply run the most recent version that exists locally. -It is recommended that you follow the "Managing updates" steps bellow after installing Shotgun Desktop, as the components bundled with the installer may not be the latest. +It is recommended that you follow the "Managing updates" steps bellow after installing {% include product %} Desktop, as the components bundled with the installer may not be the latest. {% include info title="Note" content="Depending on your network setup, it can sometimes get stuck looking for updates online even though it won't be able to access them. In this situation you can set the environment variable `SHOTGUN_DISABLE_APPSTORE_ACCESS` to `\"1\"` to stop it from trying." %} @@ -63,7 +63,7 @@ To update the `tk-framework-desktopstartup` component, you will need to [downloa For the `tk-config-basic` component it's a bit more tricky, due to all its dependencies. -1. Run Shotgun Desktop on a workstation connected to the internet. When it starts up, the latest upgrades will be automatically downloaded. +1. Run {% include product %} Desktop on a workstation connected to the internet. When it starts up, the latest upgrades will be automatically downloaded. (Ensure `SHOTGUN_DISABLE_APPSTORE_ACCESS` is not set on this machine.) 2. Copy the bundle cache to a shared location where all machines can access it. 3. Set the `SHOTGUN_BUNDLE_CACHE_FALLBACK_PATHS` environment variable on offline machines to point to this location. @@ -79,14 +79,14 @@ In this situation you can set the environment variable `SHOTGUN_DISABLE_APPSTORE ### Disabling updates for a single project 1. Determine the version you want to lock your project to. You can find the integration releases [here](https://support.shotgunsoftware.com/hc/en-us/sections/115000020494-Integrations). -2. In Shotgun, create a Pipeline Configuration entity for the project you want to lock down, with the following fields populated (In this example, we are locking down the config to use v1.0.36 of the integrations): +2. In {% include product %}, create a Pipeline Configuration entity for the project you want to lock down, with the following fields populated (In this example, we are locking down the config to use v1.0.36 of the integrations): - Name: `Primary` - Project: The project you want to lock down - Plugin ids: `basic.*` - Descriptor: `sgtk:descriptor:app_store?name=tk-config-basic&version=v1.0.36` ![Pipeline Configuration entity with a setup for a project with disabled updates.](images/offline-and-disabled-auto-updates/freeze_single_project.png) -3. Anyone starting Shotgun Desktop on the project will now always use `v1.0.36`. Any new users starting to work on the project will also get `v1.0.36`. +3. Anyone starting {% include product %} Desktop on the project will now always use `v1.0.36`. Any new users starting to work on the project will also get `v1.0.36`. #### Good to know @@ -141,7 +141,7 @@ Note that you’ve omitted the version number from the Descriptor field for the Scenario: We’re locked down to v1.0.0, and we’d like to upgrade to v2.0.0, but first I want to test out the new version before deploying it to the studio.* Solution -Duplicate the Pipeline Configuration entity in Shotgun by right-clicking on it and selecting "Duplicate Selected". +Duplicate the Pipeline Configuration entity in {% include product %} by right-clicking on it and selecting "Duplicate Selected". Name the cloned config “update test”, and assign yourself to the User Restrictions field. You will now begin to use this Pipeline Configuration. Change the descriptor to point to the version you wish to test. diff --git a/docs/zh_CN/guides/pipeline-integrations/getting-started/advanced_config.md b/docs/zh_CN/guides/pipeline-integrations/getting-started/advanced_config.md index 46e744b8d..ebe6dbeb4 100644 --- a/docs/zh_CN/guides/pipeline-integrations/getting-started/advanced_config.md +++ b/docs/zh_CN/guides/pipeline-integrations/getting-started/advanced_config.md @@ -11,35 +11,35 @@ lang: zh_CN ## 关于本手册 -本手册介绍如何使用 Shotgun Desktop 中的**高级项目设置向导**为数字内容制作工作流创建配置。您将很快熟悉配置工具，了解如何使用向导，并有机会了解更多信息。使用向导为项目创建工作流配置，并准备对其进行编辑和扩展，以便支持工作流中的每个工序。配置控制 UI 的各个方面、Shotgun 应用以及支持制作工作流所需的各种工具。使用向导只是扩展配置的方法之一。除了为工作流中的每个工序添加特定设置外，它还将添加与软件应用程序的集成。在本手册中，我们将根据 Toolkit 默认配置来配置项目。 +本手册介绍如何使用 {% include product %} Desktop 中的**高级项目设置向导**为数字内容制作工作流创建配置。您将很快熟悉配置工具，了解如何使用向导，并有机会了解更多信息。使用向导为项目创建工作流配置，并准备对其进行编辑和扩展，以便支持工作流中的每个工序。配置控制 UI 的各个方面、{% include product %} 应用以及支持制作工作流所需的各种工具。使用向导只是扩展配置的方法之一。除了为工作流中的每个工序添加特定设置外，它还将添加与软件应用程序的集成。在本手册中，我们将根据 Toolkit 默认配置来配置项目。 本手册假定用户： 1. 从未使用过高级项目设置向导 -2. 对如何使用 Shotgun 有基本的了解 -3. 是 Shotgun Toolkit 新手 +2. 对如何使用 {% include product %} 有基本的了解 +3. 是 {% include product %} Toolkit 新手 ### 使用本文档 要使用本手册并为项目创建可自定义的配置，需要以下内容： -1. 有效的 Shotgun 站点。您可以[在此处注册 Shotgun](https://www.shotgunsoftware.com/zh-cn/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management) 并获取 30 天试用版以开始探索。 -2. Shotgun Desktop。如果未安装 Desktop，则可以[单击此链接开始。](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000068574#Installation%20of%20Desktop) +1. 有效的 {% include product %} 站点。您可以[在此处注册 Shotgun](https://www.shotgunsoftware.com/zh-cn/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management) 并获取 30 天试用版以开始探索。 +2. {% include product %} Desktop。如果未安装 Desktop，则可以[单击此链接开始。](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000068574#Installation%20of%20Desktop) 3. 可用于存储项目文件和工作流配置的文件系统的访问权限。在该文件系统上，创建一个名为 `Shotgun` 的文件夹，其中包含两个文件夹 `projects` 和 `configs`。 ## 关于高级项目设置向导 -Shotgun Desktop 中的“高级项目设置向导”会根据默认配置生成工作流配置。默认配置可以为构建提供坚实基础，其中带有支持工作流的可自定义设置、应用和 UI 元素。它会创建一个配置，您可以对其进行编辑和扩展来满足项目的工作流需求。 +{% include product %} Desktop 中的“高级项目设置向导”会根据默认配置生成工作流配置。默认配置可以为构建提供坚实基础，其中带有支持工作流的可自定义设置、应用和 UI 元素。它会创建一个配置，您可以对其进行编辑和扩展来满足项目的工作流需求。 默认配置包含： * 基本文件系统数据结构和模板，用于确定文件在磁盘上的位置 -* 所有支持的[软件集成](https://support.shotgunsoftware.com/hc/zh-cn/articles/219039798)，允许直接在用户的软件应用程序内与 Shotgun 和工作流功能进行交互。 +* 所有支持的[软件集成](https://support.shotgunsoftware.com/hc/zh-cn/articles/219039798)，允许直接在用户的软件应用程序内与 {% include product %} 和工作流功能进行交互。 -只要您敢于突破想象，勤于思考，充分运用自己的编程知识，或者善于借用 Shotgun 社区集思广益，就会发现 Toolkit 自定义的无限可能。 +只要您敢于突破想象，勤于思考，充分运用自己的编程知识，或者善于借用 {% include product %} 社区集思广益，就会发现 Toolkit 自定义的无限可能。 ### 创建配置 -每个项目都需要一个配置。第一次通过 Shotgun Desktop 访问项目时，将下载并配置基本配置。此基本配置会自动检测用户在其系统上安装的受支持的内容创建软件，并将配置与项目相关联。工作流配置中的设置监管受支持软件应用程序中的集成。[Panel](https://support.shotgunsoftware.com/hc/zh-cn/articles/219033098) 应用显示 Shotgun 的项目信息，并使艺术家可以回复注释和查看版本，而无需退出其工作会话。[Publisher](https://support.shotgunsoftware.com/hc/zh-cn/articles/219032998) 应用允许艺术家将其作品提供给团队中的其他人，通过 [Loader](https://support.shotgunsoftware.com/hc/zh-cn/articles/219033078) 应用，艺术家可以加载其队友发布的文件。基本配置不包括文件系统管理设置，也不支持文件或者目录命名的模板开发。它也不会像配置默认配置那样，需要添加大量的应用工具。它是一个简单的配置，允许在不对配置文件进行任何手动编辑的情况下运行 Toolkit。向导将基本配置替换为默认配置。它提供了更多的应用和软件集成，以支持您开始工作。虽然也可以编辑基本配置，但只有在您拥有高级设置后，才能设置项目以进行自定义。 +每个项目都需要一个配置。第一次通过 {% include product %} Desktop 访问项目时，将下载并配置基本配置。此基本配置会自动检测用户在其系统上安装的受支持的内容创建软件，并将配置与项目相关联。工作流配置中的设置监管受支持软件应用程序中的集成。[Panel](https://support.shotgunsoftware.com/hc/zh-cn/articles/219033098) 应用显示 {% include product %} 的项目信息，并使艺术家可以回复注释和查看版本，而无需退出其工作会话。[Publisher](https://support.shotgunsoftware.com/hc/zh-cn/articles/219032998) 应用允许艺术家将其作品提供给团队中的其他人，通过 [Loader](https://support.shotgunsoftware.com/hc/zh-cn/articles/219033078) 应用，艺术家可以加载其队友发布的文件。基本配置不包括文件系统管理设置，也不支持文件或者目录命名的模板开发。它也不会像配置默认配置那样，需要添加大量的应用工具。它是一个简单的配置，允许在不对配置文件进行任何手动编辑的情况下运行 Toolkit。向导将基本配置替换为默认配置。它提供了更多的应用和软件集成，以支持您开始工作。虽然也可以编辑基本配置，但只有在您拥有高级设置后，才能设置项目以进行自定义。 ### 基本配置和默认配置之间的差异 @@ -51,19 +51,19 @@ Shotgun Desktop 中的“高级项目设置向导”会根据默认配置生成 | 更新 | 自动更新 | 手动更新 | | 文件系统支持 | 不支持文件系统数据结构 | 包含用于支持文件夹结构和文件命名标准的工具 | | 软件集成 | 3ds Max、Houdini、Maya、Nuke、Photoshop、Flame | 基本 + Hiero、Motionbulder、Mari | -| Toolkit 应用 | Shotgun 面板、发布器、加载器 | 基本 + 工作文件、快照、场景细分、Nuke 写入节点、Houdini Mantra 节点等 | +| Toolkit 应用 | {% include product %} 面板、发布器、加载器 | 基本 + 工作文件、快照、场景细分、Nuke 写入节点、Houdini Mantra 节点等 | -在本手册中，您将使用 Shotgun Desktop 中的向导，根据默认配置为项目生成工作流配置。生成此配置将使您能够进行支持专用制作工作流所需的自定义。 +在本手册中，您将使用 {% include product %} Desktop 中的向导，根据默认配置为项目生成工作流配置。生成此配置将使您能够进行支持专用制作工作流所需的自定义。 ## 开始练习 ### 准备使用默认配置 -**步骤 1：**在 Shotgun 中创建一个名为“the_other_side”的新项目。 +**步骤 1：**在 {% include product %} 中创建一个名为“the_other_side”的新项目。 ![新建项目](./images/advanced_config/2_new_project.png) -**步骤 2：**启动 Shotgun Desktop 应用，并使用 Shotgun 站点的用户名和密码登录。 +**步骤 2：**启动 {% include product %} Desktop 应用，并使用 {% include product %} 站点的用户名和密码登录。 ![登录](./images/advanced_config/3_login.png) @@ -77,21 +77,21 @@ Shotgun Desktop 中的“高级项目设置向导”会根据默认配置生成 ### 访问默认配置 -Desktop 在加载项目页面时，自动下载和配置基本配置，并自动检测和添加 Publish 应用，以及系统中已安装的受支持的软件包。基本配置完成后，Publish 应用和已安装软件会被自动添加到 Shotgun Desktop 的**“应用”(Apps)**窗格中。 +Desktop 在加载项目页面时，自动下载和配置基本配置，并自动检测和添加 Publish 应用，以及系统中已安装的受支持的软件包。基本配置完成后，Publish 应用和已安装软件会被自动添加到 {% include product %} Desktop 的**“应用”(Apps)**窗格中。 **步骤 4：**加载项目后，在屏幕右下角选择您的个人资料**头像**。在弹出菜单中，选择**“Advanced project setup...”**以启动向导。 ![高级项目设置](./images/advanced_config/6_advanced_project_setup.png) -此时将显示一个对话框，其中包含四个选项，“Shotgun Default”处于选中状态。此时，除了默认选择的“Shotgun Default”，您还可以选择根据现有其他项目的配置、Git 库配置或从磁盘路径选择配置文件来配置该项目的工作流。 +此时将显示一个对话框，其中包含四个选项，“{% include product %} Default”处于选中状态。此时，除了默认选择的“{% include product %} Default”，您还可以选择根据现有其他项目的配置、Git 库配置或从磁盘路径选择配置文件来配置该项目的工作流。 -对于本练习，我们将选择**“Shotgun Default”**。此选项将根据 Shotgun 默认配置为您的项目创建工作流配置。 +对于本练习，我们将选择**“{% include product %} Default”**。此选项将根据 {% include product %} 默认配置为您的项目创建工作流配置。 ![选择配置](./images/advanced_config/7_select_config.png) **步骤 5：**选择**“继续”(Continue)**。 -此时将显示一个对话框，其中包含两个选项，**“默认”(Default)**处于选中状态。此时，有一个用于选择旧版默认配置设置的选项。此配置设置来自旧版 Shotgun，适用于仍使用相应版本的工作室。我们将在本练习中使用“默认”(Default)。 +此时将显示一个对话框，其中包含两个选项，**“默认”(Default)**处于选中状态。此时，有一个用于选择旧版默认配置设置的选项。此配置设置来自旧版 {% include product %}，适用于仍使用相应版本的工作室。我们将在本练习中使用“默认”(Default)。 ![选择配置](./images/advanced_config/8_select_config.png) @@ -107,13 +107,13 @@ Desktop 在加载项目页面时，自动下载和配置基本配置，并自动 ![定义存储](./images/advanced_config/10_define_storage2.png) -Shotgun Toolkit 支持三种操作系统：Linux、Mac 和 Windows。 +{% include product %} Toolkit 支持三种操作系统：Linux、Mac 和 Windows。 **步骤 8：**选择用于存储项目数据的操作系统旁边的字段。选择文件夹图标，并导航到在本练习之前在文件系统上创建的项目文件夹。 ![存储根文件夹](./images/advanced_config/11_storage_root_folder.png) -此设置使 Shotgun 只能访问您标识用于存储制作数据的文件夹。在准备本练习时，您在 Shotgun 根目录中添加了一个 `projects/` 目录。`projects/` 目录是 Toolkit 用于存储任何本地项目相关信息的位置。 +此设置使 {% include product %} 只能访问您标识用于存储制作数据的文件夹。在准备本练习时，您在 {% include product %} 根目录中添加了一个 `projects/` 目录。`projects/` 目录是 Toolkit 用于存储任何本地项目相关信息的位置。 ![定义存储](./images/advanced_config/12_define_Storage3.png) @@ -131,7 +131,7 @@ Shotgun Toolkit 支持三种操作系统：Linux、Mac 和 Windows。 ![项目文件夹](./images/advanced_config/14_project_folder_name.png) -Toolkit 既适用于分布式设置，又适用于集中式设置。在分布式设置中，工作流配置上传到 Shotgun 并在本地为每个用户缓存；在集中式设置中，用户可以在磁盘上的共享位置访问单个配置。对于本练习，我们将使用集中式设置。您可以[在此处了解有关分布式设置的详细信息](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)。 +Toolkit 既适用于分布式设置，又适用于集中式设置。在分布式设置中，工作流配置上传到 {% include product %} 并在本地为每个用户缓存；在集中式设置中，用户可以在磁盘上的共享位置访问单个配置。对于本练习，我们将使用集中式设置。您可以[在此处了解有关分布式设置的详细信息](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)。 最后一步生成创建特定于项目的配置所需的相应文件夹、文件和数据。 @@ -145,7 +145,7 @@ Toolkit 既适用于分布式设置，又适用于集中式设置。在分布式 ![设置完成](./images/advanced_config/17_project_setup_complete.png) -**提示：**将应用固定到菜单栏以便快速访问 Shotgun Desktop：选择您的**头像**并选择**“Pin to Menu”**。 +**提示：**将应用固定到菜单栏以便快速访问 {% include product %} Desktop：选择您的**头像**并选择**“Pin to Menu”**。 完成上述任务；项目设置已完成。现在，根据默认配置，在指定的位置为您的项目提供了 Toolkit 工作流配置，您可以开始进行自定义。 @@ -157,7 +157,7 @@ Toolkit 既适用于分布式设置，又适用于集中式设置。在分布式 ## 高级主题 -Shotgun Toolkit 提供了许多便利的方法来编辑、克隆或接管配置。扩展现有配置可以节省时间，并使您可以访问网络中其他人创建的所有炫酷素材。您可以利用内容丰富的 Shotgun [社区](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups&hl=zh-CN#!forum/shotgun-dev)，其中可能包含您需要的精确配置。Shotgun 社区是一个共享社区，应该与人为善，心怀感恩，赞赏创建了配置并帮助您完成工作的用户。对了，别忘了提供反馈，这就是我们帮助其他 Shotgun 用户并成为此社区一员的亮点！ +{% include product %} Toolkit 提供了许多便利的方法来编辑、克隆或接管配置。扩展现有配置可以节省时间，并使您可以访问网络中其他人创建的所有炫酷素材。您可以利用内容丰富的 {% include product %} [社区](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups&hl=zh-CN#!forum/shotgun-dev)，其中可能包含您需要的精确配置。{% include product %} 社区是一个共享社区，应该与人为善，心怀感恩，赞赏创建了配置并帮助您完成工作的用户。对了，别忘了提供反馈，这就是我们帮助其他 {% include product %} 用户并成为此社区一员的亮点！ 下面是一些与配置相关的操作。 @@ -167,7 +167,7 @@ Shotgun Toolkit 提供了许多便利的方法来编辑、克隆或接管配置 ### 编辑制作活动中的配置 -有时，您想要修改当前处于制作活动中的配置，但是不想在艺术家使用该配置时编辑它。只需几个命令，Shotgun 就能提供一种复制现有配置的方法，从而可以安全地测试您的修改，然后再将这些修改推送到制作活动中。此过程将制作配置替换为新配置，并自动备份旧配置。 +有时，您想要修改当前处于制作活动中的配置，但是不想在艺术家使用该配置时编辑它。只需几个命令，{% include product %} 就能提供一种复制现有配置的方法，从而可以安全地测试您的修改，然后再将这些修改推送到制作活动中。此过程将制作配置替换为新配置，并自动备份旧配置。 您希望处理配置副本的原因是： @@ -180,7 +180,7 @@ Shotgun Toolkit 提供了许多便利的方法来编辑、克隆或接管配置 ### 工作流配置的在线分布 -本手册将逐步创建一个**集中式配置**：位于共享网络位置的单个工作流配置副本，供所有用户访问。但是，如果您的员工分布在不同地点和网络，则共享工作流配置的单个副本可能不太可行。Toolkit 允许这种情况，方法是提供**分布式配置**选项，即工作流配置上传到 Shotgun，并且每次用户访问项目时，配置都会在本地下载并缓存。您可以在我们的[核心 API 开发人员文档](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)中了解有关分布式配置的详细信息。 +本手册将逐步创建一个**集中式配置**：位于共享网络位置的单个工作流配置副本，供所有用户访问。但是，如果您的员工分布在不同地点和网络，则共享工作流配置的单个副本可能不太可行。Toolkit 允许这种情况，方法是提供**分布式配置**选项，即工作流配置上传到 {% include product %}，并且每次用户访问项目时，配置都会在本地下载并缓存。您可以在我们的[核心 API 开发人员文档](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)中了解有关分布式配置的详细信息。 ### 使用多个根文件夹 diff --git a/docs/zh_CN/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md b/docs/zh_CN/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md index ce1c7c501..4e8d90a9f 100644 --- a/docs/zh_CN/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md +++ b/docs/zh_CN/guides/pipeline-integrations/getting-started/dynamic_filesystem_configuration.md @@ -11,9 +11,9 @@ lang: zh_CN ## 关于本手册 -管理工作流的难点之一是跟踪将要创建的众多文件。Toolkit 工作流可通过以下方法实现文件系统管理自动化：基于 Shotgun 中的数据和配置的文件夹结构创建文件夹，然后将文件自动写入到正确的位置并使用标准化的命名，艺术家可以专注于内容创建。工作流配置带有一组默认文件夹和文件命名约定，但制作人员通常会对其进行自定义。本手册将提供进行这些自定义设置所需的知识。 +管理工作流的难点之一是跟踪将要创建的众多文件。Toolkit 工作流可通过以下方法实现文件系统管理自动化：基于 {% include product %} 中的数据和配置的文件夹结构创建文件夹，然后将文件自动写入到正确的位置并使用标准化的命名，艺术家可以专注于内容创建。工作流配置带有一组默认文件夹和文件命名约定，但制作人员通常会对其进行自定义。本手册将提供进行这些自定义设置所需的知识。 -在默认配置中，资产按照某种文件夹结构进行管理，如 `asset_type/asset/pipeline_step`。在本手册中，我们将使用名为“Set”的自定义实体，按使用每个资产的制作集进行进一步组织。我们将首先在 Shotgun 中设置自定义实体，然后使用它来管理为任意指定集创建的资产，使文件夹结构类似于 `set/asset_type/asset/pipeline_step`。 +在默认配置中，资产按照某种文件夹结构进行管理，如 `asset_type/asset/pipeline_step`。在本手册中，我们将使用名为“Set”的自定义实体，按使用每个资产的制作集进行进一步组织。我们将首先在 {% include product %} 中设置自定义实体，然后使用它来管理为任意指定集创建的资产，使文件夹结构类似于 `set/asset_type/asset/pipeline_step`。 我们可以举例演示按集组织资产背后的理念：假设您有一个项目，其中某些场景发生在车库中，其他场景发生在餐厅中。借助我们的设置，资产文件（如“wrench”、“oilcan”或“workbench”）在“garage”文件夹中组织，而“plate”、“winebottle”或“tablecloth”在“dining_room”文件夹中组织。在我们的示例中，我们将要确保鲜美多汁的“filet”资产已正确放置在餐厅。 @@ -21,7 +21,7 @@ lang: zh_CN ### 本手册分三个部分 -* 在 Shotgun 中创建一个名为“Set”的**自定义实体**，您将使用它来关联艺术家正在创建的餐厅元素。 +* 在 {% include product %} 中创建一个名为“Set”的**自定义实体**，您将使用它来关联艺术家正在创建的餐厅元素。 * 编辑文件夹**数据结构**，使 Toolkit 包含一个基于文件夹结构中的当前集来动态命名的文件夹。 * 编辑用于命名资产工作文件的**模板**，使 Toolkit 在文件名中包含关联集的名称。 @@ -29,9 +29,9 @@ lang: zh_CN 要使用本手册，需要满足以下条件： -1. 有效的 [Shotgun](https://www.shotgunsoftware.com/zh-cn/signup/) 站点。您应该拥有至少已创建一个资产的项目。资产应具有模型任务。 -2. 对如何使用 Shotgun 站点管理资产具有基本了解 -3. 在系统上安装 [Shotgun Desktop](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000068574#Installation%20of%20Desktop)。 +1. 有效的 [{% include product %}](https://www.shotgunsoftware.com/zh-cn/signup/) 站点。您应该拥有至少已创建一个资产的项目。资产应具有模型任务。 +2. 对如何使用 {% include product %} 站点管理资产具有基本了解 +3. 在系统上安装 [{% include product %} Desktop](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000068574#Installation%20of%20Desktop)。 4. 已标识项目的克隆工作流配置，或者完成[配置快速入门](./advanced_config.md)手册并克隆在该练习中创建的配置。 5. 基本熟悉 YAML。 6. 为存储工作流配置的文件系统设置适当的读取和写入权限。 @@ -42,11 +42,11 @@ lang: zh_CN ### 关于文件数据结构和模板 -Toolkit 工作流配置中的数据结构和模板使您能够充分利用您的 Shotgun 数据来管理磁盘上的制作文件。默认配置中的数据结构包括**镜头**、**镜头序列**、**资产**、**资产类型**等实体。可以添加其他实体，例如**关卡**、**剧集**、**季**，在我们的示例中，添加的是**集**这样的自定义实体。 +Toolkit 工作流配置中的数据结构和模板使您能够充分利用您的 {% include product %} 数据来管理磁盘上的制作文件。默认配置中的数据结构包括**镜头**、**镜头序列**、**资产**、**资产类型**等实体。可以添加其他实体，例如**关卡**、**剧集**、**季**，在我们的示例中，添加的是**集**这样的自定义实体。 Toolkit 平台允许您使用**数据结构**来动态构建您的文件夹结构，数据结构是在构建实际制作文件系统时用作模板的制作文件夹结构的微型版本。数据结构是动态创建文件夹的明确指导，它使用 YAML 文件为动态创建的文件夹定义规则。默认配置包含预配置的数据结构，它支持资产和镜头工作流的文件夹创建。您将修改数据结构的一部分，它支持创建资产文件夹结构 `/assets///`，以增加对您正在创建的新 **Set** 实体的支持。 -**模板**允许您使用数据结构中的 Shotgun 数据和信息，在创建文件时对其进行动态命名和保存。默认配置提供一组入门模板，您可以对其进行编辑以符合您的工作流需求。 +**模板**允许您使用数据结构中的 {% include product %} 数据和信息，在创建文件时对其进行动态命名和保存。默认配置提供一组入门模板，您可以对其进行编辑以符合您的工作流需求。 {% include info title="注意" content="Shotgun 集成的基本设置不包括文件系统管理。为了为您的项目配置文件系统管理，您的项目需要高级设置。第一个手册[配置快速入门](./advanced_config.md)介绍了高级设置过程" %} @@ -56,11 +56,11 @@ Toolkit 平台允许您使用**数据结构**来动态构建您的文件夹结 ### 启用自定义实体 -**步骤 1：**在浏览器中打开 Shotgun 站点。单击您的头像并转至“管理 > 站点偏好设置”(ADMIN > Site Preferences)。在出现的页面上，展开**“实体”(Entities)**部分。 +**步骤 1：**在浏览器中打开 {% include product %} 站点。单击您的头像并转至“管理 > 站点偏好设置”(ADMIN > Site Preferences)。在出现的页面上，展开**“实体”(Entities)**部分。 ![Python 应用](./images/dynamic_filesystem_configuration/1_site_preferences.png) -显示的是 Shotgun 中可用的实体类型列表。下图中列表的顶部是为当前 Shotgun 站点配置的某些实体类型。这些实体类型下方是尚未配置或启用的几个**自定义实体**。 +显示的是 {% include product %} 中可用的实体类型列表。下图中列表的顶部是为当前 {% include product %} 站点配置的某些实体类型。这些实体类型下方是尚未配置或启用的几个**自定义实体**。 ### 选择其中一个自定义实体类型，对其进行配置，然后将其启用。 @@ -70,7 +70,7 @@ Toolkit 平台允许您使用**数据结构**来动态构建您的文件夹结 ![Python 应用](./images/dynamic_filesystem_configuration/4_enable_entity.png) -这样做可以使此自定义实体在 Shotgun 中处于活动状态，并将显示名称设置为 *Set*。实际上，您正在创建自定义实体的别名，因为实体的系统名称仍为 `CustomEntity01`。在此示例中，我们将使用 `CustomEntity01`；您可能会使用不同的自定义实体。 +这样做可以使此自定义实体在 {% include product %} 中处于活动状态，并将显示名称设置为 *Set*。实际上，您正在创建自定义实体的别名，因为实体的系统名称仍为 `CustomEntity01`。在此示例中，我们将使用 `CustomEntity01`；您可能会使用不同的自定义实体。 {% include info title="注意" content="记住所选自定义实体的系统名称。" %} @@ -98,7 +98,7 @@ Toolkit 平台允许您使用**数据结构**来动态构建您的文件夹结 在本手册中，将其应用到**“仅当前项目”(Only the current project)**并选择**“创建字段”(Create Field)**。 -Shotgun 将配置新字段。 +{% include product %} 将配置新字段。 ![Python 应用](./images/dynamic_filesystem_configuration/8_only_current_project.png) @@ -124,7 +124,7 @@ Shotgun 将配置新字段。 ### 设置数据结构 -现在，您已启用“集”自定义实体，已创建一个名为“Dining Room”的集实体，并且已将“资产”实体链接到“Dining Room”集。您已获得 Shotgun 站点中的所有要素，现在可以修改您的文件夹结构。美工人员开始处理某个任务时，Toolkit 会使用关联的 Shotgun 数据来确定要在文件系统中创建的文件夹。将根据工作流配置的数据结构自动创建并命名新文件夹。 +现在，您已启用“集”自定义实体，已创建一个名为“Dining Room”的集实体，并且已将“资产”实体链接到“Dining Room”集。您已获得 {% include product %} 站点中的所有要素，现在可以修改您的文件夹结构。美工人员开始处理某个任务时，Toolkit 会使用关联的 {% include product %} 数据来确定要在文件系统中创建的文件夹。将根据工作流配置的数据结构自动创建并命名新文件夹。 现在，您需要定义随着艺术家逐步完成制作工作流，您希望 Toolkit 动态生成的文件夹结构。可以通过编辑数据结构来完成此操作。 @@ -150,7 +150,7 @@ Shotgun 将配置新字段。 `/assets////` -“集”实体表示为 `CustomEntity01`。我们已在 Shotgun 中为 CustomEntity01 指定*显示名称* Set，但在我们的配置中，我们将始终按其系统名称 `CustomEntity01` 对其进行引用。 +“集”实体表示为 `CustomEntity01`。我们已在 {% include product %} 中为 CustomEntity01 指定*显示名称* Set，但在我们的配置中，我们将始终按其系统名称 `CustomEntity01` 对其进行引用。 ### 数据结构如何使用 YAML 文件 @@ -158,7 +158,7 @@ Shotgun 将配置新字段。 ### 为“集”实体创建新的文件夹和 YAML 文件 -数据结构的 `project` 文件夹中包含与 Shotgun 跟踪的不同实体相关的文件夹。您正在添加新的资产实体 CustomEntity01，使 Shotgun 能够跟踪集中的项。这些项是资产，因此您将编辑资产下的文件夹和 YAML 文件。 +数据结构的 `project` 文件夹中包含与 {% include product %} 跟踪的不同实体相关的文件夹。您正在添加新的资产实体 CustomEntity01，使 {% include product %} 能够跟踪集中的项。这些项是资产，因此您将编辑资产下的文件夹和 YAML 文件。 同样，我们的目标是从 `asset_type/asset/step` 文件夹结构转入 `set/asset_type/asset/step`。因此，我们要添加一个文件夹来表示数据结构中的集，还有一个对应的 YAML 文件。由于我们需要对自定义实体使用系统名称，因此我们将创建 `CustomEntity01/` 文件夹和 `CustomEntity01.yml`。 @@ -180,7 +180,7 @@ filters: - { "path": "project", "relation": "is", "values": [ "$project" ] } ``` -YAML 文件将向 Toolkit 提供有关如何为 `CustomEntity01` 文件夹命名的说明。在这种情况下，我们将创建一个 `shotgun_entity` 类型的文件夹，这意味着它对应于 Shotgun 查询。`entity_type` 字段告诉我们查询 Shotgun 中的 `CustomEntity01` 实体，`name` 字段告诉我们查询实体上的哪个*字段* – 在本例中，我们将从 `CustomEntity01` 获取 `code` 字段。 +YAML 文件将向 Toolkit 提供有关如何为 `CustomEntity01` 文件夹命名的说明。在这种情况下，我们将创建一个 `{% include product %}_entity` 类型的文件夹，这意味着它对应于 {% include product %} 查询。`entity_type` 字段告诉我们查询 {% include product %} 中的 `CustomEntity01` 实体，`name` 字段告诉我们查询实体上的哪个*字段* – 在本例中，我们将从 `CustomEntity01` 获取 `code` 字段。 `filters` 字段限制了应该创建此动态文件夹的情况。 @@ -225,10 +225,10 @@ filters: 将在 Toolkit 工作流中的几个时间点创建文件夹： -* **应用程序启动程序**：每次用户为任务启动 DCC 时，Toolkit 都将为该任务创建目录（如果尚未创建）。由于启动 DCC 往往是用户通过 Toolkit 执行的第一个操作，因此这是创建目录的常规方式。这可以通过 Shotgun 中的右键单击菜单执行，也可从 Shotgun Desktop 或 Create 应用执行。 -* **Shotgun 菜单**：为任务创建文件夹最直接的方法是在 Shotgun 中，在其上单击鼠标右键，然后选择“创建文件夹”(Create Folders)菜单项。 -* **Toolkit API**：您可以通过 Toolkit API 直接触发目录创建逻辑。这可以用于将 Toolkit 插入到自定义启动程序中，也可用于工作流的事件触发器，您希望在其中为镜头自动创建目录，就像在 Shotgun 中创建一样。 -* **tank 命令**：与 Shotgun 中的菜单项类似，`tank folders` 终端命令也可以为任务创建文件夹。 +* **应用程序启动程序**：每次用户为任务启动 DCC 时，Toolkit 都将为该任务创建目录（如果尚未创建）。由于启动 DCC 往往是用户通过 Toolkit 执行的第一个操作，因此这是创建目录的常规方式。这可以通过 {% include product %} 中的右键单击菜单执行，也可从 {% include product %} Desktop 或 Create 应用执行。 +* **{% include product %} 菜单**：为任务创建文件夹最直接的方法是在 {% include product %} 中，在其上单击鼠标右键，然后选择“创建文件夹”(Create Folders)菜单项。 +* **Toolkit API**：您可以通过 Toolkit API 直接触发目录创建逻辑。这可以用于将 Toolkit 插入到自定义启动程序中，也可用于工作流的事件触发器，您希望在其中为镜头自动创建目录，就像在 {% include product %} 中创建一样。 +* **tank 命令**：与 {% include product %} 中的菜单项类似，`tank folders` 终端命令也可以为任务创建文件夹。 我们将使用 `tank` 命令进行测试。 @@ -274,7 +274,7 @@ In total, 23 folders were processed. ### Toolkit 应用如何使用模板 -您首先创建了一种在 Shotgun 中将资产与集关联的方法，即启用 CustomEntity01 来表示集，然后向资产实体添加一个链接字段，以表示资产与集之间的链接。在资产与集之间建立关系后，您可设置文件夹数据结构以使用此关联，将所有资产*文件夹*放置在关联集的文件夹中。现在，您将创建一种方法，以动态命名*文件*并允许 Toolkit 应用自动管理文件。 +您首先创建了一种在 {% include product %} 中将资产与集关联的方法，即启用 CustomEntity01 来表示集，然后向资产实体添加一个链接字段，以表示资产与集之间的链接。在资产与集之间建立关系后，您可设置文件夹数据结构以使用此关联，将所有资产*文件夹*放置在关联集的文件夹中。现在，您将创建一种方法，以动态命名*文件*并允许 Toolkit 应用自动管理文件。 随着艺术家开始处理项目中的任务，将生成必要的文件夹结构。然后，当他们启动 Workfiles 应用的**“File Save”**动作时，文件将自动命名。使用通过 Toolkit 的 Workfiles 应用访问的模板对该文件命名。渲染应用（如 Nuke Write 节点和 Houdini Mantra 节点）使用模板来命名和保存渲染的文件，与已发布文件的 Publisher 应用一样。 @@ -357,17 +357,17 @@ In total, 23 folders were processed. ### 测试 -**步骤 18：**从 Shotgun Desktop 启动 Maya。 +**步骤 18：**从 {% include product %} Desktop 启动 Maya。 ![Python 应用](images/dynamic_filesystem_configuration/23_test_file_creation.png) -在 Maya 中，转到**“Shotgun > File Open”**，然后在出现的对话框中，选择您已在 Shotgun 中为其指定集的资产的任务。 +在 Maya 中，转到**“{% include product %} > File Open”**，然后在出现的对话框中，选择您已在 {% include product %} 中为其指定集的资产的任务。 ![Python 应用](images/dynamic_filesystem_configuration/24_test_new_file.png) 选择**“+New File”** -您可以创建简单的三维对象，也可以使用**“Shotgun > File Save”**保存文件。 +您可以创建简单的三维对象，也可以使用**“{% include product %} > File Save”**保存文件。 ![Python 应用](images/dynamic_filesystem_configuration/file_save.png) @@ -375,17 +375,17 @@ In total, 23 folders were processed. 请注意，**“File Save”**对话框使用模板中的新设置显示**“Preview: Dining-Room_scene.v001.ma”**。 -**“Work Area:”**显示 **.../Shotgun/projects/the_other_side/assets/Dining-Room/Prop/Filet/model/work/maya** 作为 Workfiles 保存文件的位置的路径。 +**“Work Area:”**显示 **.../{% include product %}/projects/the_other_side/assets/Dining-Room/Prop/Filet/model/work/maya** 作为 Workfiles 保存文件的位置的路径。 ## 高级主题 ### 扩展示例 -在此示例中，我们修改了一个模板，但对于文件系统配置还有更多工作可以做。在真实的示例中，您可能会更改*所有*与资产相关的文件，使其采用相同的文件命名约定。您可以根据其他实体（季、剧集、关卡等）进行修改、创建用户文件夹、根据使用正则表达式操纵的 Shotgun 数据对文件夹命名，等等。您可以在[文件系统配置参考](https://support.shotgunsoftware.com/hc/zh-cn/articles/219039868)中了解有关所有 Toolkit 文件夹和数据结构选项的信息。 +在此示例中，我们修改了一个模板，但对于文件系统配置还有更多工作可以做。在真实的示例中，您可能会更改*所有*与资产相关的文件，使其采用相同的文件命名约定。您可以根据其他实体（季、剧集、关卡等）进行修改、创建用户文件夹、根据使用正则表达式操纵的 {% include product %} 数据对文件夹命名，等等。您可以在[文件系统配置参考](https://support.shotgunsoftware.com/hc/zh-cn/articles/219039868)中了解有关所有 Toolkit 文件夹和数据结构选项的信息。 ### 路径缓存 -在创建文件夹时，将在磁盘上的文件夹与 Shotgun 实体之间创建映射。这些映射将存储为 Shotgun 中的 FilesystemLocation 实体，并缓存在用户计算机上的 SQLite 数据库中。要详细了解路径缓存的工作方式及其使用方式，请参见[此文档](../../../quick-answers/administering/what-is-path-cache.md)。 +在创建文件夹时，将在磁盘上的文件夹与 {% include product %} 实体之间创建映射。这些映射将存储为 {% include product %} 中的 FilesystemLocation 实体，并缓存在用户计算机上的 SQLite 数据库中。要详细了解路径缓存的工作方式及其使用方式，请参见[此文档](../../../quick-answers/administering/what-is-path-cache.md)。 ### 其他资源 diff --git a/docs/zh_CN/guides/pipeline-integrations/getting-started/editing_app_setting.md b/docs/zh_CN/guides/pipeline-integrations/getting-started/editing_app_setting.md index c318ab152..c5e0eeddf 100644 --- a/docs/zh_CN/guides/pipeline-integrations/getting-started/editing_app_setting.md +++ b/docs/zh_CN/guides/pipeline-integrations/getting-started/editing_app_setting.md @@ -16,38 +16,38 @@ lang: zh_CN 本手册介绍如何编辑现有工作流配置中的设置，以满足项目工作流的需求。第一个手册**[配置快速入门](./advanced_config.md)**介绍了如何准备工作流配置以进行编辑。如果您不熟悉如何为项目创建可编辑的配置，请先完成**配置快速入门**，然后再继续。 -通过扩展默认配置，Shotgun Toolkit 允许自定义工作流中的任务。在一个或多个软件包内的 Toolkit 应用中启用或禁用按钮就是简单的自定义示例，它可以更改用户与 Toolkit 功能进行交互的方式。Toolkit 允许使用专用配置，通过创建自定义工作流、自动执行重复和单调的任务、修改挂钩甚至添加基于 Toolkit 平台的自定义工具，让您可以更智能和更快速地工作。遗憾的是，它只能通过 Shotgun 软件集成进行访问，还不能用于像洗衣服这样的日常任务。 +通过扩展默认配置，{% include product %} Toolkit 允许自定义工作流中的任务。在一个或多个软件包内的 Toolkit 应用中启用或禁用按钮就是简单的自定义示例，它可以更改用户与 Toolkit 功能进行交互的方式。Toolkit 允许使用专用配置，通过创建自定义工作流、自动执行重复和单调的任务、修改挂钩甚至添加基于 Toolkit 平台的自定义工具，让您可以更智能和更快速地工作。遗憾的是，它只能通过 {% include product %} 软件集成进行访问，还不能用于像洗衣服这样的日常任务。 -本手册中的练习将向您讲解如何查找哪些配置设置控制应用软件中 Shotgun 应用的动作，设置所在的位置以及如何对其进行编辑。举个具体的例子，我们可以通过编辑“Workfiles”应用下的设置，禁止艺术家用 Maya 的**“+New Task”**按钮创建新任务。 +本手册中的练习将向您讲解如何查找哪些配置设置控制应用软件中 {% include product %} 应用的动作，设置所在的位置以及如何对其进行编辑。举个具体的例子，我们可以通过编辑“Workfiles”应用下的设置，禁止艺术家用 Maya 的**“+New Task”**按钮创建新任务。 ## 使用本文档 要使用本手册并对工作流配置执行编辑，需要以下内容： -1. 有效的 [Shotgun](https://www.shotgunsoftware.com/zh-cn/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management) 站点。 +1. 有效的 [{% include product %}](https://www.shotgunsoftware.com/zh-cn/signup/?utm_source=autodesk.com&utm_medium=referral&utm_campaign=creative-project-management) 站点。 2. 包含至少一个资产的项目。您可以将资产添加到在第一个手册中创建的 the_other_side 项目。您可以在[配置快速入门](./advanced_config.md)手册中查看如何为项目创建资产。 3. 已标识项目的工作流配置，或者完成[配置快速入门](./advanced_config.md)手册并使用在该练习中创建的配置。 4. 为存储工作流配置的文件系统设置适当的读取和写入权限。 -5. 在系统上安装 Shotgun Desktop。 +5. 在系统上安装 {% include product %} Desktop。 6. Maya 的有效固定期限的使用许可。在[此处](https://www.autodesk.com.cn/products/maya/free-trial)获取 Maya 的 30 天试用版 {% include info title="注意" content="本手册基于 `tk-config-default2` 工作流配置。如果您的配置文件已修改，则文件和文件夹的位置、YAML 设置的区块可能就与此处描述的不同。" %} ## 关于工作文件应用 -工作文件应用监管 Shotgun 软件集成中的文件管理，并控制对浏览、打开和保存工作文件功能的访问。**“+New Task”**按钮是工作文件应用的一个动作，允许用户添加任务，而无需转到 Shotgun 执行此操作。配置分解为每个环境的文件。这样，您可以管理相对于工作流中不同阶段的功能，从而控制用户何时可以创建、命名和保存文件、执行任务或执行某些功能。这与工作文件应用中的所有功能相关，也适用于修改任何应用或插件的设置。请在本文档末尾的[高级主题](#advanced-topics)中查找更多详细信息。 +工作文件应用监管 {% include product %} 软件集成中的文件管理，并控制对浏览、打开和保存工作文件功能的访问。**“+New Task”**按钮是工作文件应用的一个动作，允许用户添加任务，而无需转到 {% include product %} 执行此操作。配置分解为每个环境的文件。这样，您可以管理相对于工作流中不同阶段的功能，从而控制用户何时可以创建、命名和保存文件、执行任务或执行某些功能。这与工作文件应用中的所有功能相关，也适用于修改任何应用或插件的设置。请在本文档末尾的[高级主题](#advanced-topics)中查找更多详细信息。 ## 熟悉配置文件 -使用 Shotgun 中的“工作流配置列表”(Pipeline Configuration List)查找为您正在处理的项目存储工作流配置的位置。如果您知道它的存储位置，则可以跳到步骤 5。 +使用 {% include product %} 中的“工作流配置列表”(Pipeline Configuration List)查找为您正在处理的项目存储工作流配置的位置。如果您知道它的存储位置，则可以跳到步骤 5。 ## 查找工作流配置 -**步骤 1：**打开管理您将用于此练习的项目的 **Shotgun 站点**。 +**步骤 1：**打开管理您将用于此练习的项目的 **{% include product %} 站点**。 -**步骤 2：**通过从**“项目”(Projects)页面**中选择项目，从 **Shotgun 站点**访问该项目。 +**步骤 2：**通过从**“项目”(Projects)页面**中选择项目，从 **{% include product %} 站点**访问该项目。 -![Shotgun 项目](./images/editing_app_setting/1_shotgun_project.png) +![{% include product %} 项目](./images/editing_app_setting/1_shotgun_project.png) **步骤 3：**选择右上角的**头像**以显示**“管理”(ADMIN)**菜单，并向下滚动以选择**“默认布局 > 工作流配置 > 工作流配置列表”(Default Layouts > Pipeline Configuration > Pipeline Configuration List)**。 @@ -75,23 +75,23 @@ Toolkit 使用 YAML 文件来配置功能。之所以选择 YAML 作为配置的 ## 编辑配置文件 -Shotgun Toolkit 允许对集成在各种软件包中的应用进行更改。工作文件应用的一个功能是**“+New Task”**按钮，该按钮允许用户在**“File Open”**对话框中添加新任务。默认情况下，在项目的每个阶段为每个用户启用此功能。但是工作室可能希望限制此功能，例如，如果他们拥有特定的命名约定，或者想要将任务创建限制到项目的制作管理团队。在这种情况下，他们会为艺术家在 Maya 中工作时使用的工作流中的所有点禁用**“+New Task”**按钮。 +{% include product %} Toolkit 允许对集成在各种软件包中的应用进行更改。工作文件应用的一个功能是**“+New Task”**按钮，该按钮允许用户在**“File Open”**对话框中添加新任务。默认情况下，在项目的每个阶段为每个用户启用此功能。但是工作室可能希望限制此功能，例如，如果他们拥有特定的命名约定，或者想要将任务创建限制到项目的制作管理团队。在这种情况下，他们会为艺术家在 Maya 中工作时使用的工作流中的所有点禁用**“+New Task”**按钮。 ## 为 Maya 中的项目禁用“+New Task”按钮 -**步骤 7：**打开 **Shotgun Desktop**。 +**步骤 7：**打开 **{% include product %} Desktop**。 **步骤 8：**选择您要编辑其配置的项目。 ![加载项目](./images/editing_app_setting/6_load_project.png) -**步骤 9：**从 Shotgun Desktop 启动 Maya。 +**步骤 9：**从 {% include product %} Desktop 启动 Maya。 ![加载项目](./images/editing_app_setting/7_view_project.png) -等待 **Shotgun** 菜单完全加载。如果您的 Internet 连接速度较慢，可以利用运行配置的时间来享用表面带有适量棕红色泡沫的浓缩咖啡。 +等待 **{% include product %}** 菜单完全加载。如果您的 Internet 连接速度较慢，可以利用运行配置的时间来享用表面带有适量棕红色泡沫的浓缩咖啡。 -一旦完全加载 Maya 和 Shotgun，就会自动打开**“File Open”**对话框。当从 Shotgun Desktop 启动 Maya 时，您将在**项目**环境中进入 Maya；Toolkit 工作流的配置将由 `config/env/project.yml` 文件驱动。默认配置中标识的环境包括 `project`、`sequence`、`shot`、`shot_step`、`asset`、`asset_step`。 +一旦完全加载 Maya 和 {% include product %}，就会自动打开**“File Open”**对话框。当从 {% include product %} Desktop 启动 Maya 时，您将在**项目**环境中进入 Maya；Toolkit 工作流的配置将由 `config/env/project.yml` 文件驱动。默认配置中标识的环境包括 `project`、`sequence`、`shot`、`shot_step`、`asset`、`asset_step`。 **步骤 10：**在**“File Open”**对话框的左窗格中选择**“资产”(Assets)**选项卡。在搜索结果中显示的文件夹内选择任何资产。 @@ -101,11 +101,11 @@ Shotgun Toolkit 允许对集成在各种软件包中的应用进行更改。工 ## 查找控制“+New Task”按钮的设置 -Toolkit 工作流配置用于自定义环境以满足您的工作流需求。工作流配置可以覆盖默认 Shotgun 集成设置，根据需要或多或少会有所不同，以满足项目工作流的需求。这种结构允许采用轻量级配置，从而仅添加与 Shotgun 核心代码中的默认值不同的设置。在本练习中，我们希望关闭工作文件应用的**“+New Task”**按钮，但在这样做之前，我们需要确定哪个配置设置控制它。 +Toolkit 工作流配置用于自定义环境以满足您的工作流需求。工作流配置可以覆盖默认 {% include product %} 集成设置，根据需要或多或少会有所不同，以满足项目工作流的需求。这种结构允许采用轻量级配置，从而仅添加与 {% include product %} 核心代码中的默认值不同的设置。在本练习中，我们希望关闭工作文件应用的**“+New Task”**按钮，但在这样做之前，我们需要确定哪个配置设置控制它。 **步骤 11：**选择**“File Open”**窗口右上角**“Project (项目名称)”**旁边的 **>**。 -此参考框显示有关控制**“File Open”**窗口功能的配置设置的详细信息。Toolkit 中的某些应用具有参考框，以显示该应用使用的设置以及默认设置。请注意，**“Location:”**标识符是 **tk-multi-workfiles2**。这是创建 Workfiles 应用的代码包的标识符。在搜索工作流配置时，此名称将标识应用的设置所在位置。有一个[“应用和插件”页面](https://support.shotgunsoftware.com/hc/zh-cn/articles/219039798)，其中列出了 Shotgun 集成中可用的工作流的所有配置设置、应用和插件。 +此参考框显示有关控制**“File Open”**窗口功能的配置设置的详细信息。Toolkit 中的某些应用具有参考框，以显示该应用使用的设置以及默认设置。请注意，**“Location:”**标识符是 **tk-multi-workfiles2**。这是创建 Workfiles 应用的代码包的标识符。在搜索工作流配置时，此名称将标识应用的设置所在位置。有一个[“应用和插件”页面](https://support.shotgunsoftware.com/hc/zh-cn/articles/219039798)，其中列出了 {% include product %} 集成中可用的工作流的所有配置设置、应用和插件。 ![Current_work_area](./images/editing_app_setting/9_current_work_area.png) @@ -137,11 +137,11 @@ Toolkit 工作流配置用于自定义环境以满足您的工作流需求。工 **步骤 13：**在 Maya 窗口的右上角找到**“Shotgun”**菜单项。 -![Maya Shotgun 2](./images/editing_app_setting/12_Maya_Shotgun2.png) +![Maya {% include product %} 2](./images/editing_app_setting/12_Maya_Shotgun2.png) -**提示：**如果此菜单不可见，则会显示 **>>** 以表明某些菜单项处于隐藏状态。选择 **>>** 以显示“Shotgun”菜单，或者您可以加宽 Maya 窗口。 +**提示：**如果此菜单不可见，则会显示 **>>** 以表明某些菜单项处于隐藏状态。选择 **>>** 以显示“{% include product %}”菜单，或者您可以加宽 Maya 窗口。 -**步骤 14：**在菜单右上角选择**“Shotgun > Project the_other_side > Work Area Info…”**。 +**步骤 14：**在菜单右上角选择**“{% include product %} > Project the_other_side > Work Area Info…”**。 ![工作区信息](./images/editing_app_setting/13_work_area_info.png) @@ -149,7 +149,7 @@ Toolkit 工作流配置用于自定义环境以满足您的工作流需求。工 **步骤 15：**在**“Your Current Work Area”**对话框中，选择底部的**“环境”(Environment)**选项卡。 -第一项标识正在使用的插件。插件推动了将 Shotgun 工具集成在特定软件应用程序中的能力。它包含特定于每个软件集成的逻辑。窗口中显示的第二项显示当前项目环境所在的路径。 +第一项标识正在使用的插件。插件推动了将 {% include product %} 工具集成在特定软件应用程序中的能力。它包含特定于每个软件集成的逻辑。窗口中显示的第二项显示当前项目环境所在的路径。 ![工作区信息环境](./images/editing_app_setting/14_shotgun_work_area_info_Environment.png) @@ -219,7 +219,7 @@ frameworks: "@frameworks" 这一整行告诉我们在包含文件中查找 `settings.tk-maya.project` 块，以找到 Maya 插件 `tk-maya` 的配置设置。 -Shotgun Toolkit 会在 YAML 文件中使用简单的术语，来指示设置的名称以及引导您找到它们的路径。通过在 Maya**“File Open”**参考框中查看，我们已经知道，控制**“+New Task”**按钮执行方式的代码包是由 `tk-multi-workfiles2` 标识的。在 YAML 文件中使用这些标识符引用 Toolkit 包。“tk-multi-workfiles2”是 Workfiles 应用代码包的标识符，**“+New Task”**按钮是 Workfiles 应用的一个功能。 +{% include product %} Toolkit 会在 YAML 文件中使用简单的术语，来指示设置的名称以及引导您找到它们的路径。通过在 Maya**“File Open”**参考框中查看，我们已经知道，控制**“+New Task”**按钮执行方式的代码包是由 `tk-multi-workfiles2` 标识的。在 YAML 文件中使用这些标识符引用 Toolkit 包。“tk-multi-workfiles2”是 Workfiles 应用代码包的标识符，**“+New Task”**按钮是 Workfiles 应用的一个功能。 在 tk-maya.yml 中查找 Workfiles 应用设置 @@ -318,7 +318,7 @@ settings.tk-multi-workfiles2.launch_at_startup: ## 了解您的工作环境 -**步骤 26：**在 Maya 菜单的右上角，选择**“Shotgun”**。 +**步骤 26：**在 Maya 菜单的右上角，选择**“{% include product %}”**。 ![艺术资产环境](./images/editing_app_setting/23_Art_Asset.png) @@ -334,7 +334,7 @@ settings.tk-multi-workfiles2.launch_at_startup: 注意：每个环境都是独立的，一个项目具有专用的配置，加载项目时软件集成仅从工作流配置中读取其特定软件的设置。 -您现在已经编辑了工作流配置，对应用的设置进行了更改。现在，真正有趣的事情开始了：学习使用 Shotgun Toolkit 环境可以执行的所有任务。下面是一些要探索的高级主题。 +您现在已经编辑了工作流配置，对应用的设置进行了更改。现在，真正有趣的事情开始了：学习使用 {% include product %} Toolkit 环境可以执行的所有任务。下面是一些要探索的高级主题。 ## 高级主题 diff --git a/docs/zh_CN/guides/pipeline-integrations/getting-started/installing_app.md b/docs/zh_CN/guides/pipeline-integrations/getting-started/installing_app.md index 36ccca85b..a154dbbbe 100644 --- a/docs/zh_CN/guides/pipeline-integrations/getting-started/installing_app.md +++ b/docs/zh_CN/guides/pipeline-integrations/getting-started/installing_app.md @@ -16,9 +16,9 @@ lang: zh_CN ## 关于本手册 -本手册将演示如何将 Shotgun Toolkit 应用添加到现有的工作流配置。您将很快熟悉配置管理工具。 +本手册将演示如何将 {% include product %} Toolkit 应用添加到现有的工作流配置。您将很快熟悉配置管理工具。 -我们要添加的应用是 Shotgun Python 控制台应用。Maya 具有其自己的 Python 控制台，但是 Toolkit 应用中有一些功能在 Maya 控制台中不存在。 +我们要添加的应用是 {% include product %} Python 控制台应用。Maya 具有其自己的 Python 控制台，但是 Toolkit 应用中有一些功能在 Maya 控制台中不存在。 本手册利用我们在[编辑工作流配置](./editing_app_setting.md)手册中创建的工作流配置。 如果您尚未完成此手册，则可以使用现有的工作流配置，并在其中添加该应用。 @@ -26,36 +26,36 @@ lang: zh_CN 要使用本手册并安装 Toolkit 应用，需要以下内容： -1. 有效的 [Shotgun](https://www.shotgunsoftware.com/zh-cn/signup/) 站点。 +1. 有效的 [{% include product %}](https://www.shotgunsoftware.com/zh-cn/signup/) 站点。 2. 已标识项目的工作流配置，或完成[配置快速入门手册](./advanced_config.md)并使用该练习中创建的配置。 3. 为存储工作流配置的文件系统设置适当的读取和写入权限。 -4. 在系统上安装 Shotgun Desktop。 +4. 在系统上安装 {% include product %} Desktop。 5. Maya 的有效固定期限的使用许可。在[此处](https://www.autodesk.com.cn/products/maya/free-trial) 获取 Maya 的 30 天试用版。 {% include info title="注意" content="本手册基于 tk-config-default2 工作流配置。如果您的配置文件已修改，则文件和文件夹的位置、YAML 设置的区块可能就与此处描述的不同。"%} -## 关于 Shotgun Toolkit 应用 +## 关于 {% include product %} Toolkit 应用 ### Toolkit 应用工作方式 -工作流配置中引用的应用可以来自不同的位置。默认配置中的标准应用来自 Shotgun App Store。工作流配置中的文件指定 Shotgun 集成如何访问应用，有点像询问 Toolkit，“您能在小黑本中查找 Python 控制台应用的地址吗？”工作流配置文件告知 Toolkit 在何处可以找到用于特定应用的代码包。 +工作流配置中引用的应用可以来自不同的位置。默认配置中的标准应用来自 {% include product %} App Store。工作流配置中的文件指定 {% include product %} 集成如何访问应用，有点像询问 Toolkit，“您能在小黑本中查找 Python 控制台应用的地址吗？”工作流配置文件告知 Toolkit 在何处可以找到用于特定应用的代码包。 -Toolkit 应用的“地址”列在默认配置的 `config/env/includes/app_locations.yml` 文件中，并指定如何查找代码。这些“地址”称为[描述符](https://developer.shotgunsoftware.com/tk-core/descriptor.html)。不仅需要告诉 Shotgun 集成如何查找应用的代码包，还需要告诉它在哪些环境中使用该应用。 +Toolkit 应用的“地址”列在默认配置的 `config/env/includes/app_locations.yml` 文件中，并指定如何查找代码。这些“地址”称为[描述符](https://developer.shotgunsoftware.com/tk-core/descriptor.html)。不仅需要告诉 {% include product %} 集成如何查找应用的代码包，还需要告诉它在哪些环境中使用该应用。 -下面概念性概述了如何安装应用以及如何告知 Shotgun 集成在何处使用它。它概述了扩展配置的步骤，要求 Toolkit 查找描述符，并告知 Shotgun 在何处使用该应用。本手册详细介绍了这些步骤： +下面概念性概述了如何安装应用以及如何告知 {% include product %} 集成在何处使用它。它概述了扩展配置的步骤，要求 Toolkit 查找描述符，并告知 {% include product %} 在何处使用该应用。本手册详细介绍了这些步骤： 1. 确定要添加的应用的描述符。 2. 复制要将应用描述符添加到的活动工作流配置。 3. 确定该应用的描述符在配置中是否存在，如果不存在，则添加它。 4. 使用空格而不是制表符进行缩进，从而正确设置 YAML 文件的格式。 5. 确定要在哪些环境中使用该应用。 -6. 在这些环境中，添加允许 Shotgun 使用该应用的设置。 +6. 在这些环境中，添加允许 {% include product %} 使用该应用的设置。 7. 测试新配置。 8. 使扩展配置生效。 ### 查找 Python 控制台应用的位置描述符 -**步骤 1：**打开[应用和插件页面](https://support.shotgunsoftware.com/hc/zh-cn/articles/219039798#tk-maya)，并在 Maya 下查找 Shotgun Python 控制台的信息。选择标题。 +**步骤 1：**打开[应用和插件页面](https://support.shotgunsoftware.com/hc/zh-cn/articles/219039798#tk-maya)，并在 Maya 下查找 {% include product %} Python 控制台的信息。选择标题。 ![Python 应用](./images/installing_app/1_python_app.png) @@ -67,7 +67,7 @@ Toolkit 应用的“地址”列在默认配置的 `config/env/includes/app_loca ### 确认在 Maya 的项目环境中没有 Python 控制台应用 -**步骤 2：**启动 Maya 并选择 Shotgun 菜单**“Shotgun > 项目 the_other_side”(Shotgun > Project the_other_side)**，您会看到可用于项目环境中该项目的应用列表。 +**步骤 2：**启动 Maya 并选择 {% include product %} 菜单**“{% include product %} > 项目 the_other_side”({% include product %} > Project the_other_side)**，您会看到可用于项目环境中该项目的应用列表。 ![应用列表](./images/installing_app/3_list_of_apps.png) @@ -81,11 +81,11 @@ Toolkit 应用的“地址”列在默认配置的 `config/env/includes/app_loca ### 转到工作流配置列表。 -**步骤 3：**打开 Shotgun，在右上角选择**“管理”(Admin)菜单（您的头像）>“默认布局 > 工作流配置 > 工作流配置列表”(Default Layouts > Pipeline Configuration > Pipeline Configuration List)**。 +**步骤 3：**打开 {% include product %}，在右上角选择**“管理”(Admin)菜单（您的头像）>“默认布局 > 工作流配置 > 工作流配置列表”(Default Layouts > Pipeline Configuration > Pipeline Configuration List)**。 ![工作流配置列表](./images/installing_app/4_REPLACE_pipeline_configuration_list.png) -此动作将显示 Shotgun 站点的所有工作流配置的详细列表。 +此动作将显示 {% include product %} 站点的所有工作流配置的详细列表。 **步骤 4：**显示“工作流配置列表”(Pipeline Configuration List)后，选择列标题最右侧的 **+** 号，然后添加**“项目”(Projects)**列。 @@ -109,7 +109,7 @@ Toolkit 应用的“地址”列在默认配置的 `config/env/includes/app_loca ![命名克隆](./images/installing_app/9_name_clone.png) -等待 Shotgun 复制配置中的所有文件和文件夹，并为应用创建缓存。现在就可以使用应用，让您可以一边喝着香浓咖啡，一边享用羊角面包。 +等待 {% include product %} 复制配置中的所有文件和文件夹，并为应用创建缓存。现在就可以使用应用，让您可以一边喝着香浓咖啡，一边享用羊角面包。 ![克隆完成](./images/installing_app/10_clone_complete.png) @@ -119,11 +119,11 @@ Toolkit 应用的“地址”列在默认配置的 `config/env/includes/app_loca ## 将克隆的配置与项目相关联 -**步骤 8：**打开 Shotgun Desktop，并选择您为其创建克隆配置的项目。选择右上角的**向下箭头**以显示与此项目关联的配置，然后选择刚创建的 **Primary Clone Config 2**。 +**步骤 8：**打开 {% include product %} Desktop，并选择您为其创建克隆配置的项目。选择右上角的**向下箭头**以显示与此项目关联的配置，然后选择刚创建的 **Primary Clone Config 2**。 ![选择克隆](./images/installing_app/11_select_clone.png) -Shotgun Desktop 现在正在使用此项目的克隆配置。 +{% include product %} Desktop 现在正在使用此项目的克隆配置。 ## 编辑工作流配置 @@ -181,7 +181,7 @@ engines: ### YAML 文件 -Shotgun Toolkit 工作流配置使用 [YAML](https://yaml.org/spec/1.2/spec.html) 文件中的简单术语来标识应用和插件的位置及其设置。 +{% include product %} Toolkit 工作流配置使用 [YAML](https://yaml.org/spec/1.2/spec.html) 文件中的简单术语来标识应用和插件的位置及其设置。 对于此特定块： @@ -190,11 +190,11 @@ Shotgun Toolkit 工作流配置使用 [YAML](https://yaml.org/spec/1.2/spec.html * `tk-maya` 是 Toolkit 的 Maya 插件的标识符 * `@` 是 Toolkit 术语，用于表示设置值来自包含文件 -YAML 文件是 Shotgun 集成的窗口，可以更轻松地配置满足您的工作流需求的工作环境。 +YAML 文件是 {% include product %} 集成的窗口，可以更轻松地配置满足您的工作流需求的工作环境。 ### 配置如何引用 Toolkit 包 -Shotgun 集成的代码被组织成应用、插件和框架的包。在 Toolkit 的 YAML 文件中使用 `tk-maya`、`tk-multi-pythonconsole` 等标识符对这些包进行引用。每个包的相应 YAML 块都包含用于控制如何访问和使用所标识包的设置。 +{% include product %} 集成的代码被组织成应用、插件和框架的包。在 Toolkit 的 YAML 文件中使用 `tk-maya`、`tk-multi-pythonconsole` 等标识符对这些包进行引用。每个包的相应 YAML 块都包含用于控制如何访问和使用所标识包的设置。 ## 在何处放置 Python 控制台的设置 @@ -232,7 +232,7 @@ settings.tk-maya.project: tk-multi-workfiles2: "@settings.tk-multi-workfiles2.launch_at_startup" ``` -您会注意到，**审片室、Shotgun 面板和 Workfiles 2** 应用的位置标识符列在不同的包含文件中，并且以不同于**关于**应用的方式进行访问。为了保持整洁，这些应用被拆分到包含的 settings 文件夹，因为它们具有其他设置。 +您会注意到，**审片室、{% include product %} 面板和 Workfiles 2** 应用的位置标识符列在不同的包含文件中，并且以不同于**关于**应用的方式进行访问。为了保持整洁，这些应用被拆分到包含的 settings 文件夹，因为它们具有其他设置。 {% include info title="注意" content="Python 控制台应用已经存在于默认配置中，但是如果您添加的应用以前从未添加到配置中，或者您已更改应用的版本，并且使用的是[集中式配置](https://developer.shotgunsoftware.com/tk-core/initializing.html#centralized-configurations)，则需要额外执行一个步骤。打开终端，并浏览到存储克隆配置的位置。从克隆配置的根文件夹中，运行以下命令：
@@ -248,7 +248,7 @@ settings.tk-maya.project: ## 查看 Maya 中的更改 -**步骤 16：**打开 Shotgun Desktop，选择正在处理的项目，并确认您使用的是克隆配置。 +**步骤 16：**打开 {% include product %} Desktop，选择正在处理的项目，并确认您使用的是克隆配置。 在项目名称下，将出现一个蓝色条，其中包含您创建的克隆的名称。 @@ -256,7 +256,7 @@ settings.tk-maya.project: ![Maya 克隆配置](./images/installing_app/14_maya_cloned_config.png) -**步骤 17：**从 Desktop 启动 Maya，然后选择菜单**“Shotgun > 项目 > …”(Shotgun > Project > …)** +**步骤 17：**从 Desktop 启动 Maya，然后选择菜单**“{% include product %} > 项目 > …”({% include product %} > Project > …)** 如果： @@ -264,7 +264,7 @@ settings.tk-maya.project: * 克隆配置已正确扩展 * 您保存了扩展文件 * 您选择将项目与克隆配置相关联 -* 您从 Shotgun Desktop 重新启动了 Maya +* 您从 {% include product %} Desktop 重新启动了 Maya Python 控制台应用将在 Maya 中可用。 @@ -328,7 +328,7 @@ Please type in the id of the configuration to push to (ENTER to exit): ![ID 列](./images/installing_app/17_id_column.png) -输入 ID 后，Shotgun 将： +输入 ID 后，{% include product %} 将： * 备份主要配置 * 复制克隆配置 @@ -348,11 +348,11 @@ Push Complete! ## 查看在主要配置中所做的更改 -**步骤 19：**在 Shotgun Desktop 中，单击右上角的箭头，并在**“配置”(CONFIGURATION)**列表中选择**“主要”(Primary)**。 +**步骤 19：**在 {% include product %} Desktop 中，单击右上角的箭头，并在**“配置”(CONFIGURATION)**列表中选择**“主要”(Primary)**。 ![更改配置 maya](./images/installing_app/18_change_config_maya.png) -**步骤 20：**从 Desktop 启动 Maya，并查看菜单**“Shotgun > 项目 > …”(Shotgun > Project > …)**以查找“Shotgun Python 控制台...”(Shotgun Python Console...) +**步骤 20：**从 Desktop 启动 Maya，并查看菜单**“{% include product %} > 项目 > …”({% include product %} > Project > …)**以查找“{% include product %} Python 控制台...”({% include product %} Python Console...) ![Maya 中的应用](./images/installing_app/19_app_in_maya.png) @@ -360,15 +360,15 @@ Python 控制台应用已添加到所选项目的项目环境中。我们在第 ## 高级主题 -### Shotgun 开发人员社区 +### {% include product %} 开发人员社区 -Toolkit 的一个奇妙之处在于，任何人都可以创建 Toolkit 应用。应用可以保持专有，也可以在 [Shotgun 社区](https://support.shotgunsoftware.com/hc/zh-cn/articles/219039828) 中分享，并添加到 Shotgun 库。如果您创建了一个非常出色的应用，并且想在 Shotgun 社区页面中分享，请发送电子邮件至 [support@shotgunsoftware.com](mailto:support@shotgunsoftware.com)。 +Toolkit 的一个奇妙之处在于，任何人都可以创建 Toolkit 应用。应用可以保持专有，也可以在 [{% include product %} 社区](https://support.shotgunsoftware.com/hc/zh-cn/articles/219039828) 中分享，并添加到 {% include product %} 库。如果您创建了一个非常出色的应用，并且想在 {% include product %} 社区页面中分享，请发送电子邮件至 [support@shotgunsoftware.com](mailto:support@shotgunsoftware.com)。 -在 **[shotgun-dev Google 组](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups&hl=zh-CN#!forum/shotgun-dev)** 中对标准 Toolkit 应用和由充满爱心的 Shotgun 社区创建的应用进行了热烈的讨论。随着 Shotgun 社区内容日益丰富，知识和工具库将不断壮大。 +在 **[{% include product %}-dev Google 组](https://groups.google.com/a/shotgunsoftware.com/forum/?fromgroups&hl=zh-CN#!forum/shotgun-dev)** 中对标准 Toolkit 应用和由充满爱心的 {% include product %} 社区创建的应用进行了热烈的讨论。随着 {% include product %} 社区内容日益丰富，知识和工具库将不断壮大。 ### 研究如何扩展配置 -您可能已经注意到，当我们选择要用于项目的配置时，Shotgun Desktop 下拉菜单中提供了 Python 控制台应用。 +您可能已经注意到，当我们选择要用于项目的配置时，{% include product %} Desktop 下拉菜单中提供了 Python 控制台应用。 ![Desktop Python 控制台](./images/installing_app/20_desktop_python_console.png) diff --git a/docs/zh_CN/guides/pipeline-integrations/getting_started.md b/docs/zh_CN/guides/pipeline-integrations/getting_started.md index 1a04f99d6..4f8b122f3 100644 --- a/docs/zh_CN/guides/pipeline-integrations/getting_started.md +++ b/docs/zh_CN/guides/pipeline-integrations/getting_started.md @@ -7,4 +7,4 @@ lang: zh_CN # Getting Started -Shotgun Toolkit 提供了一组可高度自定义的工具，用于创建工作室工作流，让艺术家可以从 Shotgun 中访问信息并彼此共享作品，而无需退出其内容创建软件。这些手册旨在帮助您通过实际练习开始设置自定义 Toolkit 工作流：您将使用 Shotgun Desktop 应用为项目生成可编辑的配置，修改现有应用的设置，甚至将 Toolkit 应用添加到不同的美工人员环境，从而让您设计自定义工作流。每个手册都以之前的手册为基础，但是它们包含从任何位置跳转的说明。 +{% include product %} Toolkit 提供了一组可高度自定义的工具，用于创建工作室工作流，让艺术家可以从 {% include product %} 中访问信息并彼此共享作品，而无需退出其内容创建软件。这些手册旨在帮助您通过实际练习开始设置自定义 Toolkit 工作流：您将使用 {% include product %} Desktop 应用为项目生成可编辑的配置，修改现有应用的设置，甚至将 Toolkit 应用添加到不同的美工人员环境，从而让您设计自定义工作流。每个手册都以之前的手册为基础，但是它们包含从任何位置跳转的说明。 diff --git a/docs/zh_CN/guides/pipeline-integrations/workflows/pipeline-tutorial.md b/docs/zh_CN/guides/pipeline-integrations/workflows/pipeline-tutorial.md index 644000d20..b6d4262a4 100644 --- a/docs/zh_CN/guides/pipeline-integrations/workflows/pipeline-tutorial.md +++ b/docs/zh_CN/guides/pipeline-integrations/workflows/pipeline-tutorial.md @@ -9,7 +9,7 @@ lang: zh_CN 本教程介绍如何为动画或视觉效果制作打造一个简化但却典型的工作流。按照本教程，您将打造一个全面的工作流，为资产的建模、视觉开发到融入制作场景提供所有必要环节。 -此工作流中涵盖的大部分流程通过 Shotgun 的内置集成便可实现。对于工作流中工作室更多时候会构建自定义解决方案的部分，本教程将指导您完成使用 Toolkit 平台自定义艺术家工作流的整个过程。 +此工作流中涵盖的大部分流程通过 {% include product %} 的内置集成便可实现。对于工作流中工作室更多时候会构建自定义解决方案的部分，本教程将指导您完成使用 Toolkit 平台自定义艺术家工作流的整个过程。 下面是您将在本教程中构建的工作流的简要视图： @@ -23,21 +23,21 @@ lang: zh_CN ## 先决条件 -* **参与 Shotgun 项目** - 本教程假定您有使用 Shotgun 跟踪和管理制作数据的经验。 +* **参与 {% include product %} 项目** - 本教程假定您有使用 {% include product %} 跟踪和管理制作数据的经验。 -* **了解 Shotgun 集成** - Shotgun 附带一些集成，这些集成提供了一些不需要任何手动配置的简单制作工作流。您应先了解这些工作流的功能和范围，然后再深入了解本教程中介绍的手动配置和自定义。有关 Shotgun 集成的详细信息，请参见[此处](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000068574)。 +* **了解 {% include product %} 集成** - {% include product %} 附带一些集成，这些集成提供了一些不需要任何手动配置的简单制作工作流。您应先了解这些工作流的功能和范围，然后再深入了解本教程中介绍的手动配置和自定义。有关 {% include product %} 集成的详细信息，请参见[此处](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000068574)。 -* **Maya 和 Nuke 体验** - 本教程旨在使用 Maya 和 Nuke 构建一个简单的工作流。您应该对这些软件包有基本的了解，以便自定义 Shotgun 提供的集成。 +* **Maya 和 Nuke 体验** - 本教程旨在使用 Maya 和 Nuke 构建一个简单的工作流。您应该对这些软件包有基本的了解，以便自定义 {% include product %} 提供的集成。 -* **Python 应用知识** - 本教程需要通过采用 Python 编写的“挂钩”修改 Shotgun 集成的功能。 +* **Python 应用知识** - 本教程需要通过采用 Python 编写的“挂钩”修改 {% include product %} 集成的功能。 * **熟悉 YAML** - 您将构建的工作流的很多配置都是通过修改 YAML 文件来完成的。 ## 其他资源 -* [Shotgun 支持站点](https://support.shotgunsoftware.com/hc/zh-cn) +* [{% include product %} 支持站点](https://support.shotgunsoftware.com/hc/zh-cn) -* [Shotgun 集成](https://www.shotgunsoftware.com/zh-cn/integrations/) +* [{% include product %} 集成](https://www.shotgunsoftware.com/zh-cn/integrations/) * [用户手册](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000068574) @@ -47,7 +47,7 @@ lang: zh_CN # 项目创建和设置 -在本教程中，您需要在 Shotgun 中创建一个新项目，并像准备开始制作那样配置该项目。这包括确保所有必要的 Shotgun 实体都已就位并正确关联。在本教程中，资产、镜头序列、镜头和任务实体是必需的，默认情况下新项目中应提供这些实体。您将创建以下对象： +在本教程中，您需要在 {% include product %} 中创建一个新项目，并像准备开始制作那样配置该项目。这包括确保所有必要的 {% include product %} 实体都已就位并正确关联。在本教程中，资产、镜头序列、镜头和任务实体是必需的，默认情况下新项目中应提供这些实体。您将创建以下对象： * 两个**资产**： @@ -61,7 +61,7 @@ lang: zh_CN * 每个工作流工序一个**任务** -下面是一些屏幕截图，显示了您在 Shotgun 中配置的项目实体： +下面是一些屏幕截图，显示了您在 {% include product %} 中配置的项目实体： {% include figure src="./images/tutorial/image_1.png" caption="茶壶和桌子资产" %} @@ -71,25 +71,25 @@ lang: zh_CN ## 软件启动器 -接下来，您将需要确保 Maya 和 Nuke 可在 Shotgun Desktop 中启动。在 Desktop 中，确保每个软件包都可以通过单击其图标启动。确保启动每个软件包的正确版本。 +接下来，您将需要确保 Maya 和 Nuke 可在 {% include product %} Desktop 中启动。在 Desktop 中，确保每个软件包都可以通过单击其图标启动。确保启动每个软件包的正确版本。 -如果任一应用程序未显示在 Desktop 中或预期版本无法启动，则可能需要在 Shotgun 中通过软件实体手动配置启动。 +如果任一应用程序未显示在 Desktop 中或预期版本无法启动，则可能需要在 {% include product %} 中通过软件实体手动配置启动。 {% include figure src="./images/tutorial/image_4.png" caption="Shotgun 中定义的默认软件实体" %} -软件实体用于驱动在您的制作中使用哪些 DCC 软件包。默认情况下，集成将在标准安装位置搜索这些软件包并使其可通过 Desktop 启动。如果您安装了多个版本或将它们安装在非标准位置，您可能需要在 Shotgun 中更新相应的软件实体条目以管理您的艺术家的启动体验。 +软件实体用于驱动在您的制作中使用哪些 DCC 软件包。默认情况下，集成将在标准安装位置搜索这些软件包并使其可通过 Desktop 启动。如果您安装了多个版本或将它们安装在非标准位置，您可能需要在 {% include product %} 中更新相应的软件实体条目以管理您的艺术家的启动体验。 有关软件实体以及如何正确配置该实体的完整详细信息，请参见[集成管理员手册](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000067493#Configuring%20software%20launches)。在您的 DCC 按预期启动后，可以继续阅读下一节。 # 配置 -配置定义项目的美工人员工作流。这包括指定哪些 Shotgun 集成包含在艺术家要启动的 DCC 中，如何定义项目的文件夹结构，以及艺术家共享数据时创建的文件和文件夹的命名约定。 +配置定义项目的美工人员工作流。这包括指定哪些 {% include product %} 集成包含在艺术家要启动的 DCC 中，如何定义项目的文件夹结构，以及艺术家共享数据时创建的文件和文件夹的命名约定。 -默认情况下，所有新项目均配置为使用基本 [Shotgun 集成](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000068574)，这些集成提供了使用许多现成的软件包在艺术家之间共享文件的基本工作流。以下各节概述了如何接管项目的工作流配置以及如何为您的工作室对其进行自定义。 +默认情况下，所有新项目均配置为使用基本 [{% include product %} 集成](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000068574)，这些集成提供了使用许多现成的软件包在艺术家之间共享文件的基本工作流。以下各节概述了如何接管项目的工作流配置以及如何为您的工作室对其进行自定义。 ## 接管项目配置 -可使用 Shotgun Desktop (Desktop) 接管项目的配置。在 Desktop 中单击鼠标右键或单击右下方的用户图标以显示弹出菜单。选择**“Advanced project setup…”**选项，然后按照向导操作在本地安装项目配置。以下各图显示了所需的操作步骤。也可以按照《集成管理员手册》的[接管工作流配置](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000067493#Taking%20over%20a%20Pipeline%20Configuration) 中所述的步骤操作。 +可使用 {% include product %} Desktop (Desktop) 接管项目的配置。在 Desktop 中单击鼠标右键或单击右下方的用户图标以显示弹出菜单。选择**“Advanced project setup…”**选项，然后按照向导操作在本地安装项目配置。以下各图显示了所需的操作步骤。也可以按照《集成管理员手册》的[接管工作流配置](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000067493#Taking%20over%20a%20Pipeline%20Configuration) 中所述的步骤操作。 {% include figure src="./images/tutorial/image_5.png" caption="在 Desktop 弹出菜单中选择**“Advanced project setup...”**" %} @@ -97,7 +97,7 @@ lang: zh_CN {% include figure src="./images/tutorial/wizard_02.png" caption="选择**“默认”(Default)**配置" %} -如果这是您第一次设置 Shotgun 项目，系统还会提示您为项目数据定义一个存储位置。否则，可以选择现有存储位置。 +如果这是您第一次设置 {% include product %} 项目，系统还会提示您为项目数据定义一个存储位置。否则，可以选择现有存储位置。 {% include figure src="./images/tutorial/wizard_03.png" caption="创建新存储。" %} @@ -105,7 +105,7 @@ lang: zh_CN {% include figure src="./images/tutorial/wizard_05.png" caption="设置在您要使用的操作系统上将可以访问此存储的路径。" %} -您可以在**“站点偏好设置”(Site Preferences)**的**“文件管理”(File Management)**部分下查看和编辑 Shotgun 站点的存储。可以在[此处](https://support.shotgunsoftware.com/hc/zh-cn/articles/219030938)了解有关这些设置的详细信息。 +您可以在**“站点偏好设置”(Site Preferences)**的**“文件管理”(File Management)**部分下查看和编辑 {% include product %} 站点的存储。可以在[此处](https://support.shotgunsoftware.com/hc/zh-cn/articles/219030938)了解有关这些设置的详细信息。 现在，您已选择存储位置，需要在该位置为新项目选择目录名称。 @@ -121,7 +121,7 @@ lang: zh_CN 单击以上屏幕中的**“Run Setup”**后，Desktop 将开始下载并安装您的配置所需的所有组件。安装过程可能需要几分钟时间完成。完成后，您将具有整个项目配置的本地副本，在后面的操作步骤中您将对其进行修改。 -您在学习 Desktop 安装教程期间指定的配置位置记录在 Shotgun 中，位于项目的“工作流配置”(Pipeline Configurations)页面。 +您在学习 Desktop 安装教程期间指定的配置位置记录在 {% include product %} 中，位于项目的“工作流配置”(Pipeline Configurations)页面。 {% include figure src="./images/tutorial/image_10.png" caption="Shotgun 中的工作流配置实体" %} @@ -157,9 +157,9 @@ lang: zh_CN # 构建工作流 -此时，您应该可以开始构建工作流。您在 Shotgun 中设置了一个项目，可以通过 Desktop 启动 Maya 和 Nuke，并且已接管了项目配置的控制权。此外，您已对配置的结构有基本的了解，可以开始构建美工人员工作流。 +此时，您应该可以开始构建工作流。您在 {% include product %} 中设置了一个项目，可以通过 Desktop 启动 Maya 和 Nuke，并且已接管了项目配置的控制权。此外，您已对配置的结构有基本的了解，可以开始构建美工人员工作流。 -以下各节将介绍该工作流的每个工序，重点介绍即时可用的功能，并指导您完成自定义 Shotgun 集成的整个过程。完成相关各节的学习后，您将构建一个简单、完全可行的端到端制作工作流。您还将了解到艺术家在其制作活动中将执行的工序。 +以下各节将介绍该工作流的每个工序，重点介绍即时可用的功能，并指导您完成自定义 {% include product %} 集成的整个过程。完成相关各节的学习后，您将构建一个简单、完全可行的端到端制作工作流。您还将了解到艺术家在其制作活动中将执行的工序。 {% include info title="注意" content="本教程的所有代码和配置都可以在 [**`tk-config-default2`** 库](https://github.com/shotgunsoftware/tk-config-default2/tree/pipeline_tutorial/) 的 **`pipeline_tutorial`** 分支中找到。如果您需要有关文件所在位置、代码添加位置等的提示，可以随时使用此分支。" %} @@ -167,9 +167,9 @@ lang: zh_CN 简单工作流的第一道工序是建模。在本节中，您将在您的项目中创建茶壶资产的第一个迭代。您要将其保存到磁盘上的项目文件夹结构中，然后将其发布。 -首先，从 Shotgun Desktop 启动 Maya。 +首先，从 {% include product %} Desktop 启动 Maya。 -Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中，您可以浏览项目中的现有 Maya 文件。此外，您还可以创建 Shotgun 集成将会识别的新文件。 +Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中，您可以浏览项目中的现有 Maya 文件。此外，您还可以创建 {% include product %} 集成将会识别的新文件。 选择“资产”(Assets)选项卡，然后向下查看茶壶的建模任务。由于此任务还没有美工人员工作文件，请单击**“+ New File”**按钮。 @@ -183,7 +183,7 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 {% include figure src="./images/tutorial/image_14.png" %} -当您对自己的茶壶模型满意后，请选择**“Shotgun > File Save...”**菜单动作。此对话框将提示您使用给定名称、版本和类型保存该文件。 +当您对自己的茶壶模型满意后，请选择**“{% include product %} > File Save...”**菜单动作。此对话框将提示您使用给定名称、版本和类型保存该文件。 {% include figure src="./images/tutorial/image_15.png" %} @@ -201,19 +201,19 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 单击**“保存”(Save)**按钮保存该茶壶模型。 -此时务必要注意的一点是，您刚刚完成的步骤与艺术家在整个工作流中打开和保存工作文件时执行的步骤相同。“File Open”和“File Save”对话框属于 Workfiles 应用。此“多”应用在 Shotgun 集成支持的所有 DCC 中运行，并为所有艺术家提供一致的工作流。 +此时务必要注意的一点是，您刚刚完成的步骤与艺术家在整个工作流中打开和保存工作文件时执行的步骤相同。“File Open”和“File Save”对话框属于 Workfiles 应用。此“多”应用在 {% include product %} 集成支持的所有 DCC 中运行，并为所有艺术家提供一致的工作流。 下一步是对茶壶进行一些更改。确保壶盖几何体与模型的其余部分分离开，以便以后可以对其进行装配。 {% include figure src="./images/tutorial/image_16.png" %} -当您对自己的作品满意后，再次运行**“Shotgun > File Save…”**菜单动作。此时，在对话框中版本号默认设置为 2。文件版本自动递增功能让艺术家可维护所完成工作的完整历史记录。单击“保存”(Save)按钮。 +当您对自己的作品满意后，再次运行**“{% include product %} > File Save…”**菜单动作。此时，在对话框中版本号默认设置为 2。文件版本自动递增功能让艺术家可维护所完成工作的完整历史记录。单击“保存”(Save)按钮。 {% include figure src="./images/tutorial/image_17.png" %} 将茶壶模型保存为版本 2 后，您就可以进行本教程中本节的最后一步。 -现在，茶壶模型已准备就绪，您需要将其发布，以便可以对其进行贴图和装配。要进行发布，请单击**“Shotgun > Publish…”**菜单动作。此时将显示发布应用对话框。 +现在，茶壶模型已准备就绪，您需要将其发布，以便可以对其进行贴图和装配。要进行发布，请单击**“{% include product %} > Publish…”**菜单动作。此时将显示发布应用对话框。 {% include figure src="./images/tutorial/image_18.png" %} @@ -225,7 +225,7 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 可单击树左侧的项了解发布应用。您将注意到，在选择要对其执行操作的项后，您可以输入要发布的内容的说明。您还可以单击右侧的摄影机图标拍摄屏幕截图以与该项关联。 -当您准备好时，单击右下角的**“Publish”**按钮发布当前工作文件和茶壶几何体。完成后，您可以浏览到 Shotgun 中的茶壶资产以验证发布是否已成功完成。 +当您准备好时，单击右下角的**“Publish”**按钮发布当前工作文件和茶壶几何体。完成后，您可以浏览到 {% include product %} 中的茶壶资产以验证发布是否已成功完成。 {% include figure src="./images/tutorial/image_19.png" %} @@ -259,15 +259,15 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 在本节中，您将基于您在建模一节中所学内容进一步学习。您将了解如何使用加载器应用加载在上一节中创建的茶壶模型。还将了解如何自定义发布应用来为茶壶发布着色器。 -首先，从 Desktop 启动 Maya。如果在完成上一节后 Maya 仍保持打开状态，则不需要重新启动。打开 Maya 后，使用**“Shotgun > File Open...”**菜单项打开 Workfiles 应用。与建模一节中一样，使用“资产”(Assets)选项卡向下查看茶壶资产的任务。此时，选择贴图任务，然后单击**“+ New File”**。 +首先，从 Desktop 启动 Maya。如果在完成上一节后 Maya 仍保持打开状态，则不需要重新启动。打开 Maya 后，使用**“{% include product %} > File Open...”**菜单项打开 Workfiles 应用。与建模一节中一样，使用“资产”(Assets)选项卡向下查看茶壶资产的任务。此时，选择贴图任务，然后单击**“+ New File”**。 {% include figure src="./images/tutorial/image_21.png" width="450px" %} -您现在已进入茶壶的贴图任务。验证您是否在正确的制作环境中的简单方法是检查 Shotgun 菜单中的第一个条目。 +您现在已进入茶壶的贴图任务。验证您是否在正确的制作环境中的简单方法是检查 {% include product %} 菜单中的第一个条目。 {% include figure src="./images/tutorial/image_22.png" %} -接下来，您需要将茶壶模型加载到新的贴图工作文件中。要执行此操作，请通过 Maya 中的**“Shotgun > Load...”**菜单项启动加载器应用。 +接下来，您需要将茶壶模型加载到新的贴图工作文件中。要执行此操作，请通过 Maya 中的**“{% include product %} > Load...”**菜单项启动加载器应用。 {% include figure src="./images/tutorial/image_23.png" %} @@ -283,7 +283,7 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 构建工作流时，着色器的管理可能会是一项耗时并且复杂的任务。通常在很大程度上依赖于每个工作室的具体情况。正因如此，随附的 Maya 集成未提供即时处理着色器或纹理管理的功能。 -可使用**“Shotgun > File Save...”**菜单动作保存当前会话，然后再继续。 +可使用**“{% include product %} > File Save...”**菜单动作保存当前会话，然后再继续。 ### 自定义着色器发布 @@ -445,9 +445,9 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 {% include info title="注意" content="如果在对配置进行自定义时关闭了 Maya，请不要担心。只需重新启动 Maya，并使用“File Open”对话框打开您的贴图工作文件。您可以跳过下面的重新加载步骤。" %} -##### 重新加载 Shotgun 集成 +##### 重新加载 {% include product %} 集成 -为了试验您的自定义项，您需要在 Maya 会话中重新加载集成。为此，请单击**“Shotgun > [任务名称] > Work Area Info…”**菜单动作。 +为了试验您的自定义项，您需要在 Maya 会话中重新加载集成。为此，请单击**“{% include product %} > [任务名称] > Work Area Info…”**菜单动作。 {% include figure src="./images/tutorial/image_30.png" %} @@ -457,14 +457,14 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 ### 发布着色器网络 -现在可以查看更改项目配置的效果。从 Shotgun 菜单启动发布应用。您应该会看到收集的茶壶网格项以及附加的**“Publish Shaders”**插件： +现在可以查看更改项目配置的效果。从 {% include product %} 菜单启动发布应用。您应该会看到收集的茶壶网格项以及附加的**“Publish Shaders”**插件： {% include figure src="./images/tutorial/image_32.png" %} -输入作品说明，并截取已贴图茶壶的缩略图以与已发布的文件关联。最后，单击“Publish”将茶壶着色器导出到磁盘并在 Shotgun 中将文件注册为发布。完成后，请注意，会话发布插件已自动将您的工作文件保存为下一个可用版本。这是 Shotgun 集成支持的所有 DCC 中的默认行为。 +输入作品说明，并截取已贴图茶壶的缩略图以与已发布的文件关联。最后，单击“Publish”将茶壶着色器导出到磁盘并在 {% include product %} 中将文件注册为发布。完成后，请注意，会话发布插件已自动将您的工作文件保存为下一个可用版本。这是 {% include product %} 集成支持的所有 DCC 中的默认行为。 -现在，您可以浏览到 Shotgun 中的茶壶资产以验证是否一切都符合预期。 +现在，您可以浏览到 {% include product %} 中的茶壶资产以验证是否一切都符合预期。 {% include figure src="./images/tutorial/image_33.png" %} @@ -476,9 +476,9 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 ## 装配工作流 -此时，您应该可以非常轻松地使用 Shotgun 提供的 Workfiles 和“发布”应用打开（或创建）、保存和发布工作文件。此外，您还曾使用加载器应用加载来自上游的发布。使用所学内容完成以下任务： +此时，您应该可以非常轻松地使用 {% include product %} 提供的 Workfiles 和“发布”应用打开（或创建）、保存和发布工作文件。此外，您还曾使用加载器应用加载来自上游的发布。使用所学内容完成以下任务： -* 从 Shotgun Desktop 启动 Maya +* 从 {% include product %} Desktop 启动 Maya * 在茶壶资产的装配工序中创建一个新工作文件 @@ -488,7 +488,7 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 * 保存和发布茶壶装配 -在 Shotgun 中最后的结果应与下图类似： +在 {% include product %} 中最后的结果应与下图类似： {% include figure src="./images/tutorial/image_35.png" %} @@ -496,7 +496,7 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 {% include figure src="./images/tutorial/image_36.png" %} -在茶壶的装配工序中重新打开工作文件（通过**“Shotgun > File Open...”**）。现在，启动**“Shotgun > Scene Breakdown...”**菜单动作。这将启动细分应用，该应用将显示您在工作文件中引用的所有上游发布。在本示例中，只有上游茶壶模型。您应当看到与下图类似的效果： +在茶壶的装配工序中重新打开工作文件（通过**“{% include product %} > File Open...”**）。现在，启动**“{% include product %} > Scene Breakdown...”**菜单动作。这将启动细分应用，该应用将显示您在工作文件中引用的所有上游发布。在本示例中，只有上游茶壶模型。您应当看到与下图类似的效果： {% include figure src="./images/tutorial/image_37.png" width="400px" %} @@ -518,7 +518,7 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 首先，使用在前面各节中所学内容完成以下任务： -* 从 Shotgun Desktop 启动 Maya +* 从 {% include product %} Desktop 启动 Maya * 在镜头的布局工序中创建一个新工作文件（提示：使用加载器中的“镜头”(Shots)选项卡） @@ -530,7 +530,7 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 {% include figure src="./images/tutorial/image_41.gif" %} -当您对自己的镜头布局满意后，通过**“Shotgun > File Save...”**菜单动作保存文件。如果此时继续操作并发布，您只会看到整个 Maya 会话是一个要发布的可用项。 +当您对自己的镜头布局满意后，通过**“{% include product %} > File Save...”**菜单动作保存文件。如果此时继续操作并发布，您只会看到整个 Maya 会话是一个要发布的可用项。 我们要添加一项简单自定义，这也是可为工作流带来很大灵活性的自定义，那就是将独立摄影机发布为可轻松导入其他软件包的文件格式的功能。通过此功能，您可以生成一次摄影机（通常在布局中），然后让所有其他工作流工序（如动画、照明和合成）直接使用它。 @@ -628,11 +628,11 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 {% include figure src="./images/tutorial/image_45.png" %} -如图中所示，收集了新摄影机项并附加了发布插件。继续操作并单击**“Publish”**将摄影机写入磁盘，然后向 Shotgun 注册该摄影机。 +如图中所示，收集了新摄影机项并附加了发布插件。继续操作并单击**“Publish”**将摄影机写入磁盘，然后向 {% include product %} 注册该摄影机。 {% include info title="注意" content="与 Alembic 导出类似，摄影机发布插件需要加载 FBX 导出插件。如果您没有看到摄影机发布插件项，请确保 FBX 插件已加载，然后重新启动发布器。" %} -在 Shotgun 中您应当看到与下图类似的效果： +在 {% include product %} 中您应当看到与下图类似的效果： {% include figure src="./images/tutorial/image_46.png" %} @@ -644,7 +644,7 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 使用在前面各节中所学内容完成以下任务。 -* 从 Shotgun Desktop 启动 Maya +* 从 {% include product %} Desktop 启动 Maya * 在镜头的动画工序中创建一个新工作文件 @@ -662,7 +662,7 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 **`FBX Camera: [reference, import]`** -在自定义摄影机发布插件中，Maya 中的 **`FBXExport`** MEL 命令用于将摄影机写入磁盘，用于向 Shotgun 注册文件的发布类型是 **`FBX Camera`**。您添加到设置的行告诉加载器，对于类型为 **`FBX Camera`** 的任何发布，显示 **`reference`** 和 **`import`** 动作。这些动作在加载器应用的 [tk-maya-actions.py](https://github.com/shotgunsoftware/tk-multi-loader2/blob/master/hooks/tk-maya_actions.py) 挂钩中定义。以某种方式执行这些动作以处理 Maya 可以引用或导入的任何类型的文件。自定义插件生成的 **`.fbx`** 文件属于该类别，因此，为了能够加载已发布的摄影机，这是唯一要做的更改。 +在自定义摄影机发布插件中，Maya 中的 **`FBXExport`** MEL 命令用于将摄影机写入磁盘，用于向 {% include product %} 注册文件的发布类型是 **`FBX Camera`**。您添加到设置的行告诉加载器，对于类型为 **`FBX Camera`** 的任何发布，显示 **`reference`** 和 **`import`** 动作。这些动作在加载器应用的 [tk-maya-actions.py](https://github.com/shotgunsoftware/tk-multi-loader2/blob/master/hooks/tk-maya_actions.py) 挂钩中定义。以某种方式执行这些动作以处理 Maya 可以引用或导入的任何类型的文件。自定义插件生成的 **`.fbx`** 文件属于该类别，因此，为了能够加载已发布的摄影机，这是唯一要做的更改。 现在应用设置应如下所示： @@ -688,7 +688,7 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 首先，使用在前面各节中所学内容完成以下任务。 -* 从 Shotgun Desktop 启动 Maya +* 从 {% include product %} Desktop 启动 Maya * 在镜头的照明工序中创建一个新工作文件 @@ -783,11 +783,11 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 {% include info title="注意" content="如您所见，茶壶和桌子资产的贴图存在问题。对于本教程而言，假定这些是有意做出的艺术效果。如果您想要解决这些问题，可以始终加载这些资产的贴图工作文件，调整着色器并重新发布它们。如果这么做，请记得更新照明工作文件中的引用并重新渲染。如果您执行这些步骤，可能会发现，在重新加载引用后，细分应用并不重新连接更新的着色器。根据您修改加载器以挂接着色器引用的经验，您应该能够更新细分应用的场景操作挂钩来添加所需的逻辑。提示：请参见[此文件](https://github.com/shotgunsoftware/tk-multi-breakdown/blob/master/hooks/tk-maya_scene_operations.py#L69) 中的 update 方法。" %} -随附的 Shotgun 集成通过查看文件中定义的渲染层来收集图像序列。完成渲染后，启动发布器。您将看到渲染的序列显示为树中的一项。 +随附的 {% include product %} 集成通过查看文件中定义的渲染层来收集图像序列。完成渲染后，启动发布器。您将看到渲染的序列显示为树中的一项。 {% include figure src="./images/tutorial/image_55.png" %} -继续操作并发布会话和渲染的图像文件序列。在 Shotgun 中您应当看到与下图类似的效果： +继续操作并发布会话和渲染的图像文件序列。在 {% include product %} 中您应当看到与下图类似的效果： {% include figure src="./images/tutorial/image_56.png" %} @@ -795,13 +795,13 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 ## 合成工作流 -在本教程的最后一节中，将向您介绍 Nuke 提供的一些默认集成。除了在前面各节中提到的应用之外，您还将了解 Shotgun 可识别的写入节点和一个用于将渲染快速发送给其他人以供审核的应用。 +在本教程的最后一节中，将向您介绍 Nuke 提供的一些默认集成。除了在前面各节中提到的应用之外，您还将了解 {% include product %} 可识别的写入节点和一个用于将渲染快速发送给其他人以供审核的应用。 首先，执行以下步骤来准备工作文件。 -* 从 Shotgun Desktop 启动 Nuke +* 从 {% include product %} Desktop 启动 Nuke -* 与在 Maya 中一样，使用“Shotgun > File Open…”菜单动作在镜头的合成工序中创建一个新工作文件。 +* 与在 Maya 中一样，使用“{% include product %} > File Open…”菜单动作在镜头的合成工序中创建一个新工作文件。 通过加载器应用加载在上一节中渲染并发布的图像序列。 @@ -814,40 +814,40 @@ Maya 加载完毕后，将会显示“File Open”对话框。在此对话框中 {% include figure src="./images/tutorial/image_58.png" %} -当您对自己的合成满意后，使用**“Shotgun > File Save…”**菜单动作保存工作文件。 +当您对自己的合成满意后，使用**“{% include product %} > File Save…”**菜单动作保存工作文件。 -然后，单击 Nuke 的左侧菜单中的 Shotgun 标识。在该菜单中单击一个 Shotgun 可识别的写入节点： +然后，单击 Nuke 的左侧菜单中的 {% include product %} 标识。在该菜单中单击一个 {% include product %} 可识别的写入节点： {% include figure src="./images/tutorial/image_59.png" width="400px" %} -Shotgun 写入节点应用在内置 Nuke 写入节点之上提供了一层，它会基于当前 Shotgun 上下文自动得出输出路径。 +{% include product %} 写入节点应用在内置 Nuke 写入节点之上提供了一层，它会基于当前 {% include product %} 上下文自动得出输出路径。 {% include figure src="./images/tutorial/image_60.png" %} -将图像帧渲染到磁盘。您现在可以发布 Nuke 会话以将工作文件与渲染的图像关联。默认情况下，发布器将收集渲染的帧并附加一个插件以向 Shotgun 注册帧。另一个插件将通过一个在后台运行的名为审核提交的集成上传帧以供审核。此应用使用 Nuke 生成将上传并提交供审核的 QuickTime 影片。 +将图像帧渲染到磁盘。您现在可以发布 Nuke 会话以将工作文件与渲染的图像关联。默认情况下，发布器将收集渲染的帧并附加一个插件以向 {% include product %} 注册帧。另一个插件将通过一个在后台运行的名为审核提交的集成上传帧以供审核。此应用使用 Nuke 生成将上传并提交供审核的 QuickTime 影片。 {% include figure src="./images/tutorial/image_61.png" %} -另一个有用的集成是快速审核应用。这是一个输出节点，该节点将快速生成 QuickTime 影片并将其上传到 Shotgun 以供审核。该应用位于左侧菜单中 Shotgun 写入节点旁边。 +另一个有用的集成是快速审核应用。这是一个输出节点，该节点将快速生成 QuickTime 影片并将其上传到 {% include product %} 以供审核。该应用位于左侧菜单中 {% include product %} 写入节点旁边。 {% include figure src="./images/tutorial/image_62.png" width="400px" %} -创建一个快速审核节点，然后单击“上传”(Upload)按钮以将输入渲染到磁盘、生成 QuickTime 影片，并将结果上传到 Shotgun 以供审核。提交帧时，有一些标准选项可供选择。 +创建一个快速审核节点，然后单击“上传”(Upload)按钮以将输入渲染到磁盘、生成 QuickTime 影片，并将结果上传到 {% include product %} 以供审核。提交帧时，有一些标准选项可供选择。 {% include figure src="./images/tutorial/image_63.png" %} -在 Shotgun 中检查“媒体”(Media)选项卡以查看两个上传的 QuickTime 影片。 +在 {% include product %} 中检查“媒体”(Media)选项卡以查看两个上传的 QuickTime 影片。 {% include figure src="./images/tutorial/image_64.png" %} -有关在 Shotgun 中审核媒体的详细信息，请参见[官方文档](https://support.shotgunsoftware.com/hc/zh-cn/sections/204245448)。 +有关在 {% include product %} 中审核媒体的详细信息，请参见[官方文档](https://support.shotgunsoftware.com/hc/zh-cn/sections/204245448)。 # 总结 -祝贺您，您已完成本教程！我们希望本教程能为您使用 Shotgun 集成打造自己的自定义工作流奠定良好的基础。学完本教程，您应该能够了解如何根据自己工作室的特定需求扩展默认的集成。 +祝贺您，您已完成本教程！我们希望本教程能为您使用 {% include product %} 集成打造自己的自定义工作流奠定良好的基础。学完本教程，您应该能够了解如何根据自己工作室的特定需求扩展默认的集成。 在 [shotgun-dev Google 组](https://groups.google.com/a/shotgunsoftware.com/forum/#!forum/shotgun-dev)中提出问题，了解其他工作室如何使用 Toolkit。请订阅以查看最新的帖子！ 如果您认为默认的集成未涵盖某些功能或工作流，可以随时编写自己的应用。[这里是一份详实的文档](https://support.shotgunsoftware.com/hc/zh-cn/articles/219033158)，可帮助您开始编写您的第一个应用。 -与以往一样，如果您对本教程或者 Shotgun 或 Toolkit 平台的一般使用有其他疑问，请随时[提交工单](https://support.shotgunsoftware.com/hc/zh-cn/requests/new)。 +与以往一样，如果您对本教程或者 {% include product %} 或 Toolkit 平台的一般使用有其他疑问，请随时[提交工单](https://support.shotgunsoftware.com/hc/zh-cn/requests/new)。 diff --git a/docs/zh_CN/guides/review/integrations.md b/docs/zh_CN/guides/review/integrations.md index 0f89742eb..3460ed424 100644 --- a/docs/zh_CN/guides/review/integrations.md +++ b/docs/zh_CN/guides/review/integrations.md @@ -7,6 +7,6 @@ lang: zh_CN # RV 集成 -除了 Shotgun 集成、RV 审片室和 Shotgun 审看等不同的 Shotgun 集成外，RV 还提供适用于 Nuke 和 Maya 的集成工具，但功能集有所不同。 +除了 {% include product %} 集成、RV 审片室和 {% include product %} 审看等不同的 {% include product %} 集成外，RV 还提供适用于 Nuke 和 Maya 的集成工具，但功能集有所不同。 -下面的前两个文档描述了 Nuke 和 Maya 集成的安装和工作流，后两个文档描述了不同的 Shotgun 集成，从而帮助您决定要使用哪种集成。 +下面的前两个文档描述了 Nuke 和 Maya 集成的安装和工作流，后两个文档描述了不同的 {% include product %} 集成，从而帮助您决定要使用哪种集成。 diff --git a/docs/zh_CN/guides/webhooks.md b/docs/zh_CN/guides/webhooks.md index 1fdbf99fe..0a74332f8 100644 --- a/docs/zh_CN/guides/webhooks.md +++ b/docs/zh_CN/guides/webhooks.md @@ -9,7 +9,7 @@ lang: zh_CN {% include info title="Beta" content="Webhook 当前为 Beta 版。如果您想要加入 Beta 版，请发送电子邮件至 [webhooks-beta@shotgunsoftware.com](mailto:webhooks-beta@shotgunsoftware.com)" %} -Webhook 允许向您控制的服务通知 Shotgun 中发生的事件。当您创建 Webhook 时，需指定感兴趣的事件类型，并告诉 Shotgun 在该事件触发后要将数据发送至哪个 URL。Shotgun 中发生相关事件后，会将描述事件的数据的有效负载发送到 Webhook 的 URL。这样就可以构建与 Shotgun 的紧密集成并使工作流的某些部分实现自动化。 +Webhook 允许向您控制的服务通知 {% include product %} 中发生的事件。当您创建 Webhook 时，需指定感兴趣的事件类型，并告诉 {% include product %} 在该事件触发后要将数据发送至哪个 URL。{% include product %} 中发生相关事件后，会将描述事件的数据的有效负载发送到 Webhook 的 URL。这样就可以构建与 {% include product %} 的紧密集成并使工作流的某些部分实现自动化。 ## 有哪些示例说明 Webhook 的用法？ @@ -17,7 +17,7 @@ Webhook 允许向您控制的服务通知 Shotgun 中发生的事件。当您创 ### 创建实体后在磁盘上创建目录结构 -我们看到重复出现多次的一个工作流就是，在 Shotgun 中创建新实体后需要在磁盘上创建目录结构。为何不提前准备，确保在 Shotgun 中创建新镜头后即可自动供艺术家使用？ +我们看到重复出现多次的一个工作流就是，在 {% include product %} 中创建新实体后需要在磁盘上创建目录结构。为何不提前准备，确保在 {% include product %} 中创建新镜头后即可自动供艺术家使用？ ### 状态管理自动化 @@ -25,9 +25,9 @@ Webhook 允许向您控制的服务通知 Shotgun 中发生的事件。当您创 另一个说明如何自动进行状态管理的示例是，在创建新的注释后触发任务状态更改。这是一种很好的方法，可以告知艺术家和制作团队，主管在审核会话后已请求更改或修复当前作品。 -## 何时应使用 Webhook，而不是 Shotgun 事件进程？ +## 何时应使用 Webhook，而不是 {% include product %} 事件进程？ -Webhook 和 [Shotgun 事件进程](https://github.com/shotgunsoftware/shotgunEvents/wiki)提供类似的功能，但存在一些关键区别。事件进程要求您运行、监视和维护自己的服务。您的所有代码都必须使用 Python 编写，并且允许您启动自己的 Shotgun 连接。相反，Webhook 会应答连接，并且可以使用任何编程语言编写。它们可以在无服务器环境中托管，例如 [AWS Lambda](https://aws.amazon.com/lambda/)，也可以触发任何在线提供的自动化平台，例如 [Zapier](https://zapier.com) 和 [IFTTT](https://ifttt.com)。如果您的用例用到 Webhook，这应该是首选解决方案。 +Webhook 和 [{% include product %} 事件进程](https://github.com/shotgunsoftware/shotgunEvents/wiki)提供类似的功能，但存在一些关键区别。事件进程要求您运行、监视和维护自己的服务。您的所有代码都必须使用 Python 编写，并且允许您启动自己的 {% include product %} 连接。相反，Webhook 会应答连接，并且可以使用任何编程语言编写。它们可以在无服务器环境中托管，例如 [AWS Lambda](https://aws.amazon.com/lambda/)，也可以触发任何在线提供的自动化平台，例如 [Zapier](https://zapier.com) 和 [IFTTT](https://ifttt.com)。如果您的用例用到 Webhook，这应该是首选解决方案。 ## 创建 Webhook @@ -66,7 +66,7 @@ True ### 验证 SSL 证书 -验证 SSL 证书是一项可选功能，该功能可帮助确保到 Webhook 的使用者 URL 的任何连接的安全性。如果启用，则向 Webhook 的 URL 交付内容时，Shotgun 将使用 OpenSSL 的证书验证例程来验证证书。 +验证 SSL 证书是一项可选功能，该功能可帮助确保到 Webhook 的使用者 URL 的任何连接的安全性。如果启用，则向 Webhook 的 URL 交付内容时，{% include product %} 将使用 OpenSSL 的证书验证例程来验证证书。 ## Webhook 状态 @@ -77,7 +77,7 @@ True | 状态 | 示例 | 说明 | |--------|:-------:|:-----------:| | 活动 | ![活动](./images/webhooks/webhook_status_active.png) | Webhook 运行稳定。在过去 24 小时内，对此 Webhook 进行的交付都已到达其目的地。 | -| 不稳定 | ![不稳定](./images/webhooks/webhook_status_unstable.png) | Webhook 运行不稳定。在过去 24 小时内，某些交付未能到达其目的地，但不足以导致 Shotgun 将 Webhook 视为终止。 | +| 不稳定 | ![不稳定](./images/webhooks/webhook_status_unstable.png) | Webhook 运行不稳定。在过去 24 小时内，某些交付未能到达其目的地，但不足以导致 {% include product %} 将 Webhook 视为终止。 | | 失败 | ![失败](./images/webhooks/webhook_status_failed.png) | Webhook 被视为终止，且不会再尝试交付。这是因为在短时间内出现太多交付失败，且系统已确定不应再将 Webhook 视为可行。**如果在过去 24 小时内出现 10 次交付失败，Webhook 将被视为失败**。 | | 禁用 | ![禁用](./images/webhooks/webhook_status_disabled.png) | Webhook 处于禁用状态，并且在重新启用之前，不会再尝试进行任何交付。 | @@ -101,7 +101,7 @@ True #### 有效负载 -发送到 Webhook URL 的有效负载包含描述在 Shotgun 中发生的事件及其触发者的信息。它以 JSON 格式提供。 +发送到 Webhook URL 的有效负载包含描述在 {% include product %} 中发生的事件及其触发者的信息。它以 JSON 格式提供。 {% include warning title="有效负载大小" content="交付的有效负载最大为 1 MB。Shotgun 中触发的任何导致有效负载超过 1 MB 的事件都将移除其 `new_value` 和 `old_value` 键，并添加一个 `warning` 键，其中包含消息，说明发生了什么、为什么以及如何从 Shotgun 检索完整事件日志条目。" %} @@ -144,11 +144,11 @@ True ##### 会话 UUID -事件有效负载的一部分是在 Shotgun 中触发事件的 `session_uuid`。此值可以提供给 [Shotgun 的 Python API](https://developer.shotgunsoftware.com/python-api/reference.html?highlight=session_uuid#shotgun_api3.shotgun.Shotgun.set_session_uuid)，这将导致具有该 session_uuid 的任何已打开浏览器会话为 API 生成的事件显示更新。 +事件有效负载的一部分是在 {% include product %} 中触发事件的 `session_uuid`。此值可以提供给 [{% include product %} 的 Python API](https://developer.shotgunsoftware.com/python-api/reference.html?highlight=session_uuid#shotgun_api3.shotgun.Shotgun.set_session_uuid)，这将导致具有该 session_uuid 的任何已打开浏览器会话为 API 生成的事件显示更新。 ### 确认 -可以更新交付，使其包含确认。进行交付后，标题将作为请求的一部分提供。标题中包含交付记录的 ID（存储在 `x-sg-delivery-id` 键中）。此 ID 可以用于更新交付记录，以使用 [Shotgun REST API](https://developer.shotgunsoftware.com/rest-api) 包含确认。 +可以更新交付，使其包含确认。进行交付后，标题将作为请求的一部分提供。标题中包含交付记录的 ID（存储在 `x-sg-delivery-id` 键中）。此 ID 可以用于更新交付记录，以使用 [{% include product %} REST API](https://developer.shotgunsoftware.com/rest-api) 包含确认。 {% include warning title="确认大小" content="确认的最大允许大小为 4 KB。" %} @@ -169,7 +169,7 @@ True #### 确认有什么用途？ -确认允许在带外详细报告对 Webhook URL 已成功接收的交付的处理是成功还是失败。这使您可以将从 Shotgun 接收交付的状态与此次交付的关联事件处理成功还是失败分开。通过这种方式，成功交付的事件可以包含其他信息以用于调试。一个很好的示例是在创建资产时触发的 Webhook。如果该 Webhook 的职责是为每个新资产在磁盘上创建目录结构，则 Webhook URL 可以成功接收交付，但由于磁盘或网络故障无法创建关联的目录。然后它可以使用详细的错误消息更新交付记录，说明未创建目录结构及其原因。 +确认允许在带外详细报告对 Webhook URL 已成功接收的交付的处理是成功还是失败。这使您可以将从 {% include product %} 接收交付的状态与此次交付的关联事件处理成功还是失败分开。通过这种方式，成功交付的事件可以包含其他信息以用于调试。一个很好的示例是在创建资产时触发的 Webhook。如果该 Webhook 的职责是为每个新资产在磁盘上创建目录结构，则 Webhook URL 可以成功接收交付，但由于磁盘或网络故障无法创建关联的目录。然后它可以使用详细的错误消息更新交付记录，说明未创建目录结构及其原因。 ## 测试 Webhook diff --git a/docs/zh_CN/quick-answers/administering.md b/docs/zh_CN/quick-answers/administering.md index 582576ab2..dad9909ee 100644 --- a/docs/zh_CN/quick-answers/administering.md +++ b/docs/zh_CN/quick-answers/administering.md @@ -10,11 +10,11 @@ lang: zh_CN 一组与管理和配置 Toolkit 设置相关的快速解答。 -#### Shotgun Desktop： -- [如何使用 Shotgun Desktop 来重新设置 Toolkit 项目？](./administering/resetup-project-with-sg-desktop.md) -- [如何在 Windows 上静默安装 Shotgun Desktop？](./administering/install-desktop-silent.md) -- [如何在 Linux 上为 Shotgun Desktop 设置桌面/启动程序图标？](./administering/create-shotgun-desktop-shortcut.md) -- [如何禁用 Shotgun Desktop 的浏览器集成？](./administering/disable-browser-integration.md) +#### {% include product %} Desktop： +- [如何使用 {% include product %} Desktop 来重新设置 Toolkit 项目？](./administering/resetup-project-with-sg-desktop.md) +- [如何在 Windows 上静默安装 {% include product %} Desktop？](./administering/install-desktop-silent.md) +- [如何在 Linux 上为 {% include product %} Desktop 设置桌面/启动程序图标？](./administering/create-shotgun-desktop-shortcut.md) +- [如何禁用 {% include product %} Desktop 的浏览器集成？](./administering/disable-browser-integration.md) #### 管理您的配置： diff --git a/docs/zh_CN/quick-answers/administering/convert-from-single-root-to-multi.md b/docs/zh_CN/quick-answers/administering/convert-from-single-root-to-multi.md index 8e2708abb..b49332168 100644 --- a/docs/zh_CN/quick-answers/administering/convert-from-single-root-to-multi.md +++ b/docs/zh_CN/quick-answers/administering/convert-from-single-root-to-multi.md @@ -10,19 +10,19 @@ lang: zh_CN 我们提供的默认配置设置为使用单个本地存储根目录（即，所有项目文件都存储在单个根目录点下，如 `/sgtk/projects`）。您可能需要添加新的存储根来存储您的部分项目文件。例如，磁盘空间不足或者某些媒体需要位于更快的存储上时，经常会出现这种情况。 假设您想要添加另一个名为“secondary”的根。以下是您需要执行的步骤： -## 在 Shotgun 中添加本地存储 +## 在 {% include product %} 中添加本地存储 -- 在 Shotgun 中，导航到**“管理 > 站点偏好设置”(Admin > Site Preferences)**页面 +- 在 {% include product %} 中，导航到**“管理 > 站点偏好设置”(Admin > Site Preferences)**页面 - 打开**“文件管理”(File Management)**部分 - 单击**“[+] 添加本地文件存储”([+] Add Local File Storage)** - 填写名称（“secondary”）以及存储根在所有相关平台上的路径。*如果您使用的不是特定平台，只需将其留空。* - 单击页面顶部或底部的**“保存页面”(Save Page)**按钮 -![Shotgun 文件管理首选项](images/shotgun-pref-file-management.png) +![{% include product %} 文件管理首选项](images/shotgun-pref-file-management.png) ## 将新存储根添加到工作流配置中 -Toolkit 在 `config/core/roots.yml` 文件中缓存工作流配置中使用的本地存储相关信息。编辑此文件以添加刚刚在 Shotgun 中创建的新 **secondary** 存储根： +Toolkit 在 `config/core/roots.yml` 文件中缓存工作流配置中使用的本地存储相关信息。编辑此文件以添加刚刚在 {% include product %} 中创建的新 **secondary** 存储根： primary: { linux_path: /mnt/hgfs/sgtk/projects, @@ -89,4 +89,4 @@ Toolkit 在 `config/core/roots.yml` 文件中缓存工作流配置中使用的 {% include info title="注意" content="不需要为使用默认存储根的模板指定 `root_name`。可通过在 `roots.yml` 文件中指定 `default: true` 来指示默认根。如果 `roots.yml` 中未明确定义默认根，名为 **primary** 的根将被视为默认根。" %} -1 *值得注意的是，更新路径可能并不理想，因为一旦设置新值，Toolkit 将无法访问使用先前值创建的旧文件（例如，更改旧工作文件的模板路径后，Toolkit 将找不到这些文件）。如果您担心这一点，可以使用新位置创建新模板（例如，houdini_shot_publish_v2）并升级您的应用以使用该新版本。并非所有应用都会处理诸如此类的回退概念，但这将支持某些应用识别旧文件。这不会影响发布，因为它们始终链接到其在 Shotgun 中的发布。* +1 *值得注意的是，更新路径可能并不理想，因为一旦设置新值，Toolkit 将无法访问使用先前值创建的旧文件（例如，更改旧工作文件的模板路径后，Toolkit 将找不到这些文件）。如果您担心这一点，可以使用新位置创建新模板（例如，houdini_shot_publish_v2）并升级您的应用以使用该新版本。并非所有应用都会处理诸如此类的回退概念，但这将支持某些应用识别旧文件。这不会影响发布，因为它们始终链接到其在 {% include product %} 中的发布。* diff --git a/docs/zh_CN/quick-answers/administering/create-shotgun-desktop-shortcut.md b/docs/zh_CN/quick-answers/administering/create-shotgun-desktop-shortcut.md index 1984eb63f..f1d344ecc 100644 --- a/docs/zh_CN/quick-answers/administering/create-shotgun-desktop-shortcut.md +++ b/docs/zh_CN/quick-answers/administering/create-shotgun-desktop-shortcut.md @@ -5,10 +5,10 @@ pagename: create-shotgun-desktop-shortcut lang: zh_CN --- -# 如何在 Linux 上为 Shotgun Desktop 设置桌面/启动程序图标？ +# 如何在 Linux 上为 {% include product %} Desktop 设置桌面/启动程序图标？ -当前 Shotgun Desktop 安装程序不会自动创建快捷方式和启动条目，因此，您之后必须手动执行此操作。此操作很简单，但可能因您使用的 Linux 版本不同而有所不同。 +当前 {% include product %} Desktop 安装程序不会自动创建快捷方式和启动条目，因此，您之后必须手动执行此操作。此操作很简单，但可能因您使用的 Linux 版本不同而有所不同。 -运行 Shotgun Desktop 安装程序后，Shotgun Desktop 可执行文件将位于 `/opt/Shotgun folder` 中。可执行文件的名称是 Shotgun。 -图标不会随安装程序一起分发。请从 [Shotgun Desktop 插件 github 库](https://github.com/shotgunsoftware/tk-desktop/blob/aac6fe004bd003bf26316b9859bd4ebc42eb82dc/resources/default_systray_icon.png)进行下载。 +运行 {% include product %} Desktop 安装程序后，{% include product %} Desktop 可执行文件将位于 `/opt/Shotgun folder` 中。可执行文件的名称是 Shotgun。 +图标不会随安装程序一起分发。请从 [{% include product %} Desktop 插件 github 库](https://github.com/shotgunsoftware/tk-desktop/blob/aac6fe004bd003bf26316b9859bd4ebc42eb82dc/resources/default_systray_icon.png)进行下载。 下载完图标并获得可执行文件的路径 (`/opt/Shotgun/Shotgun`) 后，请手动创建您可能需要的所有桌面或菜单启动程序。执行此操作的过程因 Linux 版本而异，但通常情况下，您可以在桌面上单击鼠标右键，并在其中寻找合适的菜单选项，从而创建桌面启动程序。 \ No newline at end of file diff --git a/docs/zh_CN/quick-answers/administering/disable-browser-integration.md b/docs/zh_CN/quick-answers/administering/disable-browser-integration.md index eb0b270f6..a34bdc5e6 100644 --- a/docs/zh_CN/quick-answers/administering/disable-browser-integration.md +++ b/docs/zh_CN/quick-answers/administering/disable-browser-integration.md @@ -5,15 +5,15 @@ pagename: disable-browser-integration lang: zh_CN --- -# 如何禁用 Shotgun Desktop 的浏览器集成？ +# 如何禁用 {% include product %} Desktop 的浏览器集成？ 要禁用浏览器集成，请执行以下两个简单的步骤。 1. 在如下位置创建或打开文本文件： - Windows: %APPDATA%\Shotgun\preferences\toolkit.ini - Macosx: ~/Library/Preferences/Shotgun/toolkit.ini - Linux: ~/.shotgun/preferences/toolkit.ini + Windows: %APPDATA%\{% include product %}\preferences\toolkit.ini + Macosx: ~/Library/Preferences/{% include product %}/toolkit.ini + Linux: ~/.{% include product %}/preferences/toolkit.ini 2. 添加以下部分： @@ -24,4 +24,4 @@ lang: zh_CN **替代方法** -如果您已接管 Toolkit 工作流配置，替代方法是[从环境中删除 `tk-shotgun` 插件](https://github.com/shotgunsoftware/tk-config-default2/blob/master/env/project.yml#L48)，使其无法加载任何动作。 \ No newline at end of file +如果您已接管 Toolkit 工作流配置，替代方法是[从环境中删除 `tk-{% include product %}` 插件](https://github.com/shotgunsoftware/tk-config-default2/blob/master/env/project.yml#L48)，使其无法加载任何动作。 \ No newline at end of file diff --git a/docs/zh_CN/quick-answers/administering/install-desktop-silent.md b/docs/zh_CN/quick-answers/administering/install-desktop-silent.md index e91056980..0992dbab6 100644 --- a/docs/zh_CN/quick-answers/administering/install-desktop-silent.md +++ b/docs/zh_CN/quick-answers/administering/install-desktop-silent.md @@ -1,13 +1,13 @@ --- layout: default -title: 如何在 Windows 上静默安装 Shotgun Desktop？ +title: 如何在 Windows 上静默安装 {% include product %} Desktop？ pagename: install-desktop-silent lang: zh_CN --- -# 如何在 Windows 上静默安装 Shotgun Desktop？ +# 如何在 Windows 上静默安装 {% include product %} Desktop？ -要以静默方式运行 Shotgun Desktop 安装程序，只需按以下方法启动 Shotgun Desktop 安装程序： +要以静默方式运行 {% include product %} Desktop 安装程序，只需按以下方法启动 {% include product %} Desktop 安装程序： `ShotgunInstaller_Current.exe /S` diff --git a/docs/zh_CN/quick-answers/administering/move-configuration-location.md b/docs/zh_CN/quick-answers/administering/move-configuration-location.md index 55293eb70..775388b38 100644 --- a/docs/zh_CN/quick-answers/administering/move-configuration-location.md +++ b/docs/zh_CN/quick-answers/administering/move-configuration-location.md @@ -9,7 +9,7 @@ lang: zh_CN {% include info title="注意" content="本文档的内容仅适用于[集中式配置设置](https://developer.shotgunsoftware.com/tk-core/initializing.html#centralized-configurations)。[分布式配置](https://developer.shotgunsoftware.com/tk-core/initializing.html#distributed-configurations)在本地缓存到各个客户端计算机，并由 Toolkit 自动管理。" %} -要将工作流配置移动到新位置，最简单的方法是使用 `tank move_configuration` 命令。该命令将移动文件，更新 Shotgun，并更新配置文件以指向新位置。 +要将工作流配置移动到新位置，最简单的方法是使用 `tank move_configuration` 命令。该命令将移动文件，更新 {% include product %}，并更新配置文件以指向新位置。 以下情况下此命令也非常有用：您仅移动单个操作系统的位置，或者以前未使用某个操作系统，但现在想添加该操作系统。Toolkit 将检测需要移动或添加的内容以及不需要移动或添加的内容，同时还会向您显示即将执行的操作，以便您在继续操作之前进行确认。 @@ -27,10 +27,10 @@ lang: zh_CN $ cd /sgtk/software/shotgun/scarlet $ ./tank move_configuration - Welcome to the Shotgun Pipeline Toolkit! + Welcome to the {% include product %} Pipeline Toolkit! For documentation, see https://toolkit.shotgunsoftware.com Starting Toolkit for your current path '/sgtk/software/shotgun/scarlet' - - The path is not associated with any Shotgun object. + - The path is not associated with any {% include product %} object. - Falling back on default project settings. - Using configuration 'Primary' and Core v0.15.22 - Setting the Context to Scarlet. @@ -71,10 +71,10 @@ lang: zh_CN $ cd /sgtk/software/shotgun/scarlet $ ./tank move_configuration "/mnt/hgfs/sgtk/software/shotgun/scarlet_new" "z:\sgtk\software\shotgun\scarlet_new" "/sgtk/software/shotgun/scarlet_new" - Welcome to the Shotgun Pipeline Toolkit! + Welcome to the {% include product %} Pipeline Toolkit! For documentation, see https://toolkit.shotgunsoftware.com Starting toolkit for path '/sgtk/software/shotgun/scarlet' - - The path is not associated with any Shotgun object. + - The path is not associated with any {% include product %} object. - Falling back on default project settings. - Using configuration 'Primary' and Core v0.15.22 - Setting the Context to Scarlet. @@ -129,7 +129,7 @@ lang: zh_CN Copying /sgtk/software/shotgun/scarlet/install/frameworks... Copying /sgtk/software/shotgun/scarlet/install/frameworks/app_store... Updating cached locations in /sgtk/software/shotgun/scarlet_new/config/core/install_location.yml... - Updating Shotgun Configuration Record... + Updating {% include product %} Configuration Record... Deleting original configuration files... All done! Your configuration has been successfully moved. @@ -151,7 +151,7 @@ lang: zh_CN 更新此文件中的路径，以指向工作流配置在所有适用平台上的新位置。如果您未使用平台，请输入空字符串 `''` - # Shotgun Pipeline Toolkit configuration file + # {% include product %} Pipeline Toolkit configuration file # This file was automatically created by setup_project # This file reflects the paths in the primary pipeline @@ -162,9 +162,9 @@ lang: zh_CN # End of file. -3. 在 Shotgun 中找到与此项目对应的 PipelineConfiguration 实体，并修改“Linux 路径”(Linux Path)、“Mac 路径”(Mac Path)和“Windows 路径”(Windows Path)字段值，以匹配您在上面所做的更改。 +3. 在 {% include product %} 中找到与此项目对应的 PipelineConfiguration 实体，并修改“Linux 路径”(Linux Path)、“Mac 路径”(Mac Path)和“Windows 路径”(Windows Path)字段值，以匹配您在上面所做的更改。 -![Shotgun 中的工作流配置位置。](images/new-pipeline-configuration-locations.png) +![{% include product %} 中的工作流配置位置。](images/new-pipeline-configuration-locations.png) 现在，您的工作流配置应该会在新位置按预期工作。 diff --git a/docs/zh_CN/quick-answers/administering/move-project-directories.md b/docs/zh_CN/quick-answers/administering/move-project-directories.md index f7e59624c..86ba220b7 100644 --- a/docs/zh_CN/quick-answers/administering/move-project-directories.md +++ b/docs/zh_CN/quick-answers/administering/move-project-directories.md @@ -12,11 +12,11 @@ lang: zh_CN 有时，需要将项目文件（场景文件、渲染等）移动到新的根存储位置（例如，从 `/mnt/smalldrive` 移动到 `/mnt/bigdrive/foo`）。无论您使用的单存储配置还是多存储配置，都可以执行此操作。例如，假设要移动名为**“asset_storage”**的存储： - 将项目文件从旧位置复制（或移动）到新位置。 -- 在 Shotgun 中，导航到**“管理 > 站点偏好设置”(Admin > Site Preferences)**页面并打开**“文件管理”(File Management)**部分。 - ![站点偏好设置中的 Shotgun 存储根部分。](./images/shotgun-storage-roots.png) +- 在 {% include product %} 中，导航到**“管理 > 站点偏好设置”(Admin > Site Preferences)**页面并打开**“文件管理”(File Management)**部分。 + ![站点偏好设置中的 {% include product %} 存储根部分。](./images/shotgun-storage-roots.png) - 将含有每个平台路径的“primary”本地文件存储更新为项目文件的新存储。如果您使用的不是特定平台，请将其留空。 - 单击页面顶部或底部的**“保存更改”(Save Changes)**按钮。 -- 更新项目配置中的 `config/core/roots.yml` 文件以匹配刚刚在 Shotgun 中保存的新路径值。 +- 更新项目配置中的 `config/core/roots.yml` 文件以匹配刚刚在 {% include product %} 中保存的新路径值。 Toolkit 将发布路径保存为存储根的相对路径。因此，使用旧存储根时，路径展开为如下所示： @@ -26,7 +26,7 @@ Toolkit 将发布路径保存为存储根的相对路径。因此，使用旧存 [asset-storage]/assets/Character/betty => /mnt/bigdrive/foo/assets/Character/betty -我们不需要担心在 Shotgun 或 Toolkit 中更新任何其他发布信息！ +我们不需要担心在 {% include product %} 或 Toolkit 中更新任何其他发布信息！ {% include warning title="警告" content="上述步骤假设您正在重新指定现有存储根的路径。相反，如果您放弃现有存储根或创建一个新的存储根，则您将需要重新注册您的所有文件夹并重新发布 `PublishedFiles` 实体" %} @@ -36,4 +36,4 @@ Toolkit 将发布路径保存为存储根的相对路径。因此，使用旧存 ## 版本(Versions) -如果 Shotgun 中的版本实体在受此更改影响的“影片路径”(Path to Movie)或“帧路径”(Path to Frames)字段中存储信息，也需要对这些字段进行更新以指向新位置，因为这些字段是包含媒体绝对路径的字符串字段。 \ No newline at end of file +如果 {% include product %} 中的版本实体在受此更改影响的“影片路径”(Path to Movie)或“帧路径”(Path to Frames)字段中存储信息，也需要对这些字段进行更新以指向新位置，因为这些字段是包含媒体绝对路径的字符串字段。 \ No newline at end of file diff --git a/docs/zh_CN/quick-answers/administering/resetup-project-with-sg-desktop.md b/docs/zh_CN/quick-answers/administering/resetup-project-with-sg-desktop.md index de14af6b3..3a223595a 100644 --- a/docs/zh_CN/quick-answers/administering/resetup-project-with-sg-desktop.md +++ b/docs/zh_CN/quick-answers/administering/resetup-project-with-sg-desktop.md @@ -5,16 +5,16 @@ pagename: resetup-project-with-sg-desktop lang: zh_CN --- -# 如何使用 Shotgun Desktop 来重新设置 Toolkit 项目？ +# 如何使用 {% include product %} Desktop 来重新设置 Toolkit 项目？ -如果您已为某个项目设置 Toolkit 配置并且需要重新开始，Shotgun Desktop 中的“高级设置向导”将不允许您重新设置项目，除非已删除以前设置的配置。 +如果您已为某个项目设置 Toolkit 配置并且需要重新开始，{% include product %} Desktop 中的“高级设置向导”将不允许您重新设置项目，除非已删除以前设置的配置。 以下介绍了如何手动删除这些设置： -1. 在 Shotgun 中删除链接到项目的任何 `PipelineConfiguration` 实体。

![访问 PipelineConfiguration 实体页面](images/pipeline-configuration-entity-page.png)

-2. 在 Shotgun 中将 `Project` 实体上的 `Tank Name` 字段设置为空白值。

![清除项目 tank 名称字段](images/clear-project-tank-name.png)

+1. 在 {% include product %} 中删除链接到项目的任何 `PipelineConfiguration` 实体。

![访问 PipelineConfiguration 实体页面](images/pipeline-configuration-entity-page.png)

+2. 在 {% include product %} 中将 `Project` 实体上的 `Tank Name` 字段设置为空白值。

![清除项目 tank 名称字段](images/clear-project-tank-name.png)

3. 删除磁盘上的任何相应工作流配置目录。 -4. 在 Shotgun Desktop 中选择您想设置的项目。如果您已经在查看项目，跳出到项目列表视图，然后再回到您的项目。** +4. 在 {% include product %} Desktop 中选择您想设置的项目。如果您已经在查看项目，跳出到项目列表视图，然后再回到您的项目。** 6. 现在，可以再次运行项目设置过程。 **替代方法** diff --git a/docs/zh_CN/quick-answers/administering/sg-desktop-run-on-ubuntu.md b/docs/zh_CN/quick-answers/administering/sg-desktop-run-on-ubuntu.md index b77b90e8d..8c9cfd656 100644 --- a/docs/zh_CN/quick-answers/administering/sg-desktop-run-on-ubuntu.md +++ b/docs/zh_CN/quick-answers/administering/sg-desktop-run-on-ubuntu.md @@ -5,15 +5,15 @@ pagename: sg-desktop-run-on-ubuntu lang: zh_CN --- -# Shotgun Desktop 能否在 Ubuntu 等 Debian 系统上运行？ +# {% include product %} Desktop 能否在 Ubuntu 等 Debian 系统上运行？ -目前，Shotgun Desktop 不支持基于 Debian 的发行版。 -过去，我们有一些客户曾试图让 Shotgun Desktop 在此类系统上正常运行，使用 cpio 从 RPM 提取 Shotgun Desktop，然后尝试满足库依存关系，但这样导致了较差的结果。有关参考，[请在我们的 dev 组中查看此主题](https://groups.google.com/a/shotgunsoftware.com/d/msg/shotgun-dev/nNBg4CKNBLc/naiGlJowBAAJ)。 +目前，{% include product %} Desktop 不支持基于 Debian 的发行版。 +过去，我们有一些客户曾试图让 {% include product %} Desktop 在此类系统上正常运行，使用 cpio 从 RPM 提取 {% include product %} Desktop，然后尝试满足库依存关系，但这样导致了较差的结果。有关参考，[请在我们的 dev 组中查看此主题](https://groups.google.com/a/shotgunsoftware.com/d/msg/shotgun-dev/nNBg4CKNBLc/naiGlJowBAAJ)。 请注意，我们未提供显式的库依存关系列表，因为 Python 本身位于很多系统级库之上。 目前我们还没有正式的 Debian 支持计划。Ubuntu 构建存在问题，但在更改时需要进行 QA 并支持额外的操作系统，这并不是一件简单的事情。 -如果要手动运行并激活 Toolkit 而不使用 Shotgun Desktop（[如此处文档所述](https://support.shotgunsoftware.com/hc/zh-cn/articles/219033208#Step%208.%20Run%20the%20activation%20script)），请从该文档页面下载 `activate_shotgun_pipeline_toolkit.py` 脚本 - 即手册的第 8 步，单击“单击以下载...”标题。 +如果要手动运行并激活 Toolkit 而不使用 {% include product %} Desktop（[如此处文档所述](https://support.shotgunsoftware.com/hc/zh-cn/articles/219033208#Step%208.%20Run%20the%20activation%20script)），请从该文档页面下载 `activate_shotgun_pipeline_toolkit.py` 脚本 - 即手册的第 8 步，单击“单击以下载...”标题。 diff --git a/docs/zh_CN/quick-answers/administering/what-is-path-cache.md b/docs/zh_CN/quick-answers/administering/what-is-path-cache.md index b7be801f5..ff6c24b48 100644 --- a/docs/zh_CN/quick-answers/administering/what-is-path-cache.md +++ b/docs/zh_CN/quick-answers/administering/what-is-path-cache.md @@ -7,15 +7,15 @@ lang: zh_CN # 什么是缓存路径？什么是文件系统位置？ -缓存路径由 Toolkit 用来跟踪磁盘上的文件夹与 Shotgun 中的实体之间的关联。 -主缓存以 `FilesystemLocation` 实体类型形式存储在 Shotgun 中。 之后，每个用户都有自己的缓存路径版本，该版本[存储在磁盘本地的 Toolkit 缓存目录中](./where-is-my-cache.md)，它将随着应用程序的启动或文件夹的创建而在后台进行同步。 +缓存路径由 Toolkit 用来跟踪磁盘上的文件夹与 {% include product %} 中的实体之间的关联。 +主缓存以 `FilesystemLocation` 实体类型形式存储在 {% include product %} 中。 之后，每个用户都有自己的缓存路径版本，该版本[存储在磁盘本地的 Toolkit 缓存目录中](./where-is-my-cache.md)，它将随着应用程序的启动或文件夹的创建而在后台进行同步。 -通常情况下，我们建议不要手动修改缓存路径。我们的内部流程不仅使本地缓存与 Shotgun 中的 FilesystemLocation 实体同步，而且还创建事件日志条目，从而使所有用户的计算机都能与 Shotgun 保持同步。 +通常情况下，我们建议不要手动修改缓存路径。我们的内部流程不仅使本地缓存与 {% include product %} 中的 FilesystemLocation 实体同步，而且还创建事件日志条目，从而使所有用户的计算机都能与 {% include product %} 保持同步。 有几个 tank 命令可用于修改缓存路径： - `tank unregister_folders`   移除缓存路径关联。 -- `tank synchronize_folders`   强制使本地缓存路径与 Shotgun 同步。 +- `tank synchronize_folders`   强制使本地缓存路径与 {% include product %} 同步。 通常情况下，您不需要运行这些命令，但在某些情况下，它们可能会很有用。 例如，在项目中重命名或重新创建实体之前，应该运行 `unregister_folders`。 \ No newline at end of file diff --git a/docs/zh_CN/quick-answers/administering/where-is-my-cache.md b/docs/zh_CN/quick-answers/administering/where-is-my-cache.md index 4bd534ab4..156945f41 100644 --- a/docs/zh_CN/quick-answers/administering/where-is-my-cache.md +++ b/docs/zh_CN/quick-answers/administering/where-is-my-cache.md @@ -10,7 +10,7 @@ lang: zh_CN ## 缓存根位置 -Toolkit 将某些数据存储在本地缓存中，以防止向 Shotgun 服务器进行不必要的调用。这包括[缓存路径](./what-is-path-cache.md)、包缓存和缩略图。虽然默认位置应该适用于大多数用户，但如果您需要更改它，可以使用 [cache_location 核心挂钩](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/cache_location.py)对其进行配置。 +Toolkit 将某些数据存储在本地缓存中，以防止向 {% include product %} 服务器进行不必要的调用。这包括[缓存路径](./what-is-path-cache.md)、包缓存和缩略图。虽然默认位置应该适用于大多数用户，但如果您需要更改它，可以使用 [cache_location 核心挂钩](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/cache_location.py)对其进行配置。 默认缓存根位置为： @@ -36,7 +36,7 @@ Toolkit 将某些数据存储在本地缓存中，以防止向 Shotgun 服务器 **分布式配置** -包缓存是在 Shotgun 站点的所有项目中使用的所有应用程序、插件和框架的缓存集合。 分布式配置的包缓存存储在以下位置： +包缓存是在 {% include product %} 站点的所有项目中使用的所有应用程序、插件和框架的缓存集合。 分布式配置的包缓存存储在以下位置： Mac： `~/Library/Caches/Shotgun/bundle_cache` diff --git a/docs/zh_CN/quick-answers/developing/create-publishes-via-api.md b/docs/zh_CN/quick-answers/developing/create-publishes-via-api.md index 5ba8c7a5d..caf44736f 100644 --- a/docs/zh_CN/quick-answers/developing/create-publishes-via-api.md +++ b/docs/zh_CN/quick-answers/developing/create-publishes-via-api.md @@ -7,16 +7,16 @@ lang: zh_CN # 如何通过 API 创建发布？ -我们的 sgtk API 提供了一种在 Shotgun 中注册 `PublishedFiles` 实体的[便捷方法](https://developer.shotgunsoftware.com/tk-core/utils.html#sgtk.util.register_publish)。 +我们的 sgtk API 提供了一种在 {% include product %} 中注册 `PublishedFiles` 实体的[便捷方法](https://developer.shotgunsoftware.com/tk-core/utils.html#sgtk.util.register_publish)。 此外，我们还提供 Publish 应用（附带[自己的 API](https://developer.shotgunsoftware.com/tk-multi-publish2/)）。 发布 API 最终使用核心 sgtk API 方法来注册 PublishedFile，但它还会围绕集合、验证和发布提供一个可自定义的框架。除了发布 API 文档外，我们还在[工作流教程](https://developer.shotgunsoftware.com/zh_CN/cb8926fc/)中举例说明了如何编写自己的发布插件。 ## 使用 register_publish() API 方法 -虽然可以使用原始 Shotgun API 调用在 Shotgun 中创建发布记录，但是我们强烈建议使用 Toolkit 的便捷方法。 +虽然可以使用原始 {% include product %} API 调用在 {% include product %} 中创建发布记录，但是我们强烈建议使用 Toolkit 的便捷方法。 创建发布的所有 Toolkit 应用都使用称为 [`sgtk.util.register_publish()`](http://developer.shotgunsoftware.com/tk-core/utils.html#sgtk.util.register_publish) 的 API 实用程序方法。 -基本上来说，此方法会在 Shotgun 中创建一个新的 PublishedFile 实体，并尝试使用 Toolkit 概念简化操作过程。您的代码应该与下面类似： +基本上来说，此方法会在 {% include product %} 中创建一个新的 PublishedFile 实体，并尝试使用 Toolkit 概念简化操作过程。您的代码应该与下面类似： ```python # Get access to the Toolkit API diff --git a/docs/zh_CN/quick-answers/developing/setting-software-environment-variables.md b/docs/zh_CN/quick-answers/developing/setting-software-environment-variables.md index 11412a899..4cd2abffb 100644 --- a/docs/zh_CN/quick-answers/developing/setting-software-environment-variables.md +++ b/docs/zh_CN/quick-answers/developing/setting-software-environment-variables.md @@ -7,9 +7,9 @@ lang: zh_CN # 如何在启动软件之前设置环境变量？ -Shotgun Toolkit 允许您在启动过程中使用挂钩来配置环境并运行自定义代码。 +{% include product %} Toolkit 允许您在启动过程中使用挂钩来配置环境并运行自定义代码。 -通过 Shotgun Desktop 或浏览器集成启动软件（如 Nuke 或 Maya）时，将运行 `tk-multi-launchapp`。此应用负责启动软件并确保 Shotgun 集成按预期启动。在此过程中将通过挂钩公开两个点以允许运行自定义代码。 +通过 {% include product %} Desktop 或浏览器集成启动软件（如 Nuke 或 Maya）时，将运行 `tk-multi-launchapp`。此应用负责启动软件并确保 {% include product %} 集成按预期启动。在此过程中将通过挂钩公开两个点以允许运行自定义代码。 ## before_app_launch.py diff --git a/docs/zh_CN/quick-answers/developing/setting_software_environment_variables.md b/docs/zh_CN/quick-answers/developing/setting_software_environment_variables.md deleted file mode 100644 index 5d5786f3f..000000000 --- a/docs/zh_CN/quick-answers/developing/setting_software_environment_variables.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: default -title: 如何在启动软件之前设置环境变量？ -pagename: setting_software_environment_variables -lang: zh_CN ---- - -# 如何在启动软件之前设置环境变量？ - -Shotgun Toolkit 允许您在启动过程中使用挂钩来配置环境并运行自定义代码。 - -通过 Shotgun Desktop 或浏览器集成启动软件（如 Nuke 或 Maya）时，将运行 `tk-multi-launchapp`。此应用负责启动软件并确保 Shotgun 集成按预期启动。在此过程中将通过挂钩公开两个点以允许运行自定义代码。 - -## before_app_launch.py - -软件启动前将调用 [`before_app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/6a884aa144851148e8369e9f35a2471087f98d16/hooks/before_app_launch.py) 挂钩。这提供了一个绝佳机会来设置任何自定义环境变量以传递给启动的软件。 - -示例： - -```python -import os -import tank - -class BeforeAppLaunch(tank.Hook): - - def execute(self, app_path, app_args, version, engine_name, **kwargs): - - if engine_name == "tk-maya": - os.environ["MY_CUSTOM_MAYA_ENV_VAR"] = "Some Maya specific setting" -``` - -{% include warning title="警告" content="请注意，不要完全重新定义 Shotgun 设置的环境变量。例如，如果需要将路径添加到 `NUKE_PATH`（对于 Nuke）或 `PYTHONPATH`（对于 Maya）中，请确保将您的路径附加到现有值，而不是将其替换。您可以使用便捷方法实现此目的： - -```python -tank.util.append_path_to_env_var(\"NUKE_PATH\", \"/my/custom/path\") -``` -" %} - -## 自定义封装器 - -某些工作室具有自定义封装器，支持设置环境变量和启动软件。如果您更愿意使用像这样的自定义代码设置环境，可以将 `Software` 实体的[路径字段](https://support.shotgunsoftware.com/hc/zh-cn/articles/115000067493-Integrations-Admin-Guide#Example:%20Add%20your%20own%20Software)指向可执行封装器，此时将改为由 `tk-multi-launchapp` 运行。 - -{% include warning title="警告" content="请谨慎使用此方法以保留 Shotgun 设置的环境变量，否则集成将无法启动。" %} \ No newline at end of file diff --git a/docs/zh_CN/quick-answers/developing/toolkit-core-event-daemon.md b/docs/zh_CN/quick-answers/developing/toolkit-core-event-daemon.md index c6aad0b45..dd6c56812 100644 --- a/docs/zh_CN/quick-answers/developing/toolkit-core-event-daemon.md +++ b/docs/zh_CN/quick-answers/developing/toolkit-core-event-daemon.md @@ -1,6 +1,6 @@ --- layout: default -title: 如何使用 Shotgun Event 进程加载不同的 Toolkit 核心模块？ +title: 如何使用 {% include product %} Event 进程加载不同的 Toolkit 核心模块？ pagename: toolkit-core-event-daemon lang: zh_CN --- @@ -13,7 +13,7 @@ lang: zh_CN Toolkit 的 sgtk API 以项目为中心。换句话说，您必须专门从要使用它的项目导入此 API。这意味着，如果您在单个 Python 会话中对多个项目使用 sgtk API 操作，您将会遇到问题，因为 Python 仅允许具有相同名称的模块导入一次。 -如果您使用的是 [Shotgun Event 进程](https://github.com/shotgunsoftware/shotgunEvents)，您可能需要在特定事件对应的插件内部执行 Toolkit 操作。这并非易事，因为 Python 仅导入一次模块。因此，如果您在第一次运行该插件时导入了用于项目 A 的 Toolkit 核心 API，则在此进程的使用周期内将始终导入该版本。这意味着，如果分派给该插件的下一个事件用于项目 B，则当您尝试使用来自项目 A 的核心 API 实例化用于项目 B 的新 Toolkit 对象时，可能会发生错误。 +如果您使用的是 [{% include product %} Event 进程](https://github.com/shotgunsoftware/shotgunEvents)，您可能需要在特定事件对应的插件内部执行 Toolkit 操作。这并非易事，因为 Python 仅导入一次模块。因此，如果您在第一次运行该插件时导入了用于项目 A 的 Toolkit 核心 API，则在此进程的使用周期内将始终导入该版本。这意味着，如果分派给该插件的下一个事件用于项目 B，则当您尝试使用来自项目 A 的核心 API 实例化用于项目 B 的新 Toolkit 对象时，可能会发生错误。 **使用集中式配置时的问题示例：** diff --git a/docs/zh_CN/quick-answers/troubleshooting.md b/docs/zh_CN/quick-answers/troubleshooting.md index 4b2e75fc9..d0e1ab8ef 100644 --- a/docs/zh_CN/quick-answers/troubleshooting.md +++ b/docs/zh_CN/quick-answers/troubleshooting.md @@ -19,14 +19,14 @@ lang: zh_CN - [解决与 Python API 相关的 SSL: CERTIFICATE_VERIFY_FAILED 问题](./troubleshooting/fix-ssl-certificate-verify-failed.md) #### 软件集成。 -- [为什么我的 Houdini Shotgun 集成没有启动？](./troubleshooting/houdini-integrations-not-starting.md) -- [我已从 Shotgun Desktop 启动 Nuke/Maya 等，但 Shotgun 菜单中缺少相关条目](./troubleshooting/menu-entries-missing-in-launched-dcc.md) +- [为什么我的 Houdini {% include product %} 集成没有启动？](./troubleshooting/houdini-integrations-not-starting.md) +- [我已从 {% include product %} Desktop 启动 Nuke/Maya 等，但 {% include product %} 菜单中缺少相关条目](./troubleshooting/menu-entries-missing-in-launched-dcc.md) - [当我设置 NUKE_PATH 环境变量时为什么 Nuke 集成无法启动？](./troubleshooting/nuke-path-environment-variable.md) - [安装两种扩展时的 Photoshop 集成疑难解答](./troubleshooting/two-photoshop-shotgun-extensions.md) -- [使用 Shotgun Toolkit 时，为什么启动时 3ds Max 发生崩溃？](./troubleshooting/3dsmax-crashes-on-startup.md) +- [使用 {% include product %} Toolkit 时，为什么启动时 3ds Max 发生崩溃？](./troubleshooting/3dsmax-crashes-on-startup.md) #### 浏览器集成 - [我无法通过 Chrome 使用本地文件链接和启动 Toolkit 应用程序](./troubleshooting/cant-use-file-linking-toolkit-app-chrome.md) - [我无法通过 Firefox 使用本地文件链接和启动 Toolkit 应用程序](./troubleshooting/cant-use-file-linking-toolkit-app-firefox.md) -- [无法在 Linux 上启动 Shotgun Desktop/浏览器集成](./troubleshooting/browser-integration-fails-linux.md) +- [无法在 Linux 上启动 {% include product %} Desktop/浏览器集成](./troubleshooting/browser-integration-fails-linux.md) diff --git a/docs/zh_CN/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md b/docs/zh_CN/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md index 931ac9e93..4beaf66af 100644 --- a/docs/zh_CN/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md +++ b/docs/zh_CN/quick-answers/troubleshooting/3dsmax-crashes-on-startup.md @@ -5,9 +5,9 @@ pagename: 3dsmax-crashes-on-startup lang: zh_CN --- -# 使用 Shotgun Toolkit 时，为什么启动时 3ds Max 发生崩溃？ +# 使用 {% include product %} Toolkit 时，为什么启动时 3ds Max 发生崩溃？ -从 Shotgun Desktop 或 Shotgun 网站启动 3ds Max 时，3ds Max 可能会冻结，同时出现一个冻结的白色对话框或者显示以下消息： +从 {% include product %} Desktop 或 {% include product %} 网站启动 3ds Max 时，3ds Max 可能会冻结，同时出现一个冻结的白色对话框或者显示以下消息： Microsoft Visual C++ Runtime Library (Not Responding) Runtime Error! @@ -54,4 +54,4 @@ class BeforeAppLaunch(tank.get_hook_baseclass()): 然后，打开工作流配置中的 `config/env/includes/app_launchers.yml` 并查找 `launch_3dsmax` 条目。您应该将 `hook_before_app_launch: default` 替换为 `hook_before_app_launch: '{config}/before_app_launch.py'`。 -您现在应该能够正常从 Shotgun 和 Shotgun Desktop 启动 3ds Max。如果仍然有问题，请联系 support@shotgunsoftware.com。 +您现在应该能够正常从 {% include product %} 和 {% include product %} Desktop 启动 3ds Max。如果仍然有问题，请联系 support@shotgunsoftware.com。 diff --git a/docs/zh_CN/quick-answers/troubleshooting/browser-integration-fails-linux.md b/docs/zh_CN/quick-answers/troubleshooting/browser-integration-fails-linux.md index 0058a0295..f6f88c671 100644 --- a/docs/zh_CN/quick-answers/troubleshooting/browser-integration-fails-linux.md +++ b/docs/zh_CN/quick-answers/troubleshooting/browser-integration-fails-linux.md @@ -5,9 +5,9 @@ pagename: browser-integration-fails-linux lang: zh_CN --- -# 无法在 Linux 上启动 Shotgun Desktop/浏览器集成 +# 无法在 Linux 上启动 {% include product %} Desktop/浏览器集成 -首次在 Linux 上运行 Shotgun Desktop 时，可能会出现以下错误消息之一。如果出现这些消息，请按照具体错误下方的步骤进行操作，以确定能否解决问题。 +首次在 Linux 上运行 {% include product %} Desktop 时，可能会出现以下错误消息之一。如果出现这些消息，请按照具体错误下方的步骤进行操作，以确定能否解决问题。 如果问题仍存在，请随时发送电子邮件到 support@shotgunsoftware.com 以联系我们。 ### 目录 @@ -51,13 +51,13 @@ libffi.so.5: cannot open shared object file: No such file or directory yum install libffi ``` -如果您已经安装 libffi 但仍无法运行，请尝试创建以下符号链接，然后重新启动 Shotgun Desktop： +如果您已经安装 libffi 但仍无法运行，请尝试创建以下符号链接，然后重新启动 {% include product %} Desktop： ``` sudo ln -s /usr/lib64/libffi.so.6.0.1 /usr/lib64/libffi.so.5 ``` -部分用户报告通过上述操作解决了问题。但其他用户仍存在问题。最新版本的 Shotgun Desktop 添加了与 WebSocket 服务器之间的一些其他依存关系，这是我们目前正在研究的方面。 +部分用户报告通过上述操作解决了问题。但其他用户仍存在问题。最新版本的 {% include product %} Desktop 添加了与 WebSocket 服务器之间的一些其他依存关系，这是我们目前正在研究的方面。 ## 与证书验证失败相关的问题 @@ -71,7 +71,7 @@ certutil: function failed: SEC_ERROR_BAD_DATABASE: security library: bad databas **解决方案** -如果您的计算机上已经安装 Google Chrome，请启动它，然后重新启动 Shotgun Desktop。如果仍有问题，请发送电子邮件到 support@shotgunsoftware.com。 +如果您的计算机上已经安装 Google Chrome，请启动它，然后重新启动 {% include product %} Desktop。如果仍有问题，请发送电子邮件到 support@shotgunsoftware.com。 如果没有安装 Chrome，请打开终端并运行以下命令： @@ -93,7 +93,7 @@ $ certutil -N -d "sql:$HOME/.pki/nssdb" ``` 不要输入任何密码。 -Shotgun Desktop 现在应该能够正常启动。 +{% include product %} Desktop 现在应该能够正常启动。 ## 不兼容的 Qt 版本 diff --git a/docs/zh_CN/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md b/docs/zh_CN/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md index 5799e03c6..0f9786494 100644 --- a/docs/zh_CN/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md +++ b/docs/zh_CN/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-chrome.md @@ -9,7 +9,7 @@ lang: zh_CN ## 概述 -在 Shotgun 中，动作菜单有时不显示可用 Toolkit 应用程序的列表，或者在使用本地文件链接时有时会出错，即使 Shotgun Desktop 正在运行中。 这是 Chrome 中的 Shotgun Desktop 浏览器集成的疑难解答手册，希望对您有所帮助。我们为 [Firefox](./cant-use-file-linking-toolkit-app-firefox.md) 提供单独手册。 +在 {% include product %} 中，动作菜单有时不显示可用 Toolkit 应用程序的列表，或者在使用本地文件链接时有时会出错，即使 {% include product %} Desktop 正在运行中。 这是 Chrome 中的 {% include product %} Desktop 浏览器集成的疑难解答手册，希望对您有所帮助。我们为 [Firefox](./cant-use-file-linking-toolkit-app-firefox.md) 提供单独手册。 - [诊断问题](#diagnosing-the-issue) - [如何快速修复证书问题](#how-to-quickly-fix-certificate-issues) @@ -18,13 +18,13 @@ lang: zh_CN ## 诊断问题 -### Shotgun Desktop 是否正在运行？ +### {% include product %} Desktop 是否正在运行？ 是的，我们知道。 您可能已经检查过了，但我们必须要问一下。:) -### Shotgun Desktop 启动后，您是否重新启动了 Chrome？ +### {% include product %} Desktop 启动后，您是否重新启动了 Chrome？ -如果在允许 Shotgun Desktop 注册证书之前便已启动 Chrome（这种情况仅在首次启动 Shotgun Desktop 时发生，之后将不再出现此问题），Chrome 将会使用过期的证书副本并拒绝连接到 Shotgun Desktop。关闭所有选项卡不一定会关闭 Chrome，因此建议您在地址栏中键入 [chrome://restart](chrome://restart/) 并按 Enter 键。这将确保所有 Chrome 相关进程都会终止，之后 Chrome 便会重新启动。 +如果在允许 {% include product %} Desktop 注册证书之前便已启动 Chrome（这种情况仅在首次启动 {% include product %} Desktop 时发生，之后将不再出现此问题），Chrome 将会使用过期的证书副本并拒绝连接到 {% include product %} Desktop。关闭所有选项卡不一定会关闭 Chrome，因此建议您在地址栏中键入 [chrome://restart](chrome://restart/) 并按 Enter 键。这将确保所有 Chrome 相关进程都会终止，之后 Chrome 便会重新启动。 ### 您是否正在使用防火墙软件？ @@ -32,7 +32,7 @@ lang: zh_CN ### Chrome 是否拒绝证书？ -您可以浏览到 https://localhost:9000 来确认 Chrome 是否接受证书，这是 Shotgun 网站为了执行本地文件链接和启动 Toolkit 应用程序而尝试访问的网址。您通常会看到以下消息： +您可以浏览到 https://localhost:9000 来确认 Chrome 是否接受证书，这是 {% include product %} 网站为了执行本地文件链接和启动 Toolkit 应用程序而尝试访问的网址。您通常会看到以下消息： ![Autobahn Python 消息](images/autobahn-python.png) @@ -44,7 +44,7 @@ lang: zh_CN ## 如何快速修复证书问题 -规避这些问题的最简单方法就是单击**“高级”(ADVANCED)**和**“Proceed to localhost (unsafe)”**。 这样，Chrome 便会知道您还是接受了证书，并允许 Shotgun 网站与 Shotgun Desktop 通信。 +规避这些问题的最简单方法就是单击**“高级”(ADVANCED)**和**“Proceed to localhost (unsafe)”**。 这样，Chrome 便会知道您还是接受了证书，并允许 {% include product %} 网站与 {% include product %} Desktop 通信。 {% include info title="注意" content="这只会启用网络浏览器和 Shotgun Desktop 之间的连接。信任设置可让这两个应用程序之间的通信流动，并不代表信任 Internet 上的任何其他服务器****。遗憾的是，需要在出现问题的每台计算机上重复此过程。如果此方法无法解决问题，或者您认为部署到所有用户过于复杂，建议您采取以下步骤。" %} @@ -54,11 +54,11 @@ lang: zh_CN Chrome 会定期升级其自签名证书的安全性，这些更新有时会破坏我们的浏览器集成。 遗憾的是，这些类型的问题只能通过重新生成证书的 certificate_path 来修复。 -要重新生成证书，可在 Shotgun Desktop 用户菜单的**“高级”(Advanced)**部分下选取**“Regenerate Certificates”**选项。（如果您未看到此选项，请确保更新 `tk-desktop` 插件，以解除对此选项的锁定。） +要重新生成证书，可在 {% include product %} Desktop 用户菜单的**“高级”(Advanced)**部分下选取**“Regenerate Certificates”**选项。（如果您未看到此选项，请确保更新 `tk-desktop` 插件，以解除对此选项的锁定。） -确认您要重新生成证书后，将会弹出一系列对话框，就像您首次生成证书一样。在 Windows 和 macOS 上，系统将提示您更新 Windows 证书存储或 macOS 密钥链两次：一次用来删除旧证书，一次用来注册新证书。在 Linux 上，注册以静默方式完成。 完成后，重新启动 Shotgun Desktop。 +确认您要重新生成证书后，将会弹出一系列对话框，就像您首次生成证书一样。在 Windows 和 macOS 上，系统将提示您更新 Windows 证书存储或 macOS 密钥链两次：一次用来删除旧证书，一次用来注册新证书。在 Linux 上，注册以静默方式完成。 完成后，重新启动 {% include product %} Desktop。 -Shotgun Desktop 完成启动并处于运行状态后，建议您在地址栏中键入 [chrome://restart](chrome://restart/) 来重新启动 Chrome，确保已完全关闭 Chrome 并清空其证书缓存。 +{% include product %} Desktop 完成启动并处于运行状态后，建议您在地址栏中键入 [chrome://restart](chrome://restart/) 来重新启动 Chrome，确保已完全关闭 Chrome 并清空其证书缓存。 如果您的计算机未连接到 Internet，无法下载更新，请联系 support@shotgunsoftware.com。 @@ -98,4 +98,4 @@ Shotgun Desktop 完成启动并处于运行状态后，建议您在地址栏中 ## 其他操作系统的疑难解答 -如果您在其他操作系统上有关于 Shotgun Desktop 集成的问题，请联系我们的[支持团队](https://support.shotgunsoftware.com/hc/zh-cn/requests/new)，以便我们可以为您提供帮助并更新此文章。 \ No newline at end of file +如果您在其他操作系统上有关于 {% include product %} Desktop 集成的问题，请联系我们的[支持团队](https://support.shotgunsoftware.com/hc/zh-cn/requests/new)，以便我们可以为您提供帮助并更新此文章。 \ No newline at end of file diff --git a/docs/zh_CN/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md b/docs/zh_CN/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md index 778eceeac..4caf0b348 100644 --- a/docs/zh_CN/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md +++ b/docs/zh_CN/quick-answers/troubleshooting/cant-use-file-linking-toolkit-app-firefox.md @@ -9,12 +9,12 @@ lang: zh_CN ## 概述 -在 Shotgun 中，动作菜单有时不显示可用 Toolkit 应用程序的列表，或者在使用本地文件链接时有时会出错，即使 Shotgun Desktop 正在运行中。 -这是 Firefox 中的 Shotgun Desktop 浏览器集成的疑难解答手册，希望对您有所帮助。我们为 [Chrome](./cant-use-file-linking-toolkit-app-chrome.md) 提供单独手册。 +在 {% include product %} 中，动作菜单有时不显示可用 Toolkit 应用程序的列表，或者在使用本地文件链接时有时会出错，即使 {% include product %} Desktop 正在运行中。 +这是 Firefox 中的 {% include product %} Desktop 浏览器集成的疑难解答手册，希望对您有所帮助。我们为 [Chrome](./cant-use-file-linking-toolkit-app-chrome.md) 提供单独手册。 ## 诊断问题 -### Shotgun Desktop 是否正在运行？ +### {% include product %} Desktop 是否正在运行？ 是的，我们知道。您可能已经检查过了，但我们必须要问一下。:) @@ -24,7 +24,7 @@ lang: zh_CN ### Firefox 是否拒绝证书？ -您可以浏览到 https://localhost:9000 来确认 Firefox 是否接受证书，这是 Shotgun 网站为了执行本地文件链接和启动 Toolkit 应用程序而尝试访问的网址。您通常会看到以下消息： +您可以浏览到 https://localhost:9000 来确认 Firefox 是否接受证书，这是 {% include product %} 网站为了执行本地文件链接和启动 Toolkit 应用程序而尝试访问的网址。您通常会看到以下消息： ![Autobahn Python 消息](images/autobahn-python.png) @@ -40,9 +40,9 @@ lang: zh_CN ![向 Firefox 添加例外](images/add-exception-firefox.png) -**单击**获取证书**，然后选择**确定安全例外。您可以忽略证书不受信任的消息。这很正常，因为证书是由 Shotgun Desktop 生成的，而不是由证书颁发机构生成。 +**单击**获取证书**，然后选择**确定安全例外。您可以忽略证书不受信任的消息。这很正常，因为证书是由 {% include product %} Desktop 生成的，而不是由证书颁发机构生成。 -您现在应该可以从您的 Shotgun 站点访问本地文件链接和启动 Toolkit 应用程序了。如果在添加例外后仍有问题，请联系我们：support@shotgunsoftware.com。 +您现在应该可以从您的 {% include product %} 站点访问本地文件链接和启动 Toolkit 应用程序了。如果在添加例外后仍有问题，请联系我们：support@shotgunsoftware.com。 ## 如何修复“安全连接失败”问题 diff --git a/docs/zh_CN/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md b/docs/zh_CN/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md index cc2e486b2..b1d71c2a7 100644 --- a/docs/zh_CN/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md +++ b/docs/zh_CN/quick-answers/troubleshooting/fix-ssl-certificate-verify-failed.md @@ -7,7 +7,7 @@ lang: zh_CN # 解决与 Python API 相关的 SSL: CERTIFICATE_VERIFY_FAILED 问题 -Python API 依赖与 API 捆绑在一起且位于计算机上的一组证书才能连接到 Shotgun 使用的各种 Web 服务。遗憾的是，证书颁发机构可能会颁发新证书，而这些证书可能未与 Python API 或操作系统捆绑在一起。 +Python API 依赖与 API 捆绑在一起且位于计算机上的一组证书才能连接到 {% include product %} 使用的各种 Web 服务。遗憾的是，证书颁发机构可能会颁发新证书，而这些证书可能未与 Python API 或操作系统捆绑在一起。 虽然我们的 Python API 附带了截至 2019 年 2 月 21 日的最新证书副本，有一个错误导致 API 无法使用这些证书以向 Amazon S3 执行上传操作，即使您使用的是最新版本的 API 也是如此。有关背景信息，请参见[此 AWS 博客文章](https://aws.amazon.com/blogs/security/how-to-prepare-for-aws-move-to-its-own-certificate-authority/)。要临时解决这种状况，可以尝试以下解决方案。 @@ -34,7 +34,7 @@ Python API 依赖与 API 捆绑在一起且位于计算机上的一组证书才 1. 升级到 Python API **v3.0.39** -2. a. 将 `SHOTGUN_API_CACERTS` 设置为 `/path/to/shotgun_api3/lib/httplib2/cacerts.txt` +2. a. 将 `{% include product %}_API_CACERTS` 设置为 `/path/to/shotgun_api3/lib/httplib2/cacerts.txt` 或 @@ -46,7 +46,7 @@ Python API 依赖与 API 捆绑在一起且位于计算机上的一组证书才 2. 从 [https://github.com/certifi/python-certifi/blob/master/certifi/cacert.pem](ttps://github.com/certifi/python-certifi/blob/master/certifi/cacert.pem) 下载最新的证书列表。 -3. 将 `SHOTGUN_API_CACERTS` 设置为该文件的保存位置。与 Python API 类似，Toolkit 不允许您在创建连接时指定 `ca_certs` 参数。 +3. 将 `{% include product %}_API_CACERTS` 设置为该文件的保存位置。与 Python API 类似，Toolkit 不允许您在创建连接时指定 `ca_certs` 参数。 ### 如果无法更新 Python API 或 Toolkit diff --git a/docs/zh_CN/quick-answers/troubleshooting/houdini-integrations-not-starting.md b/docs/zh_CN/quick-answers/troubleshooting/houdini-integrations-not-starting.md index 521face6c..1f7d9452a 100644 --- a/docs/zh_CN/quick-answers/troubleshooting/houdini-integrations-not-starting.md +++ b/docs/zh_CN/quick-answers/troubleshooting/houdini-integrations-not-starting.md @@ -5,14 +5,14 @@ pagename: houdini-integrations-not-starting lang: zh_CN --- -# 为什么我的 Houdini Shotgun 集成没有启动？ +# 为什么我的 Houdini {% include product %} 集成没有启动？ -本文介绍了 Shotgun 集成在 Houdini 中无法启动的常见原因。在这种情况下，Houdini 从 Shotgun Desktop、Shotgun 网站或 tank 令启动且无错误。 但是，Houdini 启动后，Shotgun 菜单或工具架将不会出现。 +本文介绍了 {% include product %} 集成在 Houdini 中无法启动的常见原因。在这种情况下，Houdini 从 {% include product %} Desktop、{% include product %} 网站或 tank 令启动且无错误。 但是，Houdini 启动后，{% include product %} 菜单或工具架将不会出现。 -通常导致这种情况的原因是，`HOUDINI_PATH` 环境变量已被覆盖，而 Shotgun 依赖于该变量来传递启动脚本路径。 +通常导致这种情况的原因是，`HOUDINI_PATH` 环境变量已被覆盖，而 {% include product %} 依赖于该变量来传递启动脚本路径。 -Houdini 从 Shotgun 启动时，启动应用逻辑会将 Shotgun 引导脚本路径添加到 `HOUDINI_PATH` 环境变量。 但是，如果 Houdini 具有 +Houdini 从 {% include product %} 启动时，启动应用逻辑会将 {% include product %} 引导脚本路径添加到 `HOUDINI_PATH` 环境变量。 但是，如果 Houdini 具有 [houdini.env 文件](http://www.sidefx.com/docs/houdini/basics/config_env.html#setting-environment-variables)，可能会出现此问题。此文件允许用户设置加载 Houdini 时将显示的环境变量，但是此文件中定义的任何值都将覆盖当前会话中已存在的环境变量。 解决此问题的方法是确保在 `HOUDINI_PATH` 环境变量的新定义中包含先前存在的该变量。 @@ -25,7 +25,7 @@ Houdini 从 Shotgun 启动时，启动应用逻辑会将 Shotgun 引导脚本路 HOUDINI_PATH = /example/of/an/existing/path;$HOUDINI_PATH;& -这允许 Shotgun 将值设置为在 Houdini 启动时继续存在。 +这允许 {% include product %} 将值设置为在 Houdini 启动时继续存在。 {% include warning title="注意" content="在 Windows 上我们已经看到是 `$HOUDINI_PATH` 导致问题。有时会尝试引导 Shotgun 集成多次，导致生成如下所示的错误： diff --git a/docs/zh_CN/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md b/docs/zh_CN/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md index fe909c9a0..03272a3b1 100644 --- a/docs/zh_CN/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md +++ b/docs/zh_CN/quick-answers/troubleshooting/menu-entries-missing-in-launched-dcc.md @@ -5,22 +5,22 @@ pagename: menu-entries-missing-in-launched-dcc lang: zh_CN --- -# 我已从 Shotgun Desktop 启动 Nuke/Maya 等，但 Shotgun 菜单中缺少相关条目 +# 我已从 {% include product %} Desktop 启动 Nuke/Maya 等，但 {% include product %} 菜单中缺少相关条目 -在 Shotgun 菜单中显示的动作需根据上下文进行配置。这意味着根据您所处的上下文，可用动作列表可能会有所不同。您之后看到的应用可能与您现在看到的应用不同，因为您处于错误的上下文。 +在 {% include product %} 菜单中显示的动作需根据上下文进行配置。这意味着根据您所处的上下文，可用动作列表可能会有所不同。您之后看到的应用可能与您现在看到的应用不同，因为您处于错误的上下文。 ## 示例 -从 [Shotgun Desktop](https://support.shotgunsoftware.com/hc/zh-cn/articles/219039818) 启动应用程序时，默认进入项目环境中。此环境由工作流配置中位于 `config/env/project.yml` 下的配置文件进行管理。由于用户的大多数工作可能不在此环境中进行，其中并未配置许多应用供您使用。 +从 [{% include product %} Desktop](https://support.shotgunsoftware.com/hc/zh-cn/articles/219039818) 启动应用程序时，默认进入项目环境中。此环境由工作流配置中位于 `config/env/project.yml` 下的配置文件进行管理。由于用户的大多数工作可能不在此环境中进行，其中并未配置许多应用供您使用。 **默认 Maya 项目动作：** -![Shotgun 菜单项目动作](images/shotgun-menu-project-actions.png) +![{% include product %} 菜单项目动作](images/shotgun-menu-project-actions.png) -您可以使用 [Shotgun Workfiles 应用](https://support.shotgunsoftware.com/hc/zh-cn/articles/219033088-Your-Work-Files)选择要处理的资产、镜头或任务。这将加载相应的新环境，这样，更多的应用便会启用 Shotgun 菜单中的菜单项。 +您可以使用 [{% include product %} Workfiles 应用](https://support.shotgunsoftware.com/hc/zh-cn/articles/219033088-Your-Work-Files)选择要处理的资产、镜头或任务。这将加载相应的新环境，这样，更多的应用便会启用 {% include product %} 菜单中的菜单项。 **默认 Maya 资产任务动作：** -![Shotgun 菜单项目动作](images/shotgun-menu-asset-step-actions.png) +![{% include product %} 菜单项目动作](images/shotgun-menu-asset-step-actions.png) 如果您认为您处于正确的环境，但动作仍未显示，则下一步是检查相关[日志](where-are-my-log-files.md)，查看是否存在任何错误。您可能需要[启用调试日志记录](turn-debug-logging-on.md)以获得完整输出。 \ No newline at end of file diff --git a/docs/zh_CN/quick-answers/troubleshooting/nuke-path-environment-variable.md b/docs/zh_CN/quick-answers/troubleshooting/nuke-path-environment-variable.md index c62f782c5..89c6f6253 100644 --- a/docs/zh_CN/quick-answers/troubleshooting/nuke-path-environment-variable.md +++ b/docs/zh_CN/quick-answers/troubleshooting/nuke-path-environment-variable.md @@ -9,7 +9,7 @@ lang: zh_CN 启动 NUKE 时，我们的集成会设置 `NUKE_PATH` 环境变量，以便引导脚本在 NUKE 启动过程中运行。[`tk-multi-launchapp`](https://support.shotgunsoftware.com/hc/zh-cn/articles/219032968-Application-Launcher#Set%20Environment%20Variables%20and%20Automate%20Behavior%20at%20Launch) 在执行 [`before_launch_app.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/6a884aa144851148e8369e9f35a2471087f98d16/hooks/before_app_launch.py) 挂钩之前专门定义了 `NUKE_PATH`。 -如果在启动过程中使用 `os.environ['NUKE_PATH'] = "/my/custom/path"` 等设置此环境变量，Shotgun 集成将无法启动，因为您已从环境变量删除我们的启动脚本路径。 +如果在启动过程中使用 `os.environ['NUKE_PATH'] = "/my/custom/path"` 等设置此环境变量，{% include product %} 集成将无法启动，因为您已从环境变量删除我们的启动脚本路径。 请在 `tank.util` 中使用此功能，以便将路径附加到 `NUKE_PATH` 环境变量，同时保留 Toolkit 引导的路径： diff --git a/docs/zh_CN/quick-answers/troubleshooting/performance-troubleshooting.md b/docs/zh_CN/quick-answers/troubleshooting/performance-troubleshooting.md index 67c09da35..dc7db9ff7 100644 --- a/docs/zh_CN/quick-answers/troubleshooting/performance-troubleshooting.md +++ b/docs/zh_CN/quick-answers/troubleshooting/performance-troubleshooting.md @@ -7,14 +7,14 @@ lang: zh_CN # 性能疑难解答 -您可能会遇到 Toolkit 使用速度变慢的情况。遇到这种情况的原因有很多，从客户端基础设施问题（例如服务器速度或 Internet 连接），到基于配置的问题（Toolkit 或 Shotgun 没有以高性能的方式配置），再到可用于进一步优化的代码领域。 +您可能会遇到 Toolkit 使用速度变慢的情况。遇到这种情况的原因有很多，从客户端基础设施问题（例如服务器速度或 Internet 连接），到基于配置的问题（Toolkit 或 {% include product %} 没有以高性能的方式配置），再到可用于进一步优化的代码领域。 以下是所要检查事项的快速列表，下面我们将详细介绍这些内容： -- 确保您的应用、插件、框架、核心和 Shotgun Desktop [都是最新的](#keeping-up-to-date)。 +- 确保您的应用、插件、框架、核心和 {% include product %} Desktop [都是最新的](#keeping-up-to-date)。 - 确保在常规使用期间没有启用[调试日志记录](./turn-debug-logging-on.md)。 - 仅[创建所需的文件夹](#folder-creation-is-slow)并限制文件夹，以便仅在确实需要这些文件夹时才创建它们。在数据结构中添加太多文件夹会降低速度。 -- 将用户缓存存储在服务器上可能会很慢。通过将 [`SHOTGUN_HOME` 环境变量](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)设置为指向本地驱动器上的位置，来重定向用户的 Shotgun 缓存。 +- 将用户缓存存储在服务器上可能会很慢。通过将 [`{% include product %}_HOME` 环境变量](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)设置为指向本地驱动器上的位置，来重定向用户的 {% include product %} 缓存。 - [配置 Workfiles 和加载器应用](#file-open-file-save-or-the-loader-app-is-slow)以过滤出美工人员不需要的内容。考虑按状态进行过滤，这有助于保持实体列表简短且与美工人员的当前任务相关。 - 检查您是否有任何自定义挂钩，并且它们不会增加额外开销。 @@ -40,13 +40,13 @@ lang: zh_CN ### 缓存位置 -Shotgun Toolkit [将数据缓存到用户的主目录](../administering/where-is-my-cache.md)。此缓存可以包括许多不同的 SQLite 数据库以及缓存的应用和配置。通常，用户的主目录存储在计算机的本地硬盘驱动器上，但是工作室将它们重定向到网络存储是相当常见的。这样做会影响性能，尤其是 SQLite 数据库，这些数据库用于浏览器集成和文件夹创建/查找等。 +{% include product %} Toolkit [将数据缓存到用户的主目录](../administering/where-is-my-cache.md)。此缓存可以包括许多不同的 SQLite 数据库以及缓存的应用和配置。通常，用户的主目录存储在计算机的本地硬盘驱动器上，但是工作室将它们重定向到网络存储是相当常见的。这样做会影响性能，尤其是 SQLite 数据库，这些数据库用于浏览器集成和文件夹创建/查找等。 -如果您的用户目录存储在服务器位置，我们建议使用 [`SHOTGUN_HOME` 环境变量](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)重新指定 Shotgun Toolkit 缓存的路径。`SHOTGUN_HOME` 环境变量用于设置 Toolkit 缓存各种数据的位置，例如包缓存、缩略图、用于快速查找数据和其他内容的 SQLite 数据库。 +如果您的用户目录存储在服务器位置，我们建议使用 [`{% include product %}_HOME` 环境变量](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables)重新指定 {% include product %} Toolkit 缓存的路径。`{% include product %}_HOME` 环境变量用于设置 Toolkit 缓存各种数据的位置，例如包缓存、缩略图、用于快速查找数据和其他内容的 SQLite 数据库。 ### 调试 -您可以在 Shotgun Toolkit 中启用调试日志记录，以便能够从各个进程获取更详细的输出。这在尝试诊断问题时非常有用，但是，调试设置不是设计为在日常使用期间启用的。日志记录输出的增加可能会对性能产生显著影响。 +您可以在 {% include product %} Toolkit 中启用调试日志记录，以便能够从各个进程获取更详细的输出。这在尝试诊断问题时非常有用，但是，调试设置不是设计为在日常使用期间启用的。日志记录输出的增加可能会对性能产生显著影响。 当遇到性能问题时，尤其是本地化到特定计算机或用户的问题时，请先确认未启用[调试日志记录](./turn-debug-logging-on.md)。 @@ -72,21 +72,21 @@ Shotgun Toolkit [将数据缓存到用户的主目录](../administering/where-is {% include info title="注意" content="如果您对分布式配置感兴趣，但担心按计算机下载依赖项，则可以仅集中包缓存，以便在所有用户之间共享。" %} -当使用分布式配置时，用户只需在缓存中找不到相关内容时才下载它，一旦某个用户已下载它，其他用户也能够利用它。为此，您可以在每台计算机上设置 [`SHOTGUN_BUNDLE_CACHE_PATH` 环境变量](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables) 以指向共享位置。 +当使用分布式配置时，用户只需在缓存中找不到相关内容时才下载它，一旦某个用户已下载它，其他用户也能够利用它。为此，您可以在每台计算机上设置 [`{% include product %}_BUNDLE_CACHE_PATH` 环境变量](https://developer.shotgunsoftware.com/tk-core/initializing.html#environment-variables) 以指向共享位置。 ## 启动软件时速度很慢 -您可能会注意到，当启动诸如 Maya、Nuke、Houdini 或其他软件时，启动时间比不带 Shotgun 时要长。这是正常的，它们可能比不带 Shotgun 时稍长片刻，但有时这些时间可能会增加到难以接受的水平（通常取决于我们期望它们在一分钟内启动的软件）。这可能是诊断起来比较棘手的的领域之一，因为启动软件涉及许多过程。 +您可能会注意到，当启动诸如 Maya、Nuke、Houdini 或其他软件时，启动时间比不带 {% include product %} 时要长。这是正常的，它们可能比不带 {% include product %} 时稍长片刻，但有时这些时间可能会增加到难以接受的水平（通常取决于我们期望它们在一分钟内启动的软件）。这可能是诊断起来比较棘手的的领域之一，因为启动软件涉及许多过程。 ### 诊断 首先要做的是弄清楚这是在什么条件下发生的。 -1. **不带 Shotgun 时启动速度慢吗？** - 这似乎是显而易见的，但应注意检查是否仅在带有 Shotgun 的情况下启动软件时才发生该问题。 -2. **不管您使用哪种方法启动，速度都很慢吗？也就是说，如果您从 SG Desktop 启动或使用浏览器集成从 SG 站点启动，情况是否大致相同？** - 如果是从 Shotgun 站点而不是从 SG Desktop 启动很慢，那么这可能是浏览器集成的问题，或者它可能意味着在磁盘上创建文件夹的问题。如果是从项目以外的上下文启动，那么很可能是在磁盘上创建了更多文件夹，所以这可能解释了所花的时间。同样值得注意的是，每次启动软件时，我们都会检查所需的文件夹是否存在。 +1. **不带 {% include product %} 时启动速度慢吗？** - 这似乎是显而易见的，但应注意检查是否仅在带有 {% include product %} 的情况下启动软件时才发生该问题。 +2. **不管您使用哪种方法启动，速度都很慢吗？也就是说，如果您从 SG Desktop 启动或使用浏览器集成从 SG 站点启动，情况是否大致相同？** - 如果是从 {% include product %} 站点而不是从 SG Desktop 启动很慢，那么这可能是浏览器集成的问题，或者它可能意味着在磁盘上创建文件夹的问题。如果是从项目以外的上下文启动，那么很可能是在磁盘上创建了更多文件夹，所以这可能解释了所花的时间。同样值得注意的是，每次启动软件时，我们都会检查所需的文件夹是否存在。 3. **是否在所有项目中都发生？** - 如果不是，那么它很可能特定于配置的设置方式。 4. **是否发生在一天中的特定时刻？** - 如果是，那么这可能表明对基础设施的需求较高，例如在一天的某些时间服务器使用率较高。 5. **是否针对使用的所有计算机/操作系统发生此情况？** - 如果特定计算机速度很慢，则可能是 Toolkit 以外的某些内容导致了问题。那么，首先想到是清除该计算机上的 Toolkit 缓存。不同的操作系统随附不同版本的软件和 Python 软件包，有时可能在特定的内部版本中出现性能问题。具体来说，我们已经看到在 Windows 上使用 Samba (SMB) 共享的性能问题。目前还没有解决此问题的方法，但是如果您正在使用它，那么最好能够意识到这一点。如果您认为该问题仅限于特定的操作系统、Python 软件包或软件版本，请联系我们的[支持团队](https://support.shotgunsoftware.com/hc/en-us/requests/new)，以便他们可以进一步调查。 -6. **是否针对所有用户都发生这种情况？** - 与上文类似，如果是同一台计算机上的其他用户，这个问题可能会消失。在这种情况下，首先清除用户的本地 Shotgun 缓存。此外，请确保没有为正常的生产用途启用调试日志记录，因为这将影响性能。 +6. **是否针对所有用户都发生这种情况？** - 与上文类似，如果是同一台计算机上的其他用户，这个问题可能会消失。在这种情况下，首先清除用户的本地 {% include product %} 缓存。此外，请确保没有为正常的生产用途启用调试日志记录，因为这将影响性能。 7. **启动速度慢局限于特定的应用/软件，还是所有应用/软件的启动速度都异常缓慢？** - 如果特定软件启动缓慢，这可能意味着存在配置问题。可能有必要检查一下，是否有任何自定义挂钩设置为在启动之前或之后运行，这可能会影响性能。启动时使用的常见挂钩是 [`before_app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/master/hooks/before_app_launch.py)、[`app_launch.py`](https://github.com/shotgunsoftware/tk-multi-launchapp/blob/master/hooks/app_launch.py) 和核心挂钩 [`engine_init.py`](https://github.com/shotgunsoftware/tk-core/blob/master/hooks/engine_init.py)。有时也会出现以下情况：发布了更新版本的软件，而我们的集成启动速度突然慢很多。在这种情况下，您应该联系[支持](https://support.shotgunsoftware.com/hc/en-us/requests/new) 以确认他们是否了解这一点，以及是否有任何已知的修复。请提供您使用的软件版本号（如果适用，包括修补程序/Service Pack），以及您正在运行的 TK 插件和核心的版本。 ### 问题是在启动前还是启动后发生？ @@ -98,13 +98,13 @@ Shotgun Toolkit [将数据缓存到用户的主目录](../administering/where-is 通常，不需要查看日志，就可以看到性能问题是在该过程的第一步还是第二步： - 观察软件启动屏幕的启动是否需要很长时间。如果确实如此，则问题可能就在第一步。 -- 看到开始时软件相对较快地启动，但随后变得很慢（在完成初始化并出现 Shotgun 菜单后）。如果是这样，则问题属于第二步。 +- 看到开始时软件相对较快地启动，但随后变得很慢（在完成初始化并出现 {% include product %} 菜单后）。如果是这样，则问题属于第二步。 了解这一点将在接下来的查看日志中对您有所帮助。 ### 检查日志 -现在，您应该知道问题是在启动过程的第一步还是第二步；这将帮助您锁定要查看的日志。日志按插件进行分解，因此，如果问题出现在启动前阶段，那么您需要查看 `tk-desktop.log` 或 `tk-shotgun.log`，具体取决于您是从 SG Desktop 还是 SG 站点启动。 +现在，您应该知道问题是在启动过程的第一步还是第二步；这将帮助您锁定要查看的日志。日志按插件进行分解，因此，如果问题出现在启动前阶段，那么您需要查看 `tk-desktop.log` 或 `tk-{% include product %}.log`，具体取决于您是从 SG Desktop 还是 SG 站点启动。 接下来应该做的是启用调试日志记录。{% include info title="注意" content="如果它已经启用，如[上文所述](#debugging)，这可能会导致运行缓慢，所以您还应该在没有启用它的情况下进行测试" %} 启用调试日志记录后，应清除现有日志，然后重现启动过程。然后，您可以使用日志中的时间戳来查看时间跳转出现在何处。 @@ -115,14 +115,14 @@ Shotgun Toolkit [将数据缓存到用户的主目录](../administering/where-is 2019-05-01 11:28:01,847 [82801 INFO sgtk.env.asset.tk-shotgun.tk-shotgun-folders] 1 Asset processed - Processed 66 folders on disk. -一旦定位了时间跳转，日志行就有望让您了解在该阶段发生了什么，例如它是在文件夹创建期间发生的，还是在试图获取 Shotgun 连接时发生的。 +一旦定位了时间跳转，日志行就有望让您了解在该阶段发生了什么，例如它是在文件夹创建期间发生的，还是在试图获取 {% include product %} 连接时发生的。 不过，阅读日志可能比较麻烦，而且内容并不总是有意义，因此，您可以再次联系[支持](https://support.shotgunsoftware.com/hc/en-us/requests/new)来帮助您完成这一点。 ### 软件启动速度慢的常见原因 |-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Internet 速度慢** | 在需要与 Shotgun 站点连接和通信的 Toolkit 使用的几乎每个方面都会受到 Internet 速度慢的影响。在这种情况下，除了启动软件外，通常还会在其他情况下看到速度问题。但是，如果连接不稳定而不是很慢，那么在启动过程中更有可能遇到性能问题（因为在整个过程中要进行相当多的 Shotgun 通信）。 | +| **Internet 速度慢** | 在需要与 {% include product %} 站点连接和通信的 Toolkit 使用的几乎每个方面都会受到 Internet 速度慢的影响。在这种情况下，除了启动软件外，通常还会在其他情况下看到速度问题。但是，如果连接不稳定而不是很慢，那么在启动过程中更有可能遇到性能问题（因为在整个过程中要进行相当多的 {% include product %} 通信）。 | | **服务器访问速度慢** | 这肯定会影响启动时间。如果使用的是[集中式配置](#centralized-configs-vs-distributed-configs)（即，您的配置存储在中央服务器上），则在读取配置文件时可能会有大量的 I/O。最重要的是，如果启动软件，则会触发在启动软件的上下文中创建文件夹。这意味着，它将检查是否创建了文件夹，如果没有，则创建文件夹。 | | **文件夹创建** | 如上所述，文件夹创建可能是导致速度下降的常见原因。[有关详细信息，请参见下面的文件夹创建性能疑难解答。](#folder-creation-is-slow) | @@ -201,7 +201,7 @@ sgtk.create_filesystem_structure(entity["type"], entity["id"], engine="publish") ### 注册文件夹 -在文件夹创建过程中，将[注册](../administering/what-is-path-cache.md)文件夹，以便将来可以使用这些路径来查找上下文。[如前所述](#folder-creation-is-slow)，此过程的一部分需要与 Shotgun 站点进行通信，该站点是存储注册表的中央位置。但是，这些注册表也在本地缓存，以便通过工具更快地进行查找。 +在文件夹创建过程中，将[注册](../administering/what-is-path-cache.md)文件夹，以便将来可以使用这些路径来查找上下文。[如前所述](#folder-creation-is-slow)，此过程的一部分需要与 {% include product %} 站点进行通信，该站点是存储注册表的中央位置。但是，这些注册表也在本地缓存，以便通过工具更快地进行查找。 #### SQLite 数据库 diff --git a/docs/zh_CN/quick-answers/troubleshooting/turn-debug-logging-on.md b/docs/zh_CN/quick-answers/troubleshooting/turn-debug-logging-on.md index 4541df73d..a1d237455 100644 --- a/docs/zh_CN/quick-answers/troubleshooting/turn-debug-logging-on.md +++ b/docs/zh_CN/quick-answers/troubleshooting/turn-debug-logging-on.md @@ -7,13 +7,13 @@ lang: zh_CN # 如何启用调试日志记录？ -## 通过 Shotgun Desktop 启用调试 +## 通过 {% include product %} Desktop 启用调试 -启用调试最简单的方法是，通过 Shotgun Desktop 应用进行启用。登录 Shotgun Desktop 后便可进行相关设置：单击应用右下方的个人资料图片，然后依次选择**“高级”(Advanced)和“Toggle Debug Logging”。**此设置在会话之间持久有效，因此请在完成后将其禁用。 +启用调试最简单的方法是，通过 {% include product %} Desktop 应用进行启用。登录 {% include product %} Desktop 后便可进行相关设置：单击应用右下方的个人资料图片，然后依次选择**“高级”(Advanced)和“Toggle Debug Logging”。**此设置在会话之间持久有效，因此请在完成后将其禁用。 ![在 SG Desktop 中切换调试日志记录](images/desktop-enable-debug-logging.png) -此外还应注意，启用此项后，从 Shotgun Desktop 启动的应用，甚至整个浏览器集成中的 Toolkit 命令，也将继承此调试状态。 +此外还应注意，启用此项后，从 {% include product %} Desktop 启动的应用，甚至整个浏览器集成中的 Toolkit 命令，也将继承此调试状态。 ## 设置环境变量 diff --git a/docs/zh_CN/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md b/docs/zh_CN/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md index 42b2daace..5f6f1e418 100644 --- a/docs/zh_CN/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md +++ b/docs/zh_CN/quick-answers/troubleshooting/two-photoshop-shotgun-extensions.md @@ -9,13 +9,13 @@ lang: zh_CN ## 问题是什么？ -在发布的 After Effects 集成中，包含一个与 Shotgun 集成的所有 Adobe 应用都可使用的通用插件。作为此更改的一部分，我们需要重命名扩展，以便可以保留与较早的 Photoshop 集成的向后兼容性，并使工作室能够顺利过渡到更新。 +在发布的 After Effects 集成中，包含一个与 {% include product %} 集成的所有 Adobe 应用都可使用的通用插件。作为此更改的一部分，我们需要重命名扩展，以便可以保留与较早的 Photoshop 集成的向后兼容性，并使工作室能够顺利过渡到更新。 -不幸的是，这也意味着升级的同时可能安装两种 Shotgun 扩展： +不幸的是，这也意味着升级的同时可能安装两种 {% include product %} 扩展： -![Photoshop 菜单中显示的多个 Shotgun 扩展](./images/photoshop-extension-panel.png) +![Photoshop 菜单中显示的多个 {% include product %} 扩展](./images/photoshop-extension-panel.png) -**Shotgun Adobe Panel** 为新扩展，应该在使用 `v1.7.0` 或更新版本的 Photoshop 集成时使用。 +**{% include product %} Adobe Panel** 为新扩展，应该在使用 `v1.7.0` 或更新版本的 Photoshop 集成时使用。 ## 如何解决？ @@ -24,7 +24,7 @@ lang: zh_CN - OSX：`~/Library/Application Support/Adobe/CEP/extensions/com.sg.basic.ps` - Windows：`%AppData%\Adobe\CEP\extensions\com.sg.basic.ps` -![Photoshop 菜单中显示的多个 Shotgun 扩展](./images/shotgun-desktop-console-photoshop-extension.png) +![Photoshop 菜单中显示的多个 {% include product %} 扩展](./images/shotgun-desktop-console-photoshop-extension.png) 如果退出 Photoshop 并移除该目录，则重新启动时应只有一个扩展。 diff --git a/docs/zh_CN/quick-answers/troubleshooting/where-are-my-log-files.md b/docs/zh_CN/quick-answers/troubleshooting/where-are-my-log-files.md index ce6deade1..139672de2 100644 --- a/docs/zh_CN/quick-answers/troubleshooting/where-are-my-log-files.md +++ b/docs/zh_CN/quick-answers/troubleshooting/where-are-my-log-files.md @@ -7,7 +7,7 @@ lang: zh_CN # 我的日志文件位于何处？ -默认情况下，Shotgun Desktop 和 Shotgun 集成将其日志文件存储在以下目录中： +默认情况下，{% include product %} Desktop 和 {% include product %} 集成将其日志文件存储在以下目录中： **Mac** @@ -23,6 +23,6 @@ lang: zh_CN 日志文件名采用 `tk-.log` 格式。示例包括 `tk-desktop.log` 或 `tk-maya.log`。 -如果您已将 [`SHOTGUN_HOME` 环境变量](http://developer.shotgunsoftware.com/tk-core/utils.html#localfilestoragemanager)设置为覆盖用户的缓存位置，那么日志文件将位于：`$SHOTGUN_HOME/logs`。 +如果您已将 [`{% include product %}_HOME` 环境变量](http://developer.shotgunsoftware.com/tk-core/utils.html#localfilestoragemanager)设置为覆盖用户的缓存位置，那么日志文件将位于：`$SHOTGUN_HOME/logs`。 {% include info title="注意" content="您还可以从 Shotgun Desktop 访问此目录。选择一个项目，单击项目名称右侧的向下箭头按钮，然后选择**Open Log Folder**。"%} diff --git a/docs/zh_CN/quick-answers/workflow/version-publishedfile-difference.md b/docs/zh_CN/quick-answers/workflow/version-publishedfile-difference.md index 85cb505e2..8bc7c9598 100644 --- a/docs/zh_CN/quick-answers/workflow/version-publishedfile-difference.md +++ b/docs/zh_CN/quick-answers/workflow/version-publishedfile-difference.md @@ -7,9 +7,9 @@ lang: zh_CN # 版本与已发布的文件之间有何差异？ -“发布”****表示可在应用程序内部使用的磁盘上的文件（或图像序列）或数据。它可以是 exr 序列、abc、Maya 文件等。发布由 Shotgun 中的 `PublishedFile` 实体表示。 +“发布”****表示可在应用程序内部使用的磁盘上的文件（或图像序列）或数据。它可以是 exr 序列、abc、Maya 文件等。发布由 {% include product %} 中的 `PublishedFile` 实体表示。 -“版本”****（Shotgun 中的 `Version` 实体）是发布的直观表示，用于审核和记录。`Version` 实体有一个名为“已发布的文件”(Published Files)的字段，您可在此字段中填充任意数量的发布记录以将其连接在一起。这是您可以跟踪哪个审核 `Version` 与一组发布相关联的方法。我们建议您在发布时填充此关系。版本由 Shotgun 中的 `Version` 实体表示。 +“版本”****（{% include product %} 中的 `Version` 实体）是发布的直观表示，用于审核和记录。`Version` 实体有一个名为“已发布的文件”(Published Files)的字段，您可在此字段中填充任意数量的发布记录以将其连接在一起。这是您可以跟踪哪个审核 `Version` 与一组发布相关联的方法。我们建议您在发布时填充此关系。版本由 {% include product %} 中的 `Version` 实体表示。 最终想法是：在发布时，您可以生成一组文件 - 有时是不同的文件格式但包含相同的内容（Maya 文件、obj、alembic 等）- 这些文件以不同方式表示相同的内容。之后，它们与单一审核 `Version` 关联起来，以便预览发布数据并进行记录。 diff --git a/docs/zh_CN/reference/pipeline-integrations/env-config-ref.md b/docs/zh_CN/reference/pipeline-integrations/env-config-ref.md index e08e104b5..1c197785a 100644 --- a/docs/zh_CN/reference/pipeline-integrations/env-config-ref.md +++ b/docs/zh_CN/reference/pipeline-integrations/env-config-ref.md @@ -15,7 +15,7 @@ Toolkit 工作流的核心是环境配置。在 Toolkit 工作流配置中，环 ## 什么是环境？ -Shotgun Toolkit 平台为常用内容创建软件提供了一组完全可自定义的集成，您可以通过其构建工作室工作流。在项目的配置中，您可以指定哪些软件包具有集成，在每个软件包中哪些特定 Toolkit 应用可用，以及针对每个应用所做的选择 - 构建符合工作室需求的美工人员工作流。 +{% include product %} Toolkit 平台为常用内容创建软件提供了一组完全可自定义的集成，您可以通过其构建工作室工作流。在项目的配置中，您可以指定哪些软件包具有集成，在每个软件包中哪些特定 Toolkit 应用可用，以及针对每个应用所做的选择 - 构建符合工作室需求的美工人员工作流。 但在工作室工作流中，通常情况下，不同类型的美工人员一般会采用不同的工作流。举一个简单的示例，对于处理资产的美工人员，您可能希望提供纹理绘制软件（如 Mari），而对于处理镜头的美工人员，您可能希望提供合成软件（如 Nuke）。 @@ -107,7 +107,7 @@ engines: ### 位置描述符 -每个 Toolkit 包都有一个 `location` 设置，我们将其称为包的描述符**。描述符告知 Toolkit 在何处查找给定包，以及根据其类型，是直接访问它还是在本地缓存它。Toolkit 包可以来自多个位置，例如，Shotgun App Store、git 库、磁盘上的路径或上传到 Shotgun 站点的 zip 文件。其中每个位置都有一个对应的描述符类型，相应类型具有特定设置。下面是上述示例中 `tk-maya` 插件的描述符： +每个 Toolkit 包都有一个 `location` 设置，我们将其称为包的描述符**。描述符告知 Toolkit 在何处查找给定包，以及根据其类型，是直接访问它还是在本地缓存它。Toolkit 包可以来自多个位置，例如，{% include product %} App Store、git 库、磁盘上的路径或上传到 {% include product %} 站点的 zip 文件。其中每个位置都有一个对应的描述符类型，相应类型具有特定设置。下面是上述示例中 `tk-maya` 插件的描述符： ```yaml location: @@ -116,7 +116,7 @@ engines: version: v0.9.4 ``` -这是类型为 `app_store` 的描 符，此描述符告知 Toolkit 从 Shotgun App Store 获取给定包。类型为 `app_store` 的描述符具有设置 `name` 和 `version`。 +这是类型为 `app_store` 的描 符，此描述符告知 Toolkit 从 {% include product %} App Store 获取给定包。类型为 `app_store` 的描述符具有设置 `name` 和 `version`。 相反，如果您正在开发自定义包 - 即您正在为工作室中的一个特定工作流编写一个 Toolkit 应用，您可能希望直接从磁盘上的路径获取它。在此示例中，将使用类型为 `dev` 的描述符，它可能如下所示： diff --git a/docs/zh_CN/shotgun.md b/docs/zh_CN/shotgun.md index 6598f0a13..003d9fb48 100644 --- a/docs/zh_CN/shotgun.md +++ b/docs/zh_CN/shotgun.md @@ -5,13 +5,13 @@ pagename: shotgun-index lang: zh_CN --- -# Shotgun 开发 +# {% include product %} 开发 管理制作时需要执行大量工作以使所有运作部分保持同步。 -使用我们的 Shotgun REST API 或 Python API 直接关联您的数据，使用事件触发器框架自动执行重复性任务，并使用动作菜单项直接从 Shotgun 的 Web 界面启动应用。 +使用我们的 {% include product %} REST API 或 Python API 直接关联您的数据，使用事件触发器框架自动执行重复性任务，并使用动作菜单项直接从 {% include product %} 的 Web 界面启动应用。 -建议您使用 Shotgun API 开发自己的服务、应用程序、模块和组件，以便在本服务上运行或与本服务一起运行，供您自己和授权用户使用。 +建议您使用 {% include product %} API 开发自己的服务、应用程序、模块和组件，以便在本服务上运行或与本服务一起运行，供您自己和授权用户使用。 {% include warning title="身份验证密钥" content="我们要求您切勿披露（并且不允许您的授权用户披露）包含身份认证密钥的 API 信息，或者其他可能允许用户在没有登录的情况下访问本服务或其功能的方法，或者您自己使用 API 在没有登录的情况下访问或允许用户访问本服务或其功能的方法。" %} diff --git a/docs/zh_CN/toolkit.md b/docs/zh_CN/toolkit.md index 578771f0a..602cda795 100644 --- a/docs/zh_CN/toolkit.md +++ b/docs/zh_CN/toolkit.md @@ -7,7 +7,7 @@ lang: zh_CN # Toolkit 平台 -Toolkit 是一个可扩展的平台，用于将美工人员应用程序和工作流工具与 Shotgun 相集成。 +Toolkit 是一个可扩展的平台，用于将美工人员应用程序和工作流工具与 {% include product %} 相集成。 所有集成均基于此 Toolkit 核心 API 平台构建而成。核心 API 可处理应用、插件和平台的基本方面以及文件系统组织和工具部署。 diff --git a/tk-doc-generator b/tk-doc-generator index 0f6894f44..55adb9325 160000 --- a/tk-doc-generator +++ b/tk-doc-generator @@ -1 +1 @@ -Subproject commit 0f6894f44cda72a85833cb504b9dc120c8f2aedc +Subproject commit 55adb9325f41a0fe877d012c6aec2d9aad7ee93b