Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add reference to env variables & tokens #177

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

add reference to env variables & tokens #177

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7f0354f
add reference to env variables & tokens
apoorvkhare07 Mar 30, 2020
1fb25ae
updated suggestions
apoorvkhare07 Apr 3, 2020
cf4b947
adding line breaks
apoorvkhare07 Apr 4, 2020
06e68cc
updating tokens doc
apoorvkhare07 Apr 9, 2020
abfa8a3
indentation fixes
apoorvkhare07 Apr 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions content/docs/Reference/env-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: "Environment Variables"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use sentence case for all OpenCue documentation, so this should be:

Environment variables

linkTitle: "Environment Variables"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Environment variables

date: 2019-03-30
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't personally see much value in merging a page like this has no useful information. The tokens page looks useful.

However if we merge the environment variables page, then we should set the page in the future so that our publishing framework (Hugo) doesn't actually make the page visible until it's ready.

For example set the date to: 2025-01-01

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sharifsalah You can let me know the useful information needed to be added in the environment variable's page and I will add it accordingly.
I included the page as it was mentioned in the issue but I don't exactly know the description of each variable required for documentation.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's ok to submit it with a future publish-date, then I can send a followup PR to fill in the content for each env var.

weight: 4
description: >
Reference for common environment variables
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend making this more task oriented, as follows:

Configure common environment variables

---

This page list some of the most common environment variables used in OpenCUE.
bcipriano marked this conversation as resolved.
Show resolved Hide resolved

## Outline

Environment variables related to pyOutline.

##### OL_BASE_SESSION_PATH
bcipriano marked this conversation as resolved.
Show resolved Hide resolved


##### OL_LAYER_SESSION_PATH


##### OL_LAYER_RANGE


##### OL_VERSION


##### OL_OS


##### OL_TAG_OVERRIDE


##### OL_CONFIG

## CueBOT
bcipriano marked this conversation as resolved.
Show resolved Hide resolved

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
38 changes: 38 additions & 0 deletions content/docs/Reference/tokens.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "Tokens"
linkTitle: "Tokens"
date: 2019-03-30
bcipriano marked this conversation as resolved.
Show resolved Hide resolved
weight: 5
description: >
Various tokens that can be used in the commands you send to Cue
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend updating the description to:

Specify dynamic tokens in OpenCue jobs

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be clear, here I'm just describing the value of the string to update. I'm not describing the syntax or the way you should update the code. If you looks at similar Markdown (.md) files, you should be able to work out how to format the description but let us know if you're stuck.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh ya, sorry my bad. I didn't pay attention to that.
Will fix this

---

Tokens can be used in the commands when submitting outline jobs, either inthe graphical Cuesubmit client, or via the PyOutline API.
bcipriano marked this conversation as resolved.
Show resolved Hide resolved

Following are the commonly used tokens:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend updating to:

This page describes tokens you can use in commands when submitting OpenCue jobs, either in the graphical Cuesubmit
client, or using the PyOutline API.

(I would delete the sentence 'Following are the commonly used tokens:' as we're not
introducing a list)



##### #ZFRAME#
To be added.
bcipriano marked this conversation as resolved.
Show resolved Hide resolved

##### #IFRAME#
bcipriano marked this conversation as resolved.
Show resolved Hide resolved
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
bcipriano marked this conversation as resolved.
Show resolved Hide resolved