Skip to content

Commit 963dd1b

Browse files
authored
[MAINT] run remark as frail (#530)
* run remark as frail * improve config and fix * Update docs/datasets/index.md
1 parent cb618b7 commit 963dd1b

File tree

6 files changed

+55
-48
lines changed

6 files changed

+55
-48
lines changed

.remarkignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
docs/collaboration/bids_github/
2+
docs/datasets/index.md
3+
docs/getting_started/folders_and_files/files.md
4+
docs/standards/bids_stats_model/src
5+
docs/standards/bids_stats_model/variable-transform

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

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,32 @@ The BIDS Maintainers, Steering Group, working groups, and other contributors hav
1616

1717
The BIDS specification has released a new minor version\! The highlights are:
1818

19-
* Integrating BEP022 for Magnetic Resonance Spectroscopy
20-
* Publishing the BIDS schema to [JavaScript Registry](https://jsr.io/@bids/schema)
21-
* For the full list of changes, you can read [the changelog](https://bids-specification.readthedocs.io/en/stable/CHANGES.html#v1100-2024-09-06)
19+
- Integrating BEP022 for Magnetic Resonance Spectroscopy
20+
- Publishing the BIDS schema to [JavaScript Registry](https://jsr.io/@bids/schema)
21+
- For the full list of changes, you can read [the changelog](https://bids-specification.readthedocs.io/en/stable/CHANGES.html#v1100-2024-09-06)
2222

2323
## Schema-based BIDS validator deployed on validator site
2424

2525
A culmination of years of hard work, the schema-based validator makes maintenance of the validator and inclusion of new rules more sustainable (and very reusable).
2626

27-
The “schema” is a machine readable set of definitions and rules for BIDS. The new validator now makes use of this schema by reading the different rules from it and checking if a dataset complies with them. With this new BIDS validator, it will be easier to start validating new data types, but also to start validating derivatives, an issue that has blocked some BIDS extensions for years. You can try it out now on the [BIDS validator website](https://bids-standard.github.io/bids-validator) and it will soon replace the “legacy” validator.
27+
The “schema” is a machine readable set of definitions and rules for BIDS.
28+
The new validator now makes use of this schema by reading the different rules from it and checking if a dataset complies with them.
29+
With this new BIDS validator, it will be easier to start validating new data types, but also to start validating derivatives, an issue that has blocked some BIDS extensions for years.
30+
You can try it out now on the [BIDS validator website](https://bids-standard.github.io/bids-validator) and it will soon replace the “legacy” validator.
2831

2932
## BIDS website is currently in transition
3033

31-
With the support of INCF, Google Season of Docs, BIDS maintainer mentors, and a technical writer, BIDS has been able to improve its online presence. Instead of a large collection of websites, we now have one central site and only a few separate specification/standards sites. You can preview it at [its temporary site](https://bids-website.readthedocs.io/) now. Expect it to replace the current BIDS website around the end of this year.
34+
With the support of INCF, Google Season of Docs, BIDS maintainer mentors, and a technical writer, BIDS has been able to improve its online presence.
35+
Instead of a large collection of websites, we now have one central site and only a few separate specification/standards sites.
36+
You can preview it at [its temporary site](https://bids-website.readthedocs.io/) now.
37+
Expect it to replace the current BIDS website around the end of this year.
3238

3339
You can also provide feedback now with our [BIDS website survey](https://cryptpad.fr/form/#/2/form/view/f3b2wVPL5VK1HhvBNwtW3-4LXeEpJ9xMY+uOaoahyqQ/), open until October 1st, 2024\.
3440

3541
## BIDS election on the horizon
3642

37-
Per BIDS governance, the steering group members have a term of 3 years. This year, Ariel Rokem's term ends. Keep an eye out for the upcoming election which BIDS contributors can vote upon. And on behalf of the community, thank you so much Ariel for your service\!
43+
Per BIDS governance, the steering group members have a term of 3 years.
44+
This year, Ariel Rokem's term ends. Keep an eye out for the upcoming election which BIDS contributors can vote upon. And on behalf of the community, thank you so much Ariel for your service\!
3845

3946
You can find more [about BIDS governance](https://bids-website.readthedocs.io/en/latest/collaboration/governance.html) here.
4047

@@ -46,10 +53,10 @@ BIDS continues to be featured in different venues. Our very own maintainer extra
4653

4754
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.
4855

49-
* [BEP041](https://bids.neuroimaging.io/bep041): Statistical Model (Taylor Salo)
50-
* [BEP042](https://bids.neuroimaging.io/bep042): Electromyography (Seyed Yahya Shirazi)
51-
* [BEP043](https://bids.neuroimaging.io/bep043): Term mapping (Chris Markiewicz & Eric Earl)
52-
* [BEP044](https://bids.neuroimaging.io/bep044): Stimuli (Seyed Yahya Shirazi)
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)
5360

5461
Other BEPs are listed on [the BIDS website](https://bids-website.readthedocs.io/en/latest/extensions/beps.html).
5562

docs/blog/posts/town-hall-2024-debrief.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,12 @@ The slides can be found on our [Open-science Framework project](https://osf.io/5
5555
- potential BEP: "Peripheral" physiological signals <!-- TODO add link -->
5656

5757
- BIDS Connectivity Project Updates
58+
5859
- 7 BEPS
60+
5961
- **lessons learned**: there is no procedure for addressing and resolving BEP feedback,
6062
establishing a timeline would help to continue progress
63+
6164
- **Suggestions**: clarify roles and responsibilities of BEP leads, define timelines for BEP tasks
6265

6366
- BIDS 2.0 (*Yaroslav Halchenko*)

docs/collaboration/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Help make BIDS better!
22

3-
BIDS is informed, supported, and guided by its users. BIDS standards are intended to change and evolve as methods, resources, and the needs of the BIDS community changes. We encourage all researchers to contribute to the ongoing development of BIDS standards, be it through discussion on websites, the creation of new BIDS tools, or contributing to extending the BIDS specification through proposals. Below is a list of common resources where users can get involved in making the BIDS standard better!
3+
BIDS is informed, supported, and guided by its users.
4+
BIDS standards are intended to change and evolve as methods, resources,
5+
and the needs of the BIDS community changes.
6+
We encourage all researchers to contribute to the ongoing development of BIDS standards,
7+
be it through discussion on websites, the creation of new BIDS tools,
8+
or contributing to extending the BIDS specification through proposals.
9+
Below is a list of common resources where users can get involved in making the BIDS standard better!
410

511
<u>Neurostars Website</u>
612

docs/extensions/general-guidelines.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -44,66 +44,68 @@ Development on Google Docs is preferred as this is a low barrier to entry
4444
for colleagues who do not use GitHub and/or Markdown,
4545
allowing more people to get involved.
4646

47-
1. Explore [the specification][the bids specification repository]
47+
1. Explore [the specification][the bids specification repository]
4848
and [the BEP lists](./beps.md)
4949
to find existing or ongoing efforts
5050
that may support what you are trying to add into the BIDS Specification.
5151
Someone may have already done work for you.
5252

53-
1. Read the [BIDS governance document](../collaboration/governance.md).
53+
1. Read the [BIDS governance document](../collaboration/governance.md).
5454

55-
1. Familiarize yourself with the BIDS community by browsing current issues,
55+
1. Familiarize yourself with the BIDS community by browsing current issues,
5656
discussions, and proposed changes on
5757
[the bids specification repository].
5858
Search for issues relating to your feature or BEP idea
5959
before creating a new issue.
6060

61-
1. Open an initial “issue” on
61+
1. Open an initial “issue” on
6262
[the bids specification repository] issues page
6363
to gauge interest in your potential BEP, and to collect
6464
feedback by more community members and
6565
[BIDS maintainers](https://github.com/bids-standard/bids-specification/blob/master/DECISION-MAKING.md#maintainers-group).
6666
**This is an important step before proceeding in order to make sure that
6767
more consensus arises and more contributors are aware what is happening**.
6868

69-
1. Communicate with the BIDS maintainers to make your BEP official.
69+
1. Communicate with the BIDS maintainers to make your BEP official.
7070
This entails registering the BEP with a number on the BIDS website.
7171
To obtain a number for your BEP, follow the previous steps
7272
and then [open a new issue](https://github.com/bids-standard/bids-website/issues)
7373
or [submit a pull request](https://github.com/bids-standard/bids-website/pulls) to the
7474
[website GitHub repository](https://github.com/bids-standard/bids-website/),
7575
cross-linking to any other already existing issues.
7676

77-
1. Create a draft of your extension by discussing among colleagues. The
77+
1. Create a draft of your extension by discussing among colleagues. The
7878
[BIDS Extension Proposal template](https://docs.google.com/document/d/1W7--Mf3gCCb1mVfhsoRJCAKFhmf2umG1PFkyZ1jEgMw/edit#)
7979
provides some boilerplate and formatting conventions.
8080

81-
1. List on the draft the contributor(s) leading the effort.
81+
1. List on the draft the contributor(s) leading the effort.
8282

83-
1. Share the draft (remember to
83+
1. Share the draft (remember to
8484
[share a link that allows anyone to comment](https://support.google.com/docs/answer/2494822?co=GENIE.Platform%3DDesktop&hl=en))
8585
with the
8686
[bids-discussion mailing list](https://groups.google.com/forum/#!forum/bids-discussion)
8787
and ask for comments.
8888

89-
1. Incorporate the feedback and strive for consensus.
89+
1. Incorporate the feedback and strive for consensus.
9090

91-
1. Help to merge the extension into the main specification (this will require
92-
converting the proposal to Markdown and submitting a Pull Request at
93-
[the bids specification repository])
91+
1. Help to merge the extension into the main specification
92+
(this will require converting the proposal to Markdown
93+
and submitting a Pull Request at [the bids specification repository])
9494

95-
1. Create example datasets. Complete source data (for example DICOM, EDF, Excel) and its
96-
corresponding target BIDS datasets, _must be_ supplied along with instructions on how
97-
to transform data from source to target. When possible, data from multiple vendors
95+
1. Create example datasets. Complete source data (for example DICOM, EDF, Excel) and its
96+
corresponding target BIDS datasets,
97+
_must be_ supplied along with instructions on how to transform data from source to target.
98+
When possible, data from multiple vendors
9899
such as Siemens, Philips, or General Electric (in the case of MR) should be included.
99100
These datasets are vital for the development of resources that will, ultimately, increase the adoption of
100-
the BEP following its integration into the BIDS Specification; see [this discussion](https://github.com/bids-standard/bids-specification/issues/1350).
101+
the BEP following its integration into the BIDS Specification;
102+
see [this discussion](https://github.com/bids-standard/bids-specification/issues/1350).
101103
BIDS maintainers **are available to assist** in the collection, organization, or at
102104
any step in the preparation of these datasets.
103105

104-
1. If necessary, contribute a pull request to the
105-
[BIDS Validator repository](https://github.com/bids-standard/bids-validator)
106-
as well to incorporate the extension.
106+
1. If necessary, contribute a pull request
107+
to the [BIDS Validator repository](https://github.com/bids-standard/bids-validator)
108+
as well to incorporate the extension.
107109

108110
![bep_process](../assets/img/bep_process.png)
109111

makefile

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -58,22 +58,6 @@ lint: remark
5858

5959
remark: package.json
6060
npx remark \
61-
./docs/*.md \
62-
./docs/blog \
63-
./docs/collaboration \
64-
./docs/contact \
65-
./docs/datasets \
66-
./docs/extensions/*md \
67-
./docs/faq/ \
68-
./docs/getting_started/*.md \
69-
./docs/getting_started/bids_apps/**/*.md \
70-
./docs/getting_started/folders_and_files/**/*.md \
71-
./docs/getting_started/resources/**/*.md \
72-
./docs/getting_started/tutorials/**/*.md \
73-
./docs/impact \
74-
./docs/standards/bids_app_specification \
75-
./docs/standards/bids_specification \
76-
./docs/standards/schema \
77-
./docs/standards/index.md \
78-
./docs/tools \
61+
./docs \
62+
--frail \
7963
--rc-path .remarkrc

0 commit comments

Comments
 (0)