diff --git a/doc/source/admin/data.md b/doc/source/admin/data.md index 26fef7d783e..02a6be668da 100644 --- a/doc/source/admin/data.md +++ b/doc/source/admin/data.md @@ -399,6 +399,19 @@ configuration). ![](file_source_invenio_configuration.png) +#### `zenodo` + +The syntax for the `configuration` section of `zenodo` templates looks like this. + +![](file_source_zenodo_configuration_template.png) + +At runtime, after the `configuration` template is expanded, the resulting dictionary +passed to Galaxy's file source plugin infrastructure looks like this and should match a subset +of what you'd be able to add directly to `file_sources_conf.yml` (Galaxy's global file source +configuration). + +![](file_source_zenodo_configuration.png) + ### YAML Syntax ![galaxy.files.templates.models](file_source_templates.png) @@ -471,6 +484,14 @@ and you are comfortable with it storing your user's secrets. ![Screenshot](user_file_source_form_full_invenio.png) +#### Allow Users to Define Zenodo as File Source + +```{literalinclude} ../../../lib/galaxy/files/templates/examples/production_zenodo.yaml +:language: yaml +``` + +![Screenshot](user_file_source_form_full_zenodo.png) + ### Production OAuth 2.0 File Source Templates Unlike the examples in the previous section. These examples will require a bit of diff --git a/doc/source/admin/file_source_templates.png b/doc/source/admin/file_source_templates.png index fd48cee0eee..b5a503e037d 100644 Binary files a/doc/source/admin/file_source_templates.png and b/doc/source/admin/file_source_templates.png differ diff --git a/doc/source/admin/file_source_zenodo_configuration.png b/doc/source/admin/file_source_zenodo_configuration.png new file mode 100644 index 00000000000..31c90bfa3e3 Binary files /dev/null and b/doc/source/admin/file_source_zenodo_configuration.png differ diff --git a/doc/source/admin/file_source_zenodo_configuration_template.png b/doc/source/admin/file_source_zenodo_configuration_template.png new file mode 100644 index 00000000000..cd887e5b222 Binary files /dev/null and b/doc/source/admin/file_source_zenodo_configuration_template.png differ diff --git a/doc/source/admin/gen_diagrams.py b/doc/source/admin/gen_diagrams.py index 3d1ba1059b9..dfd8acebe4d 100644 --- a/doc/source/admin/gen_diagrams.py +++ b/doc/source/admin/gen_diagrams.py @@ -23,6 +23,8 @@ from galaxy.files.templates.models import ( S3FSFileSourceTemplateConfiguration, WebdavFileSourceConfiguration, WebdavFileSourceTemplateConfiguration, + ZenodoFileSourceConfiguration, + ZenodoFileSourceTemplateConfiguration, ) from galaxy.objectstore.templates.models import ( AwsS3ObjectStoreConfiguration, @@ -69,6 +71,8 @@ class_to_diagram = { eLabFTWFileSourceConfiguration: "file_source_elabftw_configuration", InvenioFileSourceTemplateConfiguration: "file_source_invenio_configuration_template", InvenioFileSourceConfiguration: "file_source_invenio_configuration", + ZenodoFileSourceTemplateConfiguration: "file_source_zenodo_configuration_template", + ZenodoFileSourceConfiguration: "file_source_zenodo_configuration", } for clazz, diagram_name in class_to_diagram.items(): diff --git a/doc/source/admin/user_file_source_form_full_zenodo.png b/doc/source/admin/user_file_source_form_full_zenodo.png new file mode 100644 index 00000000000..cf0bde2de4e Binary files /dev/null and b/doc/source/admin/user_file_source_form_full_zenodo.png differ