Reusable Documentation Snippets

This documentation is a collection of general information suitable for reuse in any documentation effort related to research data management with the DataLad ecosystem. It integrates seemlessly with any documentation based on the hugo relearn theme, but can also be used independently of that theme.

The repository contains short markdown files with multi-use text fragments on different ecosystem components or frequently re-used material.

Contents

The repository is organized with topical directories containing short markdown snippets (text-only, no headings).

File	content
datalad/acknowledgements.md	Overview of DataLad funding
datalad/datalad-resources.md	Overview of DataLad information resources
datalad/office-hours.md	Information about DataLad Office Hours
datalad/what-is-datalad.md	10000 feet overview of DataLad
datalad/extensions/extensions.md	Explanation of DataLad's extension concept
datalad/extensions/next/next.md	Information on datalad-next
datalad/extensions/catalog/data-privacy.md	FAQ on data privacy in datalad-catalog
datalad/extensions/catalog/repository-layoutmd	Overview of files in catalog sources
datalad/extensions/catalog/what-is-data-catalog.md	Explanation of datalad-catalog
datalad/extensions/catalog/what-is-metadata.md	Explanation of the concept of metadata
datalad/extensions/catalog/why-contribute-to-a-catalog	Explanation of catalog advantages for contributors
datalad/services/forgejo-aneksajo/what-is-forgejo-aneksajo.md	Overview of forgejo-aneksajo
datalad/services/shacl-vue/what-is-shacl-vue.md	Overview of shacl-vue
glossary/*.md	Short definitions, english and german
learning/bids.md	Overview of BIDS
learning/bids-resources.md	Further reading about BIDS
learning/git.md	The basics of Git
learning/git-resources.md	Further reading about Git
learning/bids.md	A textual explanation of a PR workflow
learning/git-resources.md	The basics about Unix CLI/sh
learning/bids.md	Further reading about Unix CLI/sh

File name prefixes denote the type of snippet:

• TODO

Usage

Usage with hugo relearn theme

In order to include text snippets from this project in hugo-based documentation that uses the hugo relearn theme, add it as a subdataset in your project and make use of the include shortcode.

First, obtain the dataset and keep it under a name of your choice, e.g.common

datalad clone https://hub.psychoinformatics.de/www/docs.template common

In your documentation, include individual snippets inside existing pages using:

{{%  include file="common/datalad/what-is-datalad.md" %}}

Usage in other contexts

• TODO

Pulling contents directly

Contents in this repository are plain mark-down files. Their content can be obtained as-is, using for example

$ curl https://hub.psychoinformatics.de/adina/docs-template/raw/branch/main/services/forgejo-aneksajo/what-is-forgejo-aneksajo.md
Forgejo is a self-hosted Git repository hosting service (like, for example, GitHub is), and specifically an open source, exclusively Free Software fork of `Gitea <https://about.gitea.com/>`_.
Forgejo-aneksajo is a git-annex aware `forgejo <https://forgejo.org/>`_.
This makes forgejo-aneksajo a feature-rich collaboration hub that can also host data.