Skip to content

Commit f4e6a4a

Browse files
authored
Merge branch 'main' into dependabot/submodules/data/datasets/examples-789cc7a
2 parents 871884c + d4a090e commit f4e6a4a

19 files changed

+133
-306
lines changed

.github/workflows/deploy.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
---
22
name: Publish docs via GitHub Pages
3+
34
on:
45
push:
56
branches:
67
- main
78

9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
12+
13+
# Force to use color
14+
env:
15+
FORCE_COLOR: true
16+
817
jobs:
918
build:
1019
name: Deploy docs
@@ -21,6 +30,14 @@ jobs:
2130
with:
2231
python-version: 3.12
2332

33+
- name: Set up node
34+
uses: actions/setup-node@v4
35+
with:
36+
node-version: 14
37+
38+
- name: Install dependencies and update content from submodules
39+
run: make all
40+
2441
- name: Deploy docs
2542
uses: mhausenblas/mkdocs-deploy-gh-pages@master
2643
env:

.github/workflows/linkcheck.yml

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
name: Validation
2+
name: Checklinks
33

44
on:
55
push:
66
branches: [main]
7+
pull_request:
78

89
concurrency:
910
group: ${{ github.workflow }}-${{ github.ref }}
@@ -18,9 +19,26 @@ jobs:
1819
link-check:
1920
runs-on: ubuntu-latest
2021
steps:
21-
- uses: actions/checkout@v4
22+
23+
- name: Checkout
24+
uses: actions/checkout@v4
25+
with:
26+
submodules: recursive
27+
fetch-depth: 0
28+
29+
- name: Set up Python
30+
uses: actions/setup-python@v5
2231
with:
23-
submodules: true
32+
python-version: 3.12
33+
34+
- name: Set up node
35+
uses: actions/setup-node@v4
36+
with:
37+
node-version: 14
38+
39+
- name: Install dependencies and update content from submodules
40+
run: make all
41+
2442
- uses: gaurav-nelson/github-action-markdown-link-check@v1
2543
with:
2644
use-quiet-mode: yes

CONTRIBUTING.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,14 @@ make sure you also read the instructions below.
1919
### Requirements
2020

2121
- python >= 3.10
22+
- node.js >= ???
23+
- npm >= ???
2224

23-
Even though this is not required, having `make` installed
24-
will make it easier to easily serve the website locally.
25+
<!-- TODO find minimal version of node and npm
26+
For some quality checks and rare operations, you will need node.js and npm. -->
27+
28+
Even though this is not required,
29+
having `make` installed will make it easier to easily serve the website locally.
2530

2631
### Install and serve
2732

@@ -39,7 +44,18 @@ Install all the dependencies.
3944
pip install -r requirements.txt
4045
```
4146

42-
Generate all the content required for the build.
47+
Generate all the content required for the build:
48+
49+
- copies some pages from the specification repo
50+
51+
- updates the list of contributors
52+
53+
- generates the page for each BEP based on its metadata
54+
55+
- updates the list of BIDS examples
56+
57+
- generates all the 'plotly' interactive plots as html files in the `tmp` folder
58+
that will be 'injected' in the website as snippets (with `--8<--`)
4359

4460
```bash
4561
make update
@@ -60,8 +76,6 @@ Same as for the install but you will also need to install `tox`.
6076
```bash
6177
pip install tox
6278
```
63-
<!-- TODO find minimal version of node and npm -->
64-
For some quality checks and rare operations, you will need node.js and npm.
6579

6680
## Update all files
6781

