-
Notifications
You must be signed in to change notification settings - Fork 991
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
improved doc in galaxy.ini for outputs_to_working_directory #5332
improved doc in galaxy.ini for outputs_to_working_directory #5332
Conversation
to avoid misconfigurations as in galaxyproject#5323
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the changes.
Could you get rid of the extra merge commits ?
Assuming origin is the galaxy remote something like git checkout origin/dev && git checkout -b my_new_feature && git cherry-pick 1648e352cba4edafb44f767649a0da7bc916e5d2
should work
config/galaxy.ini.sample
Outdated
# This option will override tool output paths to write outputs to the working | ||
# directory (instead of to the file_path) and the job manager will move the | ||
# outputs to their proper place in the dataset directory on the Galaxy server | ||
# after the job completes. This is necessary (for example) you run on a cluster |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/is necessary (for example) you/is necessary (for example) if jobs/
config/galaxy.ini.sample
Outdated
# outputs to their proper place in the dataset directory on the Galaxy server | ||
# after the job completes. This is necessary (for example) you run on a cluster | ||
# and your datasets (file_path) can not be written by the user running the jobs | ||
# (e.g. if the filesystem is mounted read-only or the jobs are run by a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a a extra whitespace here.
config/galaxy.ini.sample
Outdated
# directory (instead of to the file_path) and the job manager will move the | ||
# outputs to their proper place in the dataset directory on the Galaxy server | ||
# after the job completes. This is necessary (for example) you run on a cluster | ||
# and your datasets (file_path) can not be written by the user running the jobs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/and your datasets (file_path) can not be written/and datasets are not writable/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say: "and the output datasets cannot be created inside file_path by the user running the jobs"
to avoid misconfigurations as in galaxyproject#5323
…ub.com/bernt-matthias/galaxy into topic/outputs_to_working_directory-doc
config/galaxy.ini.sample
Outdated
# paths to write outputs to the working directory instead, and the job manager | ||
# will move the outputs to their proper place in the dataset directory on the | ||
# Galaxy server after the job completes. | ||
# This option will override tool output paths to write outputs to the working |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/the working/the job working/
config/galaxy.ini.sample
Outdated
@@ -1333,7 +1335,7 @@ use_interactive = True | |||
# actual user instead of as the user running the Galaxy server process. For | |||
# details on these options, see the documentation at: | |||
# | |||
# https://galaxyproject.org/admin/config/performance/cluster | |||
# https://galaxyproject.org/admin/config/performance/cluster#configuration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
config/galaxy.ini.sample
Outdated
@@ -1333,7 +1335,7 @@ use_interactive = True | |||
# actual user instead of as the user running the Galaxy server process. For | |||
# details on these options, see the documentation at: | |||
# | |||
# https://galaxyproject.org/admin/config/performance/cluster | |||
# https://galaxyproject.org/admin/config/performance/cluster#submitting-jobs-as-the-real-user |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because of the redirect the anchor will not work, please use: https://docs.galaxyproject.org/en/latest/admin/cluster.html#submitting-jobs-as-the-real-user
galaxy.ini.sample is gone - I ported these changes to new config in the PR linked above, thanks @bernt-matthias ! |
to avoid misconfigurations as in #5323
furthermore I reordered the description such that first the option is described and then the use case