WIP: proof-of-principle-reusable-docs #9
Loading…
Reference in a new issue
No description provided.
Delete branch "proof-of-principle-reusable-docs"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR is a replica of https://hub.psychoinformatics.de/adina/rdm.sfb1451.de/pulls/1 and demonstrates how to include a dataset with reusable documentation snippets (for now - temporarily - living at https://hub.psychoinformatics.de/adina/docs-template) via hugo relearn-theme's "include" shortcode.
The process is:
Why? This would allow us to extract generic documentation pieces and provide and maintain them centrally. Documentation for individual projects (e.g., consortia) can then use these centrally maintained resources. This should reduce maintenance efforts as updates can simply be pulled in once. Nevertheless, it allows for flexibility and customization, provided the generic snippets are small-scoped enough.
Pull request closed