From 62769f389a0e8c77d1352dfb58529facf3c88b3f Mon Sep 17 00:00:00 2001
From: Maximilian Moser <maximilian.moser@tuwien.ac.at>
Date: Wed, 17 May 2023 19:18:36 +0200
Subject: [PATCH] Update the template for the description metadata field
* because we know that writing good READMEs from scratch is much harder
than starting from a template
---
invenio_config_tuw/config.py | 1 +
1 file changed, 1 insertion(+)
diff --git a/invenio_config_tuw/config.py b/invenio_config_tuw/config.py
index a25afaf..5ded02e 100644
--- a/invenio_config_tuw/config.py
+++ b/invenio_config_tuw/config.py
@@ -153,6 +153,7 @@ APP_RDM_DEPOSIT_FORM_DEFAULTS = {
"id": "dataset",
},
"version": "1.0.0",
+ "description": "<h2>A primer on your dataset's description (to be edited)</h2><p>The influence of proper documentation on the reusability for research data should not be underestimated!<br>In order to help others understand how to interpret and reuse your data, we provide you with a few questions to help you structure your dataset's description (though please don't feel obligated to stick to them):</p><h3>Context and methodology</h3><ul><li>What is the research domain or project in which this dataset was created?</li><li>Which purpose does this dataset serve?</li><li>How was this dataset created?</li></ul><h3>Technical details</h3><ul><li>What is the structure of this dataset? Do the folders and files follow a certain naming convention?</li><li>Is any specific software required to open and work with this dataset? Does it only work on certain operating systems?</li><li>Are there any additional resources available regarding the dataset, e.g. documentation, source code, etc.?</li></ul><h3>Further details</h3><ul><li>Is there anything else that other people may need to know when they want to reuse the dataset?</li></ul>",
}
RDM_CITATION_STYLES = [
--
GitLab