Skip to content

Commit

Permalink
[DOC] new readme for the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
bclenet committed Oct 13, 2023
1 parent c10e3a4 commit 0436fe4
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@

:mega: This is the starting point for the documentation of the NARPS open pipelines project.

Here are the available topics :

* :runner: [running](/docs/running.md) tells you how to run pipelines in NARPS open pipelines
* :brain: [data](/docs/data.md) contains instructions to handle the data needed by the project
* :hammer_and_wrench: [environment](/docs/environment.md) contains instructions to handle the software environment needed by the project
* :goggles: [description](/docs/description.md) tells you how to get convenient descriptions of the pipelines, as written by the teams involved in NARPS.
* :microscope: [testing](/docs/testing.md) details the testing features of the project, i.e.: how is the code tested ?
* :package: [ci-cd](/docs/ci-cd.md) contains the information on how continuous integration and delivery (knowned as CI/CD) is set up.
* :writing_hand: [pipeline](/docs/pipelines.md) tells you all you need to know in order to write pipelines
* :vertical_traffic_light: [status](/docs/status.md) contains the information on how to get the work progress status for a pipeline.
## Use the project
* :brain: [data](/docs/data.md) - handle the data needed by the project
* :hammer_and_wrench: [environment](/docs/environment.md) - handle the software environment needed by the project
* :rocket: [running](/docs/running.md) - launch pipelines in NARPS open pipelines

## Contribute to the code
* :goggles: [description](/docs/description.md) - conveniently access descriptions of the pipelines, as written by the teams involved in NARPS.
* :writing_hand: [pipeline](/docs/pipelines.md) - how to write pipelines.

## Main
* :vertical_traffic_light: [status](/docs/status.md) - work progress status for a pipeline.
* :microscope: [testing](/docs/testing.md) - testing features of the project, i.e.: how is the code tested ?
* :package: [ci-cd](/docs/ci-cd.md) - how continuous integration and delivery (knowned as CI/CD) is set up.

0 comments on commit 0436fe4

Please sign in to comment.