Add Zenodo file source template documentation

This commit is contained in:
davelopez
2025-02-17 16:45:56 +01:00
parent 2e0c45eb75
commit 87d5773f2c
6 changed files with 25 additions and 0 deletions
+21
View File
@@ -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
Binary file not shown.

Before

Width:  |  Height:  |  Size: 570 KiB

After

Width:  |  Height:  |  Size: 651 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

+4
View File
@@ -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():
Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB