From 87ba766524579c3b3603aaf384ba4ac90b8e2dc3 Mon Sep 17 00:00:00 2001 From: apoorv Date: Sat, 28 Mar 2020 11:24:05 +0530 Subject: [PATCH 1/3] update getting_started doc --- content/docs/Getting started/_index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/docs/Getting started/_index.md b/content/docs/Getting started/_index.md index 8c294513..729c223c 100755 --- a/content/docs/Getting started/_index.md +++ b/content/docs/Getting started/_index.md @@ -6,3 +6,6 @@ date: 2019-02-22 description: > Guides for system admins deploying OpenCue components and installing dependencies --- + +There are a lot of components in OpenCue. If you are new to OpenCue it might be useful to understand how all the components work together in the [overview](https://www.opencue.io/docs/concepts/opencue-overview/) section. +You might also refer to the [glossary](https://www.opencue.io/docs/concepts/glossary/) to become familiar with common terminologies for OpenCue. \ No newline at end of file From e2d0499136d8ac258333534cca6b8108f0c744ee Mon Sep 17 00:00:00 2001 From: apoorv Date: Mon, 30 Mar 2020 18:58:25 +0530 Subject: [PATCH 2/3] update introduction content --- content/docs/Getting started/_index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/docs/Getting started/_index.md b/content/docs/Getting started/_index.md index 729c223c..85af47d5 100755 --- a/content/docs/Getting started/_index.md +++ b/content/docs/Getting started/_index.md @@ -7,5 +7,6 @@ description: > Guides for system admins deploying OpenCue components and installing dependencies --- -There are a lot of components in OpenCue. If you are new to OpenCue it might be useful to understand how all the components work together in the [overview](https://www.opencue.io/docs/concepts/opencue-overview/) section. -You might also refer to the [glossary](https://www.opencue.io/docs/concepts/glossary/) to become familiar with common terminologies for OpenCue. \ No newline at end of file +The guides in this section provide detailed instructions for installing OpenCue in a production environment. If you'd like to quickly try out OpenCue to evaluate the project for your needs, see the [Quick starts](https://www.opencue.io/docs/quick-starts/). + +OpenCue relies on a lot of components and project-specific terminology. If you're new to OpenCue, you might find it useful to learn how some of the components work together. For more information, see the [OpenCue overview](https://www.opencue.io/docs/concepts/opencue-overview/) and [Glossary](https://www.opencue.io/docs/concepts/glossary/). \ No newline at end of file From 3a8c797514a9f746a623a8b5ecaa1b7c1f64b77c Mon Sep 17 00:00:00 2001 From: apoorv Date: Mon, 30 Mar 2020 20:59:33 +0530 Subject: [PATCH 3/3] add reference to env variables & tokens --- content/docs/Reference/env-variables.md | 70 +++++++++++++++++++++++++ content/docs/Reference/tokens.md | 38 ++++++++++++++ 2 files changed, 108 insertions(+) create mode 100644 content/docs/Reference/env-variables.md create mode 100644 content/docs/Reference/tokens.md diff --git a/content/docs/Reference/env-variables.md b/content/docs/Reference/env-variables.md new file mode 100644 index 00000000..74ca3808 --- /dev/null +++ b/content/docs/Reference/env-variables.md @@ -0,0 +1,70 @@ +--- +title: "Environment Variables" +linkTitle: "Environment Variables" +date: 2019-03-30 +weight: 4 +description: > + Reference for common environment variables +--- + +This page list some of the most common environment variables used in OpenCUE. + +## Outline + +Environment variables related to pyOutline. + +##### OL_BASE_SESSION_PATH + + +##### OL_LAYER_SESSION_PATH + + +##### OL_LAYER_RANGE + + +##### OL_VERSION + + +##### OL_OS + + +##### OL_TAG_OVERRIDE + + +##### OL_CONFIG + +## CueBOT + +Environment variables related to CueBOT. + +##### CUEBOT_HOSTS + + +##### CUEBOT_GRPC_CUE_PORT + + +##### CUEBOT_GRPC_RQD_SERVER_PORT + + +## Others + + +##### CUEGUI_DEFAULT_INI_PATH + + +##### OPENCUE_CONF + + +##### CUESUBMIT_CONFIG_FILE + + +##### CUE_FRAME_LOG_DIR + + +##### CUE_FS_ROOT + + +##### CUE_PYTHON_BIN + + +##### CUE_PYTHONPATH diff --git a/content/docs/Reference/tokens.md b/content/docs/Reference/tokens.md new file mode 100644 index 00000000..99a15cc4 --- /dev/null +++ b/content/docs/Reference/tokens.md @@ -0,0 +1,38 @@ +--- +title: "Tokens" +linkTitle: "Tokens" +date: 2019-03-30 +weight: 5 +description: > + Various tokens that can be used in the commands you send to Cue +--- + +Tokens can be used in the commands when submitting outline jobs, either inthe graphical Cuesubmit client, or via the PyOutline API. + +Following are the commonly used tokens: + + +##### #ZFRAME# + To be added. + +##### #IFRAME# + The number of the current frame. + +##### #FRAME_START# + The number of the final frame in the current chunk. + +##### #FRAME_END# + The number of the final frame in the current chunk. + +##### #FRAME_CHUNK# + The value of the current chunk. + +##### #LAYER# + The name of the current layer. + +##### #JOB# + The name of the current job. + +##### #FRAMESPEC# + The value of the current frame spec. A frame spec consists +