docs: add info about enable_data_package_reference

Add basic info about enable_data_package_reference parameter, and note that it needs to be enabled if deposit module is enabled. Otherwise links to deposited data packages won't work correctly.
UtrechtUniversity · Dec 20, 2024 · e3005e7 · e3005e7
1 parent 9ce927c
commit e3005e7
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/docs/administration/configuring-yoda.md b/docs/administration/configuring-yoda.md
@@ -281,7 +281,8 @@ vault_copy_max_retries  | How many times to retry copy to vault on particular fo
 
 Variable                     | Description
 -----------------------------|---------------------
-enable_deposit               | Enable deposit module
+enable_deposit               | Enable deposit module (default: false). If the deposit module is enabled, `enable_data_package_reference` should also be set to True.
+enable_data_package_reference| Enable data package references for vault data packages (default: false). Set to true if deposit module is enabled.
 
 ### Datarequest module configuration
 

diff --git a/roles/yoda_portal/defaults/main.yml b/roles/yoda_portal/defaults/main.yml
@@ -68,7 +68,8 @@ yoda_portal_upload_part_files: true                # Allow use of .part data obj
 enable_open_search: false                          # Enable OpenSearch module
 
 # Deposit module configuration
-enable_deposit: false                              # Enable deposit module
+enable_deposit: false                              # Enable deposit module. If enabled, enable_data_package_reference also
+                                                   # needs to be set to true.
 
 # Datarequest module configuration
 enable_datarequest: false                          # Enable datarequest module

diff --git a/roles/yoda_rulesets/defaults/main.yml b/roles/yoda_rulesets/defaults/main.yml
@@ -143,7 +143,8 @@ enable_datarequest: false               # Enable datarequest module
 enable_open_search: true                # Enable OpenSearch module
 
 # Deposit module configuration
-enable_deposit: false                   # Enable deposit module
+enable_deposit: false                   # Enable deposit module. If enabled, enable_data_package_reference also
+                                        # needs to be set to true.
 
 # Data Package Reference
 enable_data_package_reference: false    # Enable Data Package References for vault data packages