Commit Graph
28 Commits
Author SHA1 Message Date
Nicola Soranzo 0f70c68fd9 Migrate to MyST-Parser for Markdown docs
replacing deprecated recommonmark.

Fix https://github.com/galaxyproject/galaxy/issues/13005 .

Also:
- Drop not very useful ``doc/source/dev/file_upload.md`` .
- Small doc and link fixes.
2023-03-27 15:01:27 +01:00
qiagu 419b6835d5 Reword dependencies in Batch job runner doc 2022-08-18 12:42:39 -07:00
Qiang GuandNuwan Goonasekera 92ec7c60b1 Update doc/source/admin/cluster.md
Co-authored-by: Nuwan Goonasekera <2070605+nuwang@users.noreply.github.com>
2022-08-18 12:42:39 -07:00
Qiang GuandNuwan Goonasekera 049a9ee1d8 Update doc/source/admin/cluster.md
Co-authored-by: Nuwan Goonasekera <2070605+nuwang@users.noreply.github.com>
2022-08-18 12:42:39 -07:00
qiagu ddb011b698 Add admin doc for aws batch runner 2022-08-18 12:42:38 -07:00
Matthias Bernt b81b2f827e remove more leftover references to cluster_files_directory 2022-08-12 16:07:35 +02:00
M Bernt d3da6b94f7 Merge branch 'dev' into topic/auth-maxretries 2022-05-21 17:32:31 +02:00
mvdbeek 118776c118 Update jobs and cluster documentation 2022-02-24 17:47:31 +01:00
Matthias Bernt 2d91a858ab make maximum number of retries for username validation configurable
with each retry the username gets username+"-{retry_number}"

rationale: on systems where jobs are submitted as real_user the username
must not be modified in this way. this can now be achieved by
setting max-retries to 0
2022-01-17 13:32:48 +01:00
John Chilton f5648e2025 Fixup some linking between documents in sphinx. 2021-01-12 09:29:53 -05:00
M BerntandNicola Soranzo 3fa5d9e142 Apply suggestions from code review
Co-Authored-By: Nicola Soranzo <nicola.soranzo@gmail.com>
2019-12-17 17:20:59 +01:00
M Bernt 8c809725af uWSGI umask change to 027
- add `scripts/get_uwsgi_args.py`
- add docs
2019-12-17 17:20:59 +01:00
Peter Selten 844839f028 Update CLIJobRunner to ShellJobRunner according to #7433 2019-03-07 23:33:00 +00:00
Peter Selten 64b461eac8 Update Platform LSF to Spectrum LSF 2019-03-07 23:26:46 +00:00
Nicola Soranzo e725f8423a Disable auto toctree for Markdown docs. Doc syntax fixes
recommonmark allows now to use the `.md` extension for cross referencing
other documents, which also works on GitHub.
2019-02-06 17:12:06 +00:00
Nicola Soranzo 79fe787037 Fixes for the cluster documentation
Fix https://github.com/galaxyproject/galaxy/issues/5319
2019-01-30 10:27:17 +00:00
M Bernt 0eb96a63f5 doc: added missing docs for new UNIVA runner 2019-01-02 11:36:01 +01:00
Nicola Soranzo ad02c53154 Fix many links 2018-09-03 14:34:13 +01:00
Nicola Soranzo e8beea0d60 Merge branch 'release_18.01' into release_18.05 2018-06-17 12:05:50 +01:00
mvdbeek 9ac0161891 Update description for installing pbs-python 2018-06-15 18:11:50 +02:00
Nicola Soranzo 7ce49394c3 Merge branch 'release_18.01' into release_18.05 2018-04-26 19:05:38 +01:00
Nicola Soranzo a3e6963666 Merge branch 'release_17.09' into release_18.01 2018-04-26 19:01:48 +01:00
Nicola Soranzo 7d81d2cfcb Fix 2 typos in the docs 2018-04-26 10:23:14 +01:00
Oleksandr Moskalenko 2cec29c043 Update cluster config docs for virtualenv issue for drmaa real user jobs. 2018-04-12 12:13:32 -04:00
Nicola Soranzo b92a5e1b47 Small doc fixes 2018-03-13 16:51:17 +00:00
Matthias Bernt 4a59f30209 added cluster admin docs for the new variables 2018-03-13 17:22:05 +01:00
John Chilton 0585efaaa7 Update newer deployer config docs for switch to YAML config. 2017-12-06 20:57:09 -05:00
John Chilton d24b545d70 Migrate documentation for setting up a production instance to Galaxy.
This is a bugfix for the future bug of missing documentation for 17.09 and before. 18.01 will require a significant rewrite of these pages for the uWSGI and configuration changes to Galaxy and the release_17.09 branch of these docs is now being hosted https://docs.galaxyproject.org/en/release_17.09/, so backporting this configuration documentation will allow us to provide permenant links to this 17.09 varaint of all this documentation (with information about paste and galaxy.ini for instance).

This content currently includes:

- the production configuration page
- the cluster configuration page
- the job configuration page
- the scaling information page
- the ftp configuration page
- the top-level nginx page (for external auth content still linking out to the hub)
- the top-level apache page (for external auth content still linking out to the hub)
- the job metrics configuration page

Includes small tweaks to sphinx documentation generation.

- Add a quick build mode that skips source generation / Python docs (export GALAXY_DOCS_SKIP_SOURCE=1 to build this way). This speeds up review of core Sphinx docs.
- Use AutoStructify for better Markdown integration.

Updates to the documentation above and beyond what is on the corresponding Hub pages to reflect more of the state of art as of 17.09 including:

- Update the job configuration page with information about XML macros.
- Mention and link to newer style resubmission condition expressions (not just an enumerated string anymore).
- Updated list of dynamic job runner configuration parameters.
- Mention the ``raw`` attribute for ``env`` directives in the job configuration page.
- Mention the ``total_walltime`` limit added in #3217.
- Drop mentions of older URL-based job conf configuration stuff.
- Mention newer Local and Paramiko based shell runners in CLI section.
- Mention newer slurm job styles in CLI section.
- Improved Pulsar links.
- Fix dataset security link in Apache display sites config.
- Update job metrics page to link to a new Github issue instead of old Trello issues.
2017-12-05 22:04:20 -05:00