docs: [WIP] Add a README with tutorial on how to use the job attachment CLIs

[leongdl]

Fixes:

What was the problem/requirement? (What/Why)

What was the solution? (How)

What is the impact of this change?

How was this change tested?

See DEVELOPMENT.md for information on running tests.

• Have you run the unit tests?
• Have you run the integration tests?
• Have you made changes to the download or asset_sync modules? If so, then it is highly recommended
  that you ensure that the docker-based unit tests pass.

Was this change documented?

• Are relevant docstrings in the code base updated?
• Has the README.md been updated? If you modified CLI arguments, for instance.

Does this PR introduce new dependencies?

This library is designed to be integrated into third-party applications that have bespoke and customized deployment environments. Adding dependencies will increase the chance of library version conflicts and incompatabilities. Please evaluate the addition of new dependencies. See the Dependencies section of DEVELOPMENT.md for more details.

• This PR adds one or more new dependency Python packages. I acknowledge I have reviewed the considerations for adding dependencies in DEVELOPMENT.md.
• This PR does not add any new dependencies.

Is this a breaking change?

A breaking change is one that modifies a public contract in a way that is not backwards compatible. See the
Public Contracts section
of the DEVELOPMENT.md for more information on the public contracts.

If so, then please describe the changes that users of this package must make to update their scripts, or Python applications.

Does this change impact security?

• Does the change need to be threat modeled? For example, does it create or modify files/directories that must only be readable by the process owner?
  • If so, then please label this pull request with the "security" label. We'll work with you to analyze the threats.

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[godobyte]

nit - inconsistent cap

1. Submission -> submission
2. Downloading Job Outputs -> Downloading job outputs

Would it be helpful to specify the persona for the action?

[leongdl]

Thanks, changed!

In terms of persona, I think only technical members will read this doc. It is unlikely an artist will run the CLIs unless we have a nice button click in the DCM. We can add more details if there's interest.

[godobyte]

nit - . -> :

[godobyte]

Is this supposed to be output from the command, maybe we can make that explicit?

[leongdl]

Its an (Argument), so I'll add it (Argument)

[godobyte]

This is optional too, when not provided, the command would look for the default Queue and use GetQueue to retrieve JA bucket configurations.

[leongdl]

Right, I'll mark it as (Optional, farm-id and queue-id) alternative.

I'll keep the TLDR simple, the examples section can have both.

[godobyte]

One of --root-dirs or --path-mapping-rules is required, but not both. They're used for determining where the attachments are for upload.

[leongdl]

Right! I need to add that.

[godobyte]

This command should support a list of step ids for Step-Step dependencies?

[leongdl]

No, this is the step to download for, the command line internally takes care of finding the step-step dependency of the argument step.

[godobyte]

These are optional too?

[leongdl]

farm, queue and job should not be optional? Manifest download keys on the farm, queue and job.

[godobyte]

When present, the credentials associated with this profile should grant access to the s3 bucket.

[leongdl]

Oh great comment - super important info.

[leongdl]

Added as note for all CLIs.

[godobyte]

Crentials -> Credentials

suggestion - Assumes Deadline Queue Credentials to access S3 bucket, or use profile specified via input.

[leongdl]

Great suggestion on --profile! Added and fixed typo.,

[godobyte]

Suggested change

	Upload a manifest file to S3. Uploaded manifests can be used for subsequent programatic job sumission. Assumes Deadline Queue Crentials to access S3 bucket.
	Upload a manifest file to S3. Uploaded manifests can be used for subsequent programmatic job submission. Assumes Deadline Queue Credentials to access S3 bucket, or use profile specified via input.

[leongdl]

Updated!

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud