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.

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

update documentation for manifest #210

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

omehrabi
Copy link
Contributor

add documentation for follow-symlink to use a symlink for the job

@omehrabi omehrabi requested a review from a team as a code owner May 24, 2023 18:08
Comment on lines 42 to 44
In case the associated script file is in a different location from the manifest you could use a symlink
to refering the script. To change the default behavior for using the symlink and change where to execute
the script you need to pass --follow-symlink.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In case the associated script file is in a different location from the manifest you could use a symlink
to refering the script. To change the default behavior for using the symlink and change where to execute
the script you need to pass --follow-symlink.
In case the associated job file is in a different location from the manifest you can use a symlink
to refer to the job.py file. By default the job will be executed in the directory where the manifest
file is located. To change the execution directory and use the symlink target directory to execute
the script you need to pass --follow-symlink.

@omehrabi omehrabi requested a review from dwapstra May 26, 2023 16:22

$ job.py # is a symlink for the associated script
Copy link
Contributor

Choose a reason for hiding this comment

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

Please show symlink from the filesystem, e.g.

ls -l job.py
lrwxr-xr-x  1 admin  wheel  20 Nov 29 11:36 job.py -> /tmp/job/path/job.py

This job will be executed in the /tmp/job/path directory.

Copy link

Choose a reason for hiding this comment

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

Please show symlink from the filesystem, e.g.

ls -l job.py
lrwxr-xr-x  1 admin  wheel  20 Nov 29 11:36 job.py -> /tmp/job/path/job.py

This job will be executed in the /tmp/job/path directory.

@omehrabi
Did you see this note from a reviewer?

Copy link
Contributor

@dwapstra dwapstra left a comment

Choose a reason for hiding this comment

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

Please update the doc with example symlink

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants