Skip to content

Commit

Permalink
Merge pull request #128 from Remi-Gau/mkdoc
Browse files Browse the repository at this point in the history
[FIX] minor fixes
  • Loading branch information
Remi-Gau authored Nov 17, 2023
2 parents 31e0caf + 51d1382 commit 24ed199
Show file tree
Hide file tree
Showing 9 changed files with 52 additions and 63 deletions.
1 change: 1 addition & 0 deletions .github/workflows/publishdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
if: github.repository_owner == 'INCF'
steps:
- name: Checkout master
uses: actions/checkout@v4
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/update_spreadsheet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ jobs:

runs-on: ubuntu-latest

if: github.repository_owner == 'INCF'

steps:
- name: Checkout repository
uses: actions/checkout@v4
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,19 @@ name: validate jsonld

on:
push:
branches:
branches:
- master
- main
- dev
- dev
pull_request:
branches: '*'

jobs:
build:
runs-on: ubuntu-latest

if: github.repository_owner == 'INCF'

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- name: Setup Node
Expand Down
20 changes: 1 addition & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
<!-- comment: landing page for ARTEMIS app -->

<center>

![](https://raw.githubusercontent.com/ohbm/eCOBIDAS/master/images/ARTEMIS_logo.jpg)
Expand Down Expand Up @@ -34,20 +32,4 @@ Despite this, systematic reviews of reporting practices in the field have shown
Read more about the rationale for this project and the design principles we go by in our **[paper](https://www.sciencedirect.com/science/article/pii/S1053811921009939?via%3Dihub)**, and if you agree support us by signing the **[ARTEM-IS statement](https://osf.io/mf97q/)**.

1. Have a look at our **[project on OSF](https://osf.io/pvrn6/)**.
2. **Talks and slides** are available [HERE](https://osf.io/ncav8/).

## Get in touch

Want to know more? Have any questions? Something is missing? Send us an [email](mailto:[email protected]).

For occasional updates on the project, join our [mailing list](mailto:[email protected]).

## Want to help?

If you want to join this project, please check out our [INCF Working Group](https://www.incf.org/sig/incf-working-group-artem) and apply for joining it by filling in this [form](https://forms.gle/QHFakdGUQ69QrCYc9).

## Contributors

ARTEM-IS is developed by an [INCF working group](https://www.incf.org/sig/incf-working-group-artem), in partnership with [eCOBIDAS](https://www.incf.org/sig/incfohbm-working-group-checklists-transparent-methods-reporting-neuroscience-ecobidas).

A centralized list of the people who contributed to this project can be found [here](https://osf.io/ut9pc/).
2. **Talks and slides** are available [HERE](https://osf.io/ncav8/).
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ site_name: ARTEM-IS
repo_url: https://github.com/INCF/artem-is

nav:
- ARTEM-IS: index.md
- Introduction: index.md
- Details:
- Scope: details/scope.md
- lexicon: lexicon.md
- links: links.md
- contact: contact.md
- Contributors: CONTRIBUTING.md
- Release notes: CHANGELOG.md

Expand Down
51 changes: 31 additions & 20 deletions src/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
# CONTRIBUTING

## Want to help?

If you want to join this project, please check out our [INCF Working Group](https://www.incf.org/sig/incf-working-group-artem) and apply for joining it by filling in this [form](https://forms.gle/QHFakdGUQ69QrCYc9).

## Contributors

ARTEM-IS is developed by an [INCF working group](https://www.incf.org/sig/incf-working-group-artem), in partnership with [eCOBIDAS](https://www.incf.org/sig/incfohbm-working-group-checklists-transparent-methods-reporting-neuroscience-ecobidas).

A centralized list of the people who contributed to this project can be found [here](https://osf.io/ut9pc/).

## Serve the website locally (on your computer)

### Requirements

- Python

To install all the necessarry packages,
type the following in a terminal in the root of the repository:

```bash
pip install -r requirments.txt
```

### Serve the website

Type the following in a terminal in the root of the repository:

```bash
mkdocs serve
```

## How to update the spreadsheet

There is an automated workflow that will grab the different ARTEMIS spreadsheet
Expand Down Expand Up @@ -29,23 +60,3 @@ It can be triggered manually:
![merge](./images/merge.png)


## Serve the website locally (on your computer)

### Requirements

- Python

To install all the necessarry packages,
type the following in a terminal in the root of the repository:

```bash
pip install -r requirments.txt
```

### Serve the website

Type the following in a terminal in the root of the repository:

```bash
mkdocs serve
```
8 changes: 8 additions & 0 deletions src/contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Get in touch

Want to know more? Have any questions? Something is missing?
Send us an [email](mailto:[email protected]).

For occasional updates on the project, join our [mailing list](mailto:[email protected]).


21 changes: 0 additions & 21 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,24 +34,3 @@ Read more about the rationale for this project and the design principles we go b
1. Have a look at our **[project on OSF](https://osf.io/pvrn6/)**.
2. **Talks and slides** are available [HERE](https://osf.io/ncav8/).

## Get in touch

Want to know more? Have any questions? Something is missing? Send us an [email](mailto:[email protected]).

For occasional updates on the project, join our [mailing list](mailto:[email protected]).

## Want to help?

If you want to join this project, please check out our [INCF Working Group](https://www.incf.org/sig/incf-working-group-artem) and apply for joining it by filling in this [form](https://forms.gle/QHFakdGUQ69QrCYc9).

## Contributors

ARTEM-IS is developed by an [INCF working group](https://www.incf.org/sig/incf-working-group-artem), in partnership with [eCOBIDAS](https://www.incf.org/sig/incfohbm-working-group-checklists-transparent-methods-reporting-neuroscience-ecobidas).

A centralized list of the people who contributed to this project can be found [here](https://osf.io/ut9pc/).

## License

The template is licensed CC-BY-4.0

(c) 2020 INCF Working Group on ARTEMIS
3 changes: 3 additions & 0 deletions src/lexicon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Lexicon

🚧 Coming soon. 🚧

0 comments on commit 24ed199

Please sign in to comment.