Add documentation about setting up deadline cloud submitters

Open Beginner friendly
#24 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
blender, python
Domain
documentation

Research direction

Check the README files in each host folder under /create and compare their existing setup guidance. Document how to configure the submitter environment variables for Maya, Blender, and Houdini using the examples in the issue. The work is done when users can find host-specific setup instructions for including each submitter.

Written by the indexing model from the issue text.

Description

type: enhancement

Should we give some info to showcase how the users can include the submitter as part of the environment variable in e.g blender, maya and houdini?
Like:

Maya

  "MAYA_MODULE_PATH": [
"{MAYA_MODULE_PATH}",
"D:\\ayon-addon_template\\ayon-deadline-cloud\\deadline-cloud-for-maya\\plugin_env"
],
"PYTHONPATH": [
"{PYTHONPATH}",
"D:\\ayon-addon_template\\ayon-deadline-cloud\\deadline-cloud-for-maya\\plugin_env\\scripts"

Blender

{"AYON_BLENDER_USER_SCRIPTS": ["{AYON_BLENDER_USER_SCRIPTS}", "C:/Users/Kayla/DeadlineCloudSubmitter/Submitters/Blender/python/" ]}

Houdini

{"PYTHONPATH": [
"{PYTHONPATH}",
"D:\\ayon-addon_template\\aws\\deadline-cloud-for-houdini\\src\\deadline\\houdini_submitter\\python"
]}

There might be the README for each host folder in /create folder.

Originally posted by @moonyuet in https://github.com/ynput/ayon-deadline-cloud/issues/19#issuecomment-4544953301

Dominant language
Python
Stars
3
Forks
1
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ynput/ayon-deadline-cloud

All issues in ynput/ayon-deadline-cloud

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.