From 7abac80cc6cfd633ec692daa3fae9ac17253a697 Mon Sep 17 00:00:00 2001 From: Adina Wagner Date: Fri, 4 Jul 2025 16:34:05 +0200 Subject: [PATCH 1/2] [DATALAD] Added subdataset --- .gitmodules | 4 ++++ shortcodes/include | 1 + 2 files changed, 5 insertions(+) create mode 160000 shortcodes/include diff --git a/.gitmodules b/.gitmodules index 5c05f90..b9d1246 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,7 @@ [submodule "themes/hugo-theme-relearn"] path = themes/hugo-theme-relearn url = https://github.com/McShelby/hugo-theme-relearn.git +[submodule "shortcodes/include"] + path = shortcodes/include + url = https://hub.psychoinformatics.de/adina/docs-template.git + datalad-url = https://hub.psychoinformatics.de/adina/docs-template.git diff --git a/shortcodes/include b/shortcodes/include new file mode 160000 index 0000000..105e55d --- /dev/null +++ b/shortcodes/include @@ -0,0 +1 @@ +Subproject commit 105e55de12e7bd00ef4528ed3ac6c2bf79896911 -- 2.52.0 From bba617c3e5f5ac88d4f0c2b8fe8520c7469a9409 Mon Sep 17 00:00:00 2001 From: Adina Wagner Date: Fri, 4 Jul 2025 16:45:29 +0200 Subject: [PATCH 2/2] demonstrate use of docs.template This removes generic content from the documentation, and in its place, links to documentation snippets containing (almost) the same content via hugos include shortcode. This commit is merely a demonstration to test how having a generic documentation subdataset looks and feels like. --- content/datalad/_index.md | 25 +++++-------------------- content/datalad/help.md | 14 +------------- 2 files changed, 6 insertions(+), 33 deletions(-) diff --git a/content/datalad/_index.md b/content/datalad/_index.md index 0b61dfe..25a8bc7 100644 --- a/content/datalad/_index.md +++ b/content/datalad/_index.md @@ -4,28 +4,13 @@ type = "chapter" weight = 1 +++ -The software [DataLad](https://datalad.org) is the key research data -management solution adopted by the SFB. DataLad is a free and open -source distributed data management system that keeps track of your data, -creates structure, ensures reproducibility, supports collaboration, and -integrates with widely used data infrastructure. -DataLad can be used for: +{{% include file="shortcodes/include/datalad/what-is-datalad.md" %}} +It is the key research data +management solution adopted by the SFB. -- tracking changes to files big and small (version control for code - and data) -- file transfer for archival or multilateral exchange, in combination - with various infrastructure -- obtaining published datasets -- unified access to files stored in different locations -- provenance capture (exact records of data processing) -- metadata extraction and aggregation into a catalog. - -It is extensively documented in a dedicated [DataLad -Handbook](https://handbook.datalad.org) that is targeting both novice -and experienced users. The [DataLad YouTube -channel](https://youtube.com/datalad) provides videos on conceptual -overviews, detailed tutorials, and technical talks on the software. The +{{% include file="shortcodes/include/datalad/datalad-resources.md" %}} +The [materials from SFB1451 workshops](https://psychoinformatics-de.github.io/rdm-course/) are available online. diff --git a/content/datalad/help.md b/content/datalad/help.md index 1b121ed..4f5607c 100644 --- a/content/datalad/help.md +++ b/content/datalad/help.md @@ -12,19 +12,7 @@ to use the following channels. ## Virtual DataLad office hours -We are having a virtual office hour every Tuesday at 16:00. This is a -great opportunity to discuss problems and solutions with the members of -the [Psychoinformatics Group](https://www.psychoinformatics.de) at FZJ. -To join: - -- Follow [this link to the public matrix chat - room](https://matrix.to/#/!NaMjKIhMXhSicFdxAj:matrix.org) and click - continue. -- The link to the zoom meeting will be in the channel description. -- We use the matrix chat room to communicate any changes of plans if - they happen, or to discuss topics in advance. Joining isn\'t - necessary, but you\'re invited to pick one of the available methods - (element is the semi-official client). +{{% include file="shortcodes/include/datalad/office-hours.md" %}} ## Directly by e-mail -- 2.52.0