Skip to content

Commit ec47e09

Browse files
committed
Add link-checker config and fix docs links
1 parent 4ae5bd9 commit ec47e09

File tree

6 files changed

+29
-9
lines changed

6 files changed

+29
-9
lines changed

.github/workflows/linkcheck.yml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,16 @@ jobs:
2828
uses: actions/setup-python@v5
2929
with:
3030
python-version: 3.12
31+
- name: Install MkDocs
32+
run: pip install -r requirements.txt
3133

32-
- uses: tcort/github-action-markdown-link-check@v1
34+
- name: Build site
35+
run: mkdocs build
36+
37+
- name: Check links
38+
uses: tcort/github-action-markdown-link-check@v1
3339
with:
3440
use-quiet-mode: yes
35-
# use-verbose-mode: no
41+
config-file: .markdown-link-check.json
42+
folder-path: site
43+
file-extension: .html

.markdown-link-check.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"ignorePatterns": [
3+
{"pattern": "^http://127\\.0\\.0\\.1:8445"},
4+
{"pattern": "^http://192\\.168\\.99\\.100:8445"},
5+
{"pattern": "biorxiv\\.org"},
6+
{"pattern": "doi\\.org"},
7+
{"pattern": "toptal\\.com"},
8+
{"pattern": "^/"},
9+
{"pattern": "^\\.\\./\\.\\./assets/"},
10+
{"pattern": "^\\.\\./\\.\\./"}
11+
]
12+
}

docs/community/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ You're awesome. :wave::smiley:
389389
[link_stemmrolemodels]: https://github.com/KirstieJane/STEMMRoleModels
390390
[link_zenodo]: https://github.com/nipreps/fmriprep/blob/master/.zenodo.json
391391
[link_update_script]: https://github.com/nipreps/fmriprep/blob/master/.maint/update_authors.py
392-
[link_devel]: https://fmriprep.readthedocs.io/en/latest/contributors.html
392+
[link_devel]: https://fmriprep.org/en/stable/contributors.html
393393
[link_fmriprep]: http://fmriprep.org
394394
[link_bidsapps]: https://bids-apps.neuroimaging.io
395395
[link_mattermost]: https://mattermost.brainhack.org/brainhack/channels/fmriprep

docs/community/members.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ section.
1616

1717
Developers are members of a wonderful team _driving the project_.
1818
Names and contacts of all developers are included in the
19-
[`.maint/developers.json` file](https://github.com/nipreps/fmriprep/blob/master/.maint/developers.json) of each project.
19+
[`.maint/developers.json` file](https://github.com/nipreps/fmriprep/blob/main/.maint/developers.json) of each project.
2020
Examples of steering activities that _drive the project_ are: actively participating in the
2121
follow-up meetings, leading documentation sprints, helping in the design of the tool and definition of the roadmap,
2222
providing resources (in the broad sense, including funding), code-review, etc.
2323

2424
### Contributors
2525

2626
Contributors enlisted in the
27-
[`.maint/contributors.json` file](https://github.com/nipreps/fmriprep/blob/master/.maint/contributors.json) of each project
27+
[`.maint/contributors.json` file](https://github.com/nipreps/fmriprep/blob/main/.maint/contributors.json) of each project
2828
actively help or have previously helped the project in a broad sense: writing code, writing documentation,
2929
benchmarking modules of the tool, proposing new features, helping improve the scientific
3030
rigor of implementations, giving out support on the different communication
@@ -37,7 +37,7 @@ Before every release, unlisted contributors will be invited again to add their n
3737

3838
Contributors who have contributed at some point to the project but were required or they wished to
3939
disconnect from the project's updates and to drop-out from publications and other dissemination activities,
40-
are listed in the [`.maint/former.json` file](https://github.com/nipreps/fmriprep/blob/master/.maint/former.json).
40+
are listed in the [`.maint/former.json` file](https://github.com/nipreps/fmriprep/blob/main/.maint/former.json).
4141

4242

43-
[link_neurostars]: https://neurostars.org
43+
[link_neurostars]: https://neurostars.org

docs/devs/devenv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ INFO - No authentication
154154
INFO - Not serving HTTPS
155155
```
156156

157-
Now you can switch to your favorite browser and go to: [127.0.0.1:8445](http://127.0.0.1:8445) (or [192.168.99.100:8445](http://192.168.99.100:8445) for Docker Toolbox).
157+
Now you can switch to your favorite browser and go to: `http://127.0.0.1:8445` (or `http://192.168.99.100:8445` for Docker Toolbox).
158158

159159
**3. Copy `fmriprep.egg-info` into your `fmriprep/` project directory**
160160
`fmriprep.egg-info` makes the package executable inside the docker container.

docs/users/educational.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
## QC protocols and Standard Operating Procedures
2020

21-
- [SOPs-cookiecutter, a template repository for version-controlled SOPs](https//github.com/nipreps/sops-cookiecutter). The example template is rendered [here](/sops-cookiecutter/)
21+
- [SOPs-cookiecutter, a template repository for version-controlled SOPs](https://github.com/nipreps/sops-cookiecutter). The example template is rendered [here](/sops-cookiecutter/)
2222

2323
## Presentation
2424
- [Educational Talk at OHBM 2023 - Quality Control in fMRI studies with MRIQC and fMRIPrep](../../assets/OHBM2023/QCTalkOHBM23CelineProvins.pdf)

0 commit comments

Comments
 (0)