Skip to content

Commit

Permalink
[ENH] Update standards section (#534)
Browse files Browse the repository at this point in the history
* rm bids stats model

* rm bids apps spec

* rm bids apps spec

* update index

* update spec

* clean up

* update makefile

* lint

* test

* fixes

* fix

* fix
  • Loading branch information
Remi-Gau authored Oct 18, 2024
1 parent 81c6426 commit 217b135
Show file tree
Hide file tree
Showing 25 changed files with 108 additions and 782 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/check_md_links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ jobs:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: no
use-verbose-mode: no
use-quiet-mode: yes
# use-verbose-mode: no
config-file: md_link_check_config.json
folder-path: docs
file-path: ./README.md
12 changes: 0 additions & 12 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,18 +1,6 @@
[submodule "specification"]
path = specification
url = https://github.com/bids-standard/bids-specification.git
[submodule "execution-spec"]
path = execution-spec
url = https://github.com/bids-standard/execution-spec
datalad-url = https://github.com/bids-standard/execution-spec
[submodule "docs/standards/bids_stats_model/variable-transform"]
path = docs/standards/bids_stats_model/variable-transform
url = https://github.com/bids-standard/variable-transform.git
datalad-url = https://github.com/bids-standard/variable-transform.git
[submodule "docs/standards/bids_stats_model/src"]
path = docs/standards/bids_stats_model/src
url = https://github.com/bids-standard/stats-models
datalad-url = https://github.com/bids-standard/stats-models
[submodule "data/datasets/examples"]
path = data/datasets/examples
url = https://github.com/bids-standard/bids-examples
Expand Down
3 changes: 1 addition & 2 deletions .remarkignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
docs/collaboration/bids_github/
docs/datasets/index.md
docs/getting_started/folders_and_files/files.md
docs/standards/bids_stats_model/src
docs/standards/bids_stats_model/variable-transform
docs/specification/macros_doc.md
2 changes: 1 addition & 1 deletion docs/collaboration/bids_github
118 changes: 61 additions & 57 deletions docs/collaboration/contributors.md

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions docs/collaboration/governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ they should inform the steering group in advance and are responsible to help:

{{ MACROS___generate_members_table(file="advisory.yml") }}

### Other working/interest Groups
### Other working groups

A working/interest group can be established under the approval of the BIDS Steering Group.
This is typically but not limited to being formed for the purpose of advancing the BIDS community, not the standard.
Expand Down Expand Up @@ -486,8 +486,7 @@ Anonymous data from BIDS elections is stored in a dedicated repository on GitHub

### H. Governance amendment procedure

A group of BIDS contributors may at any time form a [working
group](#other-workinginterest-groups) to propose amendments to the governance.
A group of BIDS contributors may at any time form a [working group](#other-working-groups) to propose amendments to the governance.
These amendments will be first reviewed by the Steering Group before being
submitted to a community review.
At the end of the community review each amendment is submitted to a vote of BIDS
Expand Down
2 changes: 1 addition & 1 deletion docs/collaboration/working-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ to improve the documentation around BIDS...

## Forming a working group

The rules to form a working group are mentioned in the [governance](./governance.md#other-workinginterest-groups).
The rules to form a working group are mentioned in the [governance](./governance.md#other-working-groups).

A template for the open-letter can be found in [this google doc](https://docs.google.com/document/d/1JfTliUcpyRAGdiZSHObkvZFdkrxPTclQTvolr8ssNHM/edit).

Expand Down
22 changes: 0 additions & 22 deletions docs/standards/bids_app_specification/contributors.md

This file was deleted.

11 changes: 3 additions & 8 deletions docs/standards/bids_app_specification/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
# BIDS Apps execution specification

## The Problem

Neuroimaging is a field with an enormous library of powerful tools
and openly available datasets that can be difficult to get to work together.

## Why do we need the BIDS Application Specification?
# BIDS Apps

While BIDS is great for standardizing datasets, analytical tools can take a variety of forms, arguments,
and complexities, limiting their ability to be applied interchangeably.
The BIDS Application Specification solves this problem
by creating a community-driven standardized structure for software definitions and their execution.

The specification for the BIDS apps can be [browsed online](https://bids-standard.github.io/execution-spec/).
80 changes: 0 additions & 80 deletions docs/standards/bids_app_specification/scope.md

This file was deleted.

113 changes: 0 additions & 113 deletions docs/standards/bids_app_specification/specification/examples.md

This file was deleted.

33 changes: 0 additions & 33 deletions docs/standards/bids_app_specification/specification/index.md

This file was deleted.

Loading

0 comments on commit 217b135

Please sign in to comment.