Add documentation on using remote URIs for runtime environments #20352
Conversation
doc/source/dependency-management.rst
Outdated
|
|
||
| .. warning:: | ||
|
|
||
| Check for hidden files in zipped dependencies. |
There was a problem hiding this comment.
Can you give a brief explanation or example for how to do this?
doc/source/dependency-management.rst
Outdated
|
|
||
| runtime_env = {..., "working_dir": "/some_path/example_dir", ...} | ||
|
|
||
| Suppose instead you want to host its contents remotely and provide a remote URI. |
There was a problem hiding this comment.
| Suppose instead you want to host its contents remotely and provide a remote URI. | |
| Suppose instead you want to host your files remotely and provide a remote URI. |
doc/source/dependency-management.rst
Outdated
| You would need to first compress the ``example_dir`` directory into a zip file. | ||
| There should be no other files or directories at the top level of the zip file, other than ``example_dir``. |
There was a problem hiding this comment.
Is it possible to give a quick example of how to do this, like an example command or something?
Co-authored-by: architkulkarni <[email protected]>
|
My main feedback is for the URLs, it seems easier to tell people where to click/what to run to get the URLs rather than the structure of the URL (we can show both, but it's easier to point to how to get it rather than how to construct it). Otherwise lgtm! |
|
Agree with @javi-redondo -- can we at least tell people how to get it for GitHub? |
|
Can we rearrange things to the recommended link option appears before the non-recommended one? And within the recommended option, using |
Why are these changes needed?
Feature #19862 allows users to specify dependencies accessed via remote URIs in their
runtime_envdictionaries. These changes update theruntime_envdocumentation to teach users how to use remote URIs.Related issue number
Closes #20340.
Checks
scripts/format.shto lint the changes in this PR.