@@ -75,3 +89,12 @@ make update
7589
tox
7690
make remark
7791
```
92+
93+
## Updating the `requirements.txt`
94+
95+
Update the appropriate line `requirements.in` and run:
96+
97+
```bash
98+
python -m pip install pip-tools
99+
pip-compile --strip-extras requirements.in
100+
```

docs/blog/posts/2020-03-12-steering-group-minutes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The plan is that there should be multiple people committed to the repository (ot
2727
[CODEOWNERS file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#about-code-owners)
2828
at the top level), there should be a code of conduct in the repository that is consistent with that of the BIDS specification, and (as a consequence of the code of conduct) the repository should welcome contributions from others.
2929

30-
We want to host another [Community Forum](https://bids.neuroimaging.io/2020/01/02/announcement-community-forum-events.html) (but not too frequent) and potentially a starter kit/demo in the Open Science Room at [OHBM](https://www.humanbrainmapping.org).
30+
We want to host another [Community Forum](https://bids.neuroimaging.io/blog/2020/01/02/Announcing%20Community%20Forum%20Events.html) (but not too frequent) and potentially a starter kit/demo in the Open Science Room at [OHBM](https://www.humanbrainmapping.org).
3131

3232
Regarding discussions on where to host our historical specification pdfs (please refer to issue [#407](https://github.com/bids-standard/bids-specification/pull/407)), we consider [Zenodo](https://zenodo.org/) to be a suitable location to store our specification pdfs.
3333

docs/blog/posts/2020-03-23-steering-group-minutes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ The Steering Group gave direction on handling author lists on Zenodo - make it a
4949

5050
## Minutes
5151

52-
- Reviewed [previous meeting action items](https://bids.neuroimaging.io/2020/03/12/Steering-Group-executive-summary,-action-items,-and-minutes.html#action-items)
52+
- Reviewed [previous meeting action items](https://bids.neuroimaging.io/blog/2020/03/12/Steering%20Group%20minutes.html#action-items)
5353

54-
- A [survey](https://docs.google.com/forms/d/e/1FAIpQLSfGjTA-U_1LECRsbuBQ9X7kdi34aEdxTMoWCwwkEgou-qpb4A/viewform) with an accompanying [blog post](https://bids.neuroimaging.io/2020/03/20/engage-with-the-bids-ecosystem.html) was drafted to evaluate how the community would like to engage with each other, what barriers may exist that makes engaging more challenging, and ways that we can engage colleagues that do not know about BIDS.
54+
- A [survey](https://docs.google.com/forms/d/e/1FAIpQLSfGjTA-U_1LECRsbuBQ9X7kdi34aEdxTMoWCwwkEgou-qpb4A/viewform) with an accompanying [blog post](https://bids.neuroimaging.io/blog/2020/03/20/engage%20with%20the%20bids%20ecosystem.html) was drafted to evaluate how the community would like to engage with each other, what barriers may exist that makes engaging more challenging, and ways that we can engage colleagues that do not know about BIDS.
5555

5656
- Points to consider when designing the infrastructure to support BIDS slides
5757

docs/blog/posts/2020-06-18-steering-group-minutes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ categories:
1212

1313
We discussed and decided on utilizing the [BrainHack Mattermost platform][brainhack_mattermost] for our instant messaging solution. This fits nicely into where our community has been informally organized.
1414

15-
We went over our BIDS presentations occurring in the [Open Science Room](https://ohbm.github.io/osr2020/schedule/) at [OHBM](https://www.humanbrainmapping.org/i4a/pages/index.cfm?pageID=3885). We are sharing on the website [all the BIDS presentations and posters](https://bids.neuroimaging.io/2020/06/19/BIDS-OHBM-OSR-2020.html) happening at OHBM. There are many BIDS-aware tools being developed, but an emphasis should be put on generating the associated documentation.
15+
We went over our BIDS presentations occurring in the [Open Science Room](https://ohbm.github.io/osr2020/schedule/) at [OHBM](https://www.humanbrainmapping.org/i4a/pages/index.cfm?pageID=3885). We are sharing on the website [all the BIDS presentations and posters](https://bids.neuroimaging.io/blog/2020/06/19/BIDS%20at%20OHBM%202020.html) happening at OHBM. There are many BIDS-aware tools being developed, but an emphasis should be put on generating the associated documentation.
1616

1717
## Action Items
1818

19-
| Action items |
20-
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21-
| [Website post announcing our intention of joining the BrainHack Mattermost](https://bids.neuroimaging.io/2020/06/24/Join-the-BIDS-community-on-the-BrainHack-Mattermost.html) |
22-
| [Website post listing the BIDS sessions and posters at OHBM](https://bids.neuroimaging.io/2020/06/19/BIDS-OHBM-OSR-2020.html) |
19+
| Action items |
20+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
21+
| [Website post announcing our intention of joining the BrainHack Mattermost](https://bids.neuroimaging.io/blog/2020/06/24/Join%20the%20BIDS%20community%20on%20the%20BrainHack%20Mattermost.html) |
22+
| [Website post listing the BIDS sessions and posters at OHBM](https://bids.neuroimaging.io/blog/2020/06/19/BIDS%20at%20OHBM%202020.html) |
2323

2424
## Minutes
2525

docs/blog/posts/announcement-community-forum-events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: Kirstie Whitaker
66

77
## Join the first BIDS Community Forum events in January 2020
88

9-
The [BIDS Steering Group](https://bids.neuroimaging.io/2019/12/31/meet-the-bids-steering-group.html) are excited to announce two **Community Forums**!
9+
The [BIDS Steering Group](https://bids.neuroimaging.io/blog/2019/12/31/meet%20the%20bids%20steering%20group.html) are excited to announce two **Community Forums**!
1010

1111
<!-- more -->
1212

docs/blog/posts/bids-news-september-2024.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ BIDS continues to be featured in different venues. Our very own maintainer extra
5353

5454
The BEPs carry on to help us all update the standard with new and previously unestablished data types and improvements. If there's a BEP here that affects you, consider getting involved by commenting on open Google Docs or GitHub pull requests or contacting the leads listed in the BEP. Here’s some of our newest BEPs.
5555

56-
- [BEP041](https://bids.neuroimaging.io/bep041): Statistical Model (Taylor Salo)
57-
- [BEP042](https://bids.neuroimaging.io/bep042): Electromyography (Seyed Yahya Shirazi)
58-
- [BEP043](https://bids.neuroimaging.io/bep043): Term mapping (Chris Markiewicz & Eric Earl)
59-
- [BEP044](https://bids.neuroimaging.io/bep044): Stimuli (Seyed Yahya Shirazi)
56+
- [BEP041]("https://bids.neuroimaging.io/extensions/beps/bep_041.html"): Statistical Model (Taylor Salo)
57+
- [BEP042]("https://bids.neuroimaging.io/extensions/beps/bep_042.html"): Electromyography (Seyed Yahya Shirazi)
58+
- [BEP043]("https://bids.neuroimaging.io/extensions/beps/bep_043.html"): Term mapping (Chris Markiewicz & Eric Earl)
59+
- [BEP044]("https://bids.neuroimaging.io/extensions/beps/bep_044.html"): Stimuli (Seyed Yahya Shirazi)
6060

6161
Other BEPs are listed on [the BIDS website](https://bids.neuroimaging.io/extensions/beps.html).
6262

docs/blog/posts/steering-group-election-2021.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The nomination period will close on Friday, October 1st at 11:59pm (Pacific time
1111

1212
<!-- more -->
1313

14-
This new member will be taking the place of our outgoing member, [Kirstie Whitaker](https://bids.neuroimaging.io/2019/12/31/meet-the-bids-steering-group.html#kirstie-whitaker-).
14+
This new member will be taking the place of our outgoing member, [Kirstie Whitaker](https://bids.neuroimaging.io/blog/2019/12/31/Meet%20the%20BIDS%20Steering%20Group.html#kirstie-whitaker).
1515
While submitting your nomination, we please ask to prepare a brief description of what you would add to the Steering Group if elected and include it within [this form](https://forms.gle/JDryfJRLP2AiHVPg9).
1616
We are looking to maintain and enhance our range of diverse perspectives and experiences currently present on the Steering Group.
1717
To learn more about the Steering Group, please take a few minutes and watch a [recent video discussing this](https://www.youtube.com/watch?v=-c4PUhTwmz4).

docs/blog/posts/v1.9.0-release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ BIDS-Motion makes motion data interoperable across different laboratories and wi
1616

1717
We would like to thank contributors to this BEP, led by Sein Jeung and Julius Welzel with significant contributions from Helena Cockx and others.
1818

19-
Check out the [preprint associated with this BEP](https://osf.io/preprints/psyarxiv/w6z79/).
19+
Check out the [preprint associated with this BEP](https://osf.io/preprints/psyarxiv/w6z79_v1/).
2020

2121
Example datasets for motion data can be found on our [BIDS example repository][bids_examples_gh]:
2222

0 commit comments

Comments
 (0)