Skip to content

Commit 372fc62

Browse files
improve page formatting and consistency of titles and links
1 parent de8ca2e commit 372fc62

22 files changed

+73
-86
lines changed

_posts/2023-09-26-release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ FieldTrip version [20230926](http://github.com/fieldtrip/fieldtrip/releases/tag/
1313
- Major changes to fieldtrip2fiff to facilitate exchangeability between FieldTrip and MNE-python through the fif-file format.
1414
- Improvements for the support for BIDS derivatives.
1515
- Major improvements of the [testing framework](https://www.fieldtriptoolbox.org/development/testing/), facilitating tests to be run by people external to the DCCN.
16-
- Implementation of Github actions to suggest tests to run to evaluate the integrity of their Pull Requests.
16+
- Implementation of GitHub actions to suggest tests to run to evaluate the integrity of their Pull Requests.
1717
- Support for files created by the SimNIBS software.
1818
- Improved handling of surface/volume meshes for advanced volume conduction modelling.
1919
- Better user experience in ft_sourceplot.

development.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ For keeping track of new ideas, feature requests and bugs, we use an [issue trac
1111

1212
The source code in the FieldTrip toolbox is split over multiple directories reflecting its [modular organization](/development/architecture/#modular-organization). This facilitates a separation between high-level functions that do data bookkeeping, and low-level functions that focus on the algorithms.
1313

14-
We use a combination of tools (GitHub, Mastodon, website, mailman) that are loosely linked to each other; for example, every news item on the website is automatically tweeted. An overview is presented on the [integration](/development/integration) page.
14+
We use a combination of tools (GitHub, BlueSky, website, mailman) that are loosely linked to each other; for example, every news item on the website is automatically tweeted. An overview is presented on the [integration](/development/integration) page.
1515

16-
- [Contribute to the development](/development/contribute)
16+
- [Contribute](/development/contribute)
1717
- [Guidelines](/development/guideline)
18+
- [Software architecture](/development/architecture)
19+
- [Data structures](/development/datastructure)
20+
- [Release and quality control](/development/releasing)
1821
- [Testing](/development/testing)
19-
- [Toolbox architecture](/development/architecture)
20-
- [Data Structures](/development/datastructure)
21-
- [Distributed computing](/development/distributed)
22-
- [Realtime](/development/realtime)
22+
- [ntegration between tools](/development/integration)
2323
- [Projects](/development/project)
2424
- [Meetings](/development/meeting)
25-
- [Integration](/development/integration)
26-
- [Software quality control and release process](/development/releasing)
25+
- [Real-time data processing](/development/realtime)
26+
- [Distributed computing](/development/distributed)

development/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Toolbox architecture and organization of the source code
2+
title: Software architecture
33
tags: [development]
44
redirect_from:
55
- /development/module/
66
---
77

8-
# Toolbox architecture and organization of the source code
8+
# Software architecture
99

1010
{% include markup/skyblue %}
1111
The **[ft_examplefunction](/reference/ft_examplefunction)** provides a documented walkthrough of a typical high-level FieldTrip function that demonstrates a lot of the features presented below.

development/datastructure.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Data structures used by FieldTrip
2+
title: Data structures
33
tags: [development]
44
---
55

6-
# Data structures used by FieldTrip
6+
# Data structures
77

8-
High-level FieldTrip functions usually expect input data as a MATLAB structure in a specific format, and produce output data. The data is represented as MATLAB structures which are documented in the following helper functions:
8+
High-level FieldTrip functions expect input data as a MATLAB structure, and produce output data as a MATLAB structure. The input and output data structures are documented in the following helper functions:
99

1010
- **[ft_datatype_comp](/reference/utilities/ft_datatype_comp)**
1111
- **[ft_datatype_dip](/reference/utilities/ft_datatype_dip)**

development/getting_started.md

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

development/guideline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ There are some guidelines to aid in the continued development of the code and do
1111
- Guidelines for the [templates](/development/guideline/templates)
1212
- Guidelines for the [documentation](/development/guideline/documentation)
1313
- Guidelines for the [communication](/development/guideline/communication)
14-
- Guidelines for the [website page formatting](/development/guideline/website)
14+
- Guidelines for the [website syntax and formatting](/development/guideline/website)

development/guideline/communication.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ To communicate with and reach a wide audience, we use the following channels
1010
- this website, for documentation
1111
- the email [discussion list](/discussion_list), for interactions among users to help each other out
1212
- [GitHub](https://github.com/fieldtrip), for interaction between developpers
13-
- [Mastodon](https://fosstodon.org/@fieldtriptoolbox), for release announcements and news items
13+
- [Mastodon](https://fosstodon.org/@fieldtriptoolbox) and [BlueSky](https://bsky.app/profile/fieldtriptoolbox.bsky.social), for release announcements and news items
1414

1515
With each of these we reach out to a specific group FieldTrip stakeholders but - although they are partially overlapping - there is none through which we reach everyone.
1616

1717
## News items and releases
1818

19-
These are to be announced on the website and on Mastodon.
19+
These are to be announced on the website, Mastodon and BlueSky.
2020

2121
To add a news item to the website, please file a pull request adding a new file to the [\_posts folder on the website](https://github.com/fieldtrip/website/tree/master/_posts). See example files there for how these (markdown) files should be structured. The latest files flagged as `category: news` will, when merged, appear on the homepage.
2222

development/integration.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,19 @@ We use <https://jekyllrb.com> for our website. The markdown documents are hosted
1212

1313
## Mailman
1414

15-
We use this for a number of email discussion lists. It is hosted by C&CZ at <http://mailman.science.ru.nl>.
15+
We use this for the email discussion list. It is hosted by C&CZ at <http://mailman.science.ru.nl>.
1616

1717
## Mastodon
1818

1919
We use <https://fosstodon.org/@fieldtriptoolbox> to notify people about new releases and other updates.
2020

21+
## BlueSky
22+
23+
We use <https://bsky.app/profile/fieldtriptoolbox.bsky.social> to notify people about new releases and other updates.
24+
2125
## Bitly
2226

23-
We use <https://bitly.com> to automatically create short URLs that are included in the tweets.
27+
We use <https://bitly.com> to automatically create short URLs that are included in social media posts.
2428

2529
## Shields
2630

@@ -32,15 +36,15 @@ We use a YouTube [video channel](https://www.youtube.com/fieldtriptoolbox) that
3236

3337
## GitHub
3438

35-
We use git and GitHub for version control of the software and of the website, and for managing external contributions. More details can be found [here](/development/git). We also maintain a copy of the repository on [BitBucket](#bitbucket) and on [Gitlab](#gitlab).
39+
We use git and GitHub for version control of the software and of the website, and for managing external contributions. More details can be found [here](/development/git). We also maintain a copy of the repository on [BitBucket](#bitbucket) and on [GitLab](#gitlab).
3640

3741
If changes are pushed to GitHub, a webhook is triggered. The code for that is maintained at <https://github.com/fieldtrip/automation>.
3842

3943
## Bitbucket
4044

4145
A copy of the git repository of the FieldTrip software is maintained on <https://bitbucket.org/fieldtriptoolbox/fieldtrip>, although the primary site is on [GitHub](#GitHub).
4246

43-
## Gitlab
47+
## GitLab
4448

4549
A copy of the git repository of the FieldTrip software is stored on <https://gitlab.com/fieldtrip/fieldtrip>, although the primary site is on [GitHub](#GitHub).
4650

@@ -58,7 +62,7 @@ At the DCCN we have a central storage system (i.e. a large shared network drive)
5862

5963
## Dashboard
6064

61-
We have a set of MATLAB and Bash scripts for regression testing. This allows to do semi-automatic runs of all the test scripts on the DCCN compute cluster. We refer to this as the [test dashboard](/development/testing). The code is hosted on [GitHub](https://github.com/fieldtrip/dashboard) and the MATLAB interface is implemented in **[ft_test](/reference/utilities/ft_test)**, which you can find in the utilities folder.
65+
We have a set of MATLAB and Bash scripts for regression testing that are hosted on [GitHub](https://github.com/fieldtrip/dashboard). This allows to do semi-automatic runs of all the test scripts on the DCCN compute cluster. We refer to this as the [test dashboard](/development/testing).
6266

6367
## Mixpanel
6468

@@ -72,25 +76,25 @@ We are experimenting with [Slack](https://fieldtriptoolbox.slack.com) as a messa
7276

7377
We use a [webdav server](https://download.fieldtriptoolbox.org) to distribute the software releases and tutorial data.
7478

75-
## Ftp - obsolete
79+
## FTP - obsolete
7680

77-
We used the DCCN [download server](https://download.fieldtriptoolbox.org/) to distribute the software releases and tutorial data.
81+
In the past we used an FTP server to distribute the software releases and tutorial data.
7882

7983
## Bugzilla - obsolete
8084

8185
In the past we used [Bugzilla](https://www.bugzilla.org) as an "issue tracker" to maintain to-do lists, distribute work, and to support follow-up communication with users. Our bugzilla server has been discontinued in 2024. The archived bug reports and discussions are still available on <http://bugzilla.fieldtriptoolbox.org>.
8286

8387
## Dokuwiki - obsolete
8488

85-
In the past we used [dokuwiki](http://dokuwiki.org/) as the CMS system for our website. In 2018 we switched to Jekyll and GitHub.
89+
In the past we used [dokuwiki](http://dokuwiki.org/) as the content management system (CMS) for our website. In 2018 we switched to Jekyll and GitHub.
8690

8791
## SVN - obsolete
8892

8993
We used to do the development with Subversion (also known as SVN). As of February 2016 we have moved all development over to git and GitHub.
9094

9195
## CVS - obsolete
9296

93-
We initially used Concurrent Versions System (CVS) as the version control system. At a certain point we followed the example from the SPM developers and switched to SVN to facilitate collaboration between more contributors.
97+
We initially used the Concurrent Versions System (CVS) for software version control. At a certain point we followed the example from the SPM developers and switched to SVN to facilitate collaboration with contributors.
9498

9599
## Google Code - obsolete
96100

@@ -110,4 +114,4 @@ We used <http://facebook.com/fieldtriptoolbox> to announce events and to post ph
110114

111115
## Twitter - obsolete
112116

113-
We used <http://twitter.com/fieldtriptoolbx> to notify people about new releases and other updates. For some time we also tweeted an automatic update for every commit. We are now using Mastodon instead of Twitter.
117+
We used <http://twitter.com/fieldtriptoolbx> to notify people about new releases and other updates. For some time we also tweeted an automatic update for every commit. We are now using Mastodon and BlueSky instead of Twitter.

development/project/code_review.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ However, this goal is at odds with the architecture decision to give the utiliti
208208

209209
- For modules that are provided as separate repositories, since the modules will need more than just their own directory from the main FieldTrip repository, the module repository should be set up such that it is easy to synchronize all the needed parts from the FieldTrip repository to the module repository.
210210

211-
**Additional recommendation** : For modules that are provided as separate repositories, create a script in the module repository that largely automates the synchronization of the various parts (submodule, utilities, tests) from FieldTrip towards the module repositories. Then use it in a Github action that automates even more steps of the synchronization. The Github action can be set to automatically run whenever a new FieldTrip release is created, or triggered manually. And can add the changes directly to the main branch of the module repository, or only create a branch-and-pull- request that is first tested independently (for instance by a github action in the module repository) before the changes are added to the main branch of the module repository. Since the source is here the main FieldTrip repository, letting this workflow run fully through automated triggers is more feasible than for the externals in FieldTrip, where the source of the changed code is outside of FieldTrip.
211+
**Additional recommendation** : For modules that are provided as separate repositories, create a script in the module repository that largely automates the synchronization of the various parts (submodule, utilities, tests) from FieldTrip towards the module repositories. Then use it in a GitHub action that automates even more steps of the synchronization. The GitHub action can be set to automatically run whenever a new FieldTrip release is created, or triggered manually. And can add the changes directly to the main branch of the module repository, or only create a branch-and-pull- request that is first tested independently (for instance by a github action in the module repository) before the changes are added to the main branch of the module repository. Since the source is here the main FieldTrip repository, letting this workflow run fully through automated triggers is more feasible than for the externals in FieldTrip, where the source of the changed code is outside of FieldTrip.
212212

213213
#### 3.2.4. Externals
214214

development/project/femfuns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The following section illustrates an example where the FEMfuns pipeline is embed
4444

4545
### Setting-up
4646

47-
The instructions to set up FEMfuns can be found on the [Github page](https://github.com/Donders-Institute/FEMfuns).
47+
The instructions to set up FEMfuns can be found on the [GitHub page](https://github.com/Donders-Institute/FEMfuns).
4848
Setting up is achieved in three steps:
4949

5050
Step 1: Download Anaconda: https://docs.continuum.io/anaconda/install/

0 commit comments

Comments
 (0)