Skip to content

Commit 31ef72e

Browse files
Reconfigure tutorials (lmu-osc#341)
* Include yaml files in the collection for training tutorials * Transfer data management tutorials to yaml format * Move study planning tutorials to yaml * Use metadata file for reproducible processes tutorials * Use metadata appraoch for publishing outputs * Create skeleton for principles folder * Create correct sidebar navigation for tutorials in qmd and yaml files * Use more robust listing approach for top-level tutorial groupings
1 parent b938fa6 commit 31ef72e

27 files changed

+201
-324
lines changed

_quarto.yml

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,19 +86,29 @@ website:
8686
contents:
8787
- text: "Principles"
8888
href: training/principles/index.qmd
89-
contents: training/principles/*
89+
contents:
90+
- auto: "training/principles/*.qmd"
91+
- training/principles/principles-tutorials.yaml
9092
- text: "Study Planning"
9193
href: training/study_planning/index.qmd
92-
contents: training/study_planning/*
94+
contents:
95+
- auto: "training/study_planning/*.qmd"
96+
- training/study_planning/study-planning-tutorials.yaml
9397
- text: "Data Management"
9498
href: training/data_management/index.qmd
95-
contents: training/data_management/*
99+
contents:
100+
- auto: "training/data_management/*.qmd"
101+
- training/data_management/data-management-tutorials.yaml
96102
- text: "Reproducible Processes"
97103
href: training/reproducible_processes/index.qmd
98-
contents: training/reproducible_processes/*
104+
contents:
105+
- auto: "training/reproducible_processes/*.qmd"
106+
- training/reproducible_processes/reproducible-processes-tutorials.yaml
99107
- text: "Publishing Outputs"
100108
href: training/publishing_outputs/index.qmd
101-
contents: training/publishing_outputs/*
109+
contents:
110+
- auto: "training/publishing_outputs/*.qmd"
111+
- training/publishing_outputs/publishing-outputs-tutorials.yaml
102112
- text: "Open Research Cycle"
103113
href: training/open_research_cycle.qmd
104114
- text: "Train the Trainer"
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
2+
- title: "FAIR Data Management"
3+
description: "Take steps towards making your data FAIR: **F**indable, **A**ccessible, **I**nteroperable, **R**eusable"
4+
image: "../images/fair data management.svg"
5+
categories:
6+
- FAIR data
7+
- Data management
8+
- Documentation
9+
content_category:
10+
- Data Management
11+
within_cat_order: 20
12+
path: "https://lmu-osc.github.io/FAIR-Data-Management/"
13+
14+
- title: "Data Dictionary"
15+
description: "Tutorial in progress..."
16+
image: "../images/data dictionary.svg"
17+
categories:
18+
- Documentation
19+
content_category:
20+
- Data Management
21+
within_cat_order: 30
22+
path: https://lmu-osc.github.io/Collaborative-RStudio-GitHub/
23+
24+
25+
- title: "TBD: Data Anonymity"
26+
description: "Tutorial in progress..."
27+
image: "../images/data anonymity.svg"
28+
categories:
29+
- Data anonymity
30+
content_category:
31+
- Data Management
32+
within_cat_order: 50
33+
path: https://lmu-osc.github.io/
34+
35+
- title: "TBD: Generating Synthetic Data"
36+
description: "Tutorial in progress..."
37+
image: "../images/synthetic data.svg"
38+
categories:
39+
- Data simulation
40+
- Data anonymity
41+
content_category:
42+
- Data Management
43+
within_cat_order: 60
44+
path: https://lmu-osc.github.io/synthetic-data-tutorial/

training/data_management/data_anonymity.qmd

Lines changed: 0 additions & 21 deletions
This file was deleted.

training/data_management/data_dictionary.qmd

Lines changed: 0 additions & 21 deletions
This file was deleted.

training/data_management/fair_data_management.qmd

Lines changed: 0 additions & 22 deletions
This file was deleted.

training/data_management/index.qmd

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ categories:
1111

1212
listing:
1313
type: default
14+
contents:
15+
- /**.qmd
16+
- data-management-tutorials.yaml
17+
fields: [title, description, categories, image]
1418
sort:
1519
- within_cat_order
1620
---

training/data_management/synthetic_data.qmd

Lines changed: 0 additions & 22 deletions
This file was deleted.

training/principles/index.qmd

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ categories:
88
- Open research practices
99
listing:
1010
type: default
11+
contents:
12+
- /**.qmd
13+
# - principles-tutorials.yaml # uncomment this line when tutorials are added to the principles-tutorials.yaml file
14+
fields: [title, description, categories, image]
1115
sort:
1216
- within_cat_order
1317
---
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
# use this file to define tutorials in the "principles" section that
3+
# should not have their own page for e.g. an embedded video or other content
4+
5+
# NOTE: if you add tutorials here, be sure to also update training/self_training.qmd
6+
# to remove the line "- "!principles/principles-tutorials.yaml""

training/publishing_outputs/code_publishing.qmd

Lines changed: 0 additions & 21 deletions
This file was deleted.

0 commit comments

Comments
 (0)