Skip to content

Conversation

@skarpree
Copy link

@skarpree skarpree commented Dec 9, 2025

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

The documentation was missing instructions for offline installation of Deadline Client GUI components. Users working in air-gapped or restricted network environments need guidance on how to download and install these components without direct internet access.

What was the solution? (How)

Added new offline installation instructions that include:

  • Prerequisites for the installation process
  • Step-by-step guide for downloading packages on an internet-connected machine
  • Instructions for transferring packages to offline machines
  • Commands for installing packages in the offline environment
  • Proper formatting with code blocks and clear structure

What is the impact of this change?

Users in offline or restricted network environments can now successfully install Deadline Client GUI components by following the documented procedure. This expands the accessibility of the product to air-gapped deployment scenarios.

How was this change tested?

  • Documentation changes reviewed for technical accuracy
  • Formatting verified in markdown preview
  • Installation steps validated against actual offline installation workflow
  • N/A - No code changes, unit tests not applicable
  • N/A - No code changes, integration tests not applicable

Was this change documented?

  • This PR adds new documentation content
  • N/A - No code changes requiring docstring updates

Does this PR introduce new dependencies?

  • 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?

No, this is a documentation-only addition with no impact on code functionality or public contracts.

Does this change impact security?

No, this change only adds documentation content. No security implications.


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

@skarpree skarpree requested a review from a team as a code owner December 9, 2025 20:28
@github-actions github-actions bot added the waiting-on-maintainers Waiting on the maintainers to review. label Dec 9, 2025
@skarpree skarpree force-pushed the manual_deadline-gui]_instruction branch 2 times, most recently from c8c68b0 to 6c29bf7 Compare December 9, 2025 21:08
docs/index.md Outdated

Install the packages into the appropriate Submitter or Python environment where the Deadline Client is installed:
```
/Path/to/python -m pip install --no-index --upgrade --find-links /your/pypi/bundle/from/above --target /Your/Target/python/module/dir *.whl
Copy link
Contributor

Choose a reason for hiding this comment

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

This is quite hard to understand, what is /your/pypi/bundle/from/above, and what is /YourTarget/python (different case?)

Can you provide more details what the args do?

Copy link
Contributor

Choose a reason for hiding this comment

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

+1, hard to follow. Maybe add a step to check the bundle from the above step so the flow to this command makes sense and is easy to follow

@leongdl leongdl added response-requested A response from the contributor has been requested. and removed waiting-on-maintainers Waiting on the maintainers to review. labels Dec 12, 2025
docs/index.md Outdated

Use the Python version bundled with the installer to download the Deadline GUI components using pip:
```
/Path/to/python -m pip download -d /your/download/directory deadline[gui]=={DEADLINE_CLIENT_VERSION}
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should keep the path examples consistent. For eg. path/to/python and path/to/your/download/directory. Also avoid the / at the beginning to avoid confusion

docs/index.md Outdated

Install the packages into the appropriate Submitter or Python environment where the Deadline Client is installed:
```
/Path/to/python -m pip install --no-index --upgrade --find-links /your/pypi/bundle/from/above --target /Your/Target/python/module/dir *.whl
Copy link
Contributor

Choose a reason for hiding this comment

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

+1, hard to follow. Maybe add a step to check the bundle from the above step so the flow to this command makes sense and is easy to follow

@github-actions github-actions bot added waiting-on-maintainers Waiting on the maintainers to review. and removed response-requested A response from the contributor has been requested. labels Dec 12, 2025
skarpree and others added 3 commits December 12, 2025 15:53
Signed-off-by: client-software-ci <[email protected]>
Signed-off-by: Eric Osiowy <[email protected]>
Signed-off-by: skarpree <[email protected]>
Updated the instructions to be more clear for the customer to follow.

Signed-off-by: skarpree <[email protected]>
@skarpree skarpree force-pushed the manual_deadline-gui]_instruction branch from 4a2f375 to 3cc8008 Compare December 12, 2025 21:56
@sonarqubecloud
Copy link


Use the Python version bundled with the installer to download the Deadline GUI components:
```bash
path/to/python -m pip download -d path/to/download/directory deadline[gui]=={DEADLINE_CLIENT_VERSION}
Copy link
Contributor

Choose a reason for hiding this comment

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

One nit - I think we need to mention the same python package is needed on both machines?

* The CLI `bundle gui-submit --submitter-name` option has been deprecated. `--submitter-info` should now be used to provide the name.
## 0.54.0 (2025-12-09)

### BREAKING CHANGES
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems odd your PR changed the change log?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this came from the 0.54 deadline release chore commit. Branch needs to be rebased

@moorec-aws moorec-aws added response-requested A response from the contributor has been requested. and removed waiting-on-maintainers Waiting on the maintainers to review. labels Dec 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

response-requested A response from the contributor has been requested.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants