Skip to content

Commit a6a4d3d

Browse files
committed
Update contribute doc for events
1 parent e706b64 commit a6a4d3d

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,28 @@ Below are instructions on how to add or edit items in each of the SciLifeLab Dat
66

77
The __Events & Training__ section contains a community-sourced collection of events and training opportunities relevant for data-driven life science research.
88

9-
Each item displayed in the section Events & Training is stored as a file inside the `/content/events/` folder. Each file should be named with the start date of event using the following format: `20060102.md` which stands for January 2nd 2006. Each file should have extension `.md` but contain data in YAML format as shown below. The file starts and ends with lines containing three dashes. The lines between contain information about the event/training opportunity. Not all fields are obligatory (see below for which fields are obligatory).
9+
All the events displayed in the section Events & Training are stored in a `JSON` file [ddls_events.json](https://blobserver.dc.scilifelab.se/blob/ddls_events.json/info) in DC's `blobserver`. Each event/training is an object item in the `items` list, so to add a new event/training one should add a new object with required information (see below for the required fields).
1010

11-
```YAML
12-
---
13-
title: Event title here # obligatory
14-
type: webinar # obligatory; choose from 'course', 'seminar', 'webinar', 'workshop', 'conference'
15-
date_start: 2006-01-02 # obligatory; starting date of the event in the exact format given as an example here
16-
time_start: 09:00 # optional; starting time of the event in the exact format given as an example here
17-
date_end: 2022-05-09 # optional; end date of the event in the exact format given as an example here
18-
time_end: 11:00 # optional; end time of the event in the exact format given as an example here
19-
venue: Online event via Zoom # optional; information about event venue in free text format
20-
organisers: SciLifeLab Data Centre # optional; information about event organiser(s) in free text format
21-
event_url: https://... # obligatory; provide the URL of the event information webpage starting with https://.
22-
registration_url: https://... # optional; provide the URL of the event registration webpage starting with https://.
23-
description: "Event description here. Markdown formatting allowed." # optional; provide a description of the event in free text, markdown formatting such as *italic*, **bold**, [link](https://..) is allowed here; if you use markdown formatting make sure to have quotation marks around the text.
24-
---
11+
```JSON
12+
{
13+
"target": [],
14+
"title": "",
15+
"type": "",
16+
"date_start": "",
17+
"time_start": "",
18+
"date_end": "",
19+
"time_end": "",
20+
"venue": "",
21+
"location": [],
22+
"category": [],
23+
"organisers": "",
24+
"event_url": "",
25+
"description": ""
26+
}
2527
```
2628

29+
You need write access in `blobserver` to add/update events json file, if you do not, send the event information (for above mentioned fields) to the data platform team and they will update it for you upon review. You can mail it to <data-platform@scilifelab.se> or fill in the form by clicking "Submit an event" button in [events](https://data.scilifelab.se/events/) page.
30+
2731
## Data highlights
2832

2933
__Data highlights__ is a section of the website highlighting new open datasets, tools, and research results based on open datasets and tools.

0 commit comments

Comments
 (0)