Below are instructions on how to add or edit items in each of the SciLifeLab Data Platform website sections.
The Events & Training section contains a community-sourced collection of events and training opportunities relevant for data-driven life science research.
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).
---
title: Event title here # obligatory
type: webinar # obligatory; choose from 'course', 'seminar', 'webinar', 'workshop', 'conference'
date_start: 2006-01-02 # obligatory; starting date of the event in the exact format given as an example here
time_start: 09:00 # optional; starting time of the event in the exact format given as an example here
date_end: 2022-05-09 # optional; end date of the event in the exact format given as an example here
time_end: 11:00 # optional; end time of the event in the exact format given as an example here
venue: Online event via Zoom # optional; information about event venue in free text format
organisers: SciLifeLab Data Centre # optional; information about event organiser(s) in free text format
event_url: https://... # obligatory; provide the URL of the event information webpage starting with https://.
registration_url: https://... # optional; provide the URL of the event registration webpage starting with https://.
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.
---Data highlights is a section of the website highlighting new open datasets, tools, and research results based on open datasets and tools.
Typically, for each data highlight we prepare two illustrations. One illustration is smaller and appears on overview page with all data highlights. The other illustration appears on the page of the highlight itself.
The smaller illustration needs to have the width that is twice the length (i.e., length 300 px and width 600 px). This way, it will easily fit the look of the page layouts.
Both illustrations should be placed in the /static/highlights/ folder. The URL of the images placed here will then be https://data.scilifelab.se/highlights/file_name.png.
The data highlights are generated from Markdown formatted files contained in the /content/highlights/ folder. The file name used here will also be the URL of the data highlight (e.g., test-highlight.md will become https://data.scilifelab.se/highlights/test-highlight/).
Below is an example of a data highlight file content. You can copy this text into your markdown file and edit it to write your own data highlight.
---
title: Important new dataset shared
date: 2006-01-02
summary: A new dataset containing a large amount of valuable data has been openly shared.
banner: /highlights/example.png
banner_large: /highlights/example_large.png
banner_caption: "Illustration of X. The image was taken from Y."
tags: [Evolution & biodiversity, insects, dashboard]
authors: [Anders Celsius]
---
This is the text of the highlight. This is the first paragraph. Introduce why this is an important topic.
This is the second paragraph of the text of the highlight. Markdown formatting should be used in the text. For example, you can make a piece of text italic by placing an asterisk at the beginning and end, *like this*. You can make a piece of text bold by placing two asterisks at the beginning and end, **like this**. You can also add a link with square brackets following round round brackets, [like this](https://example.com/data/).
We typically describe exactly what data has been shared, how it can be re-used, and give links to where it can be downloaded.
#### Dataset
* [Shared dataset 1](https://example.com/data1/): description of shared dataset 1
* [Shared dataset 2](https://example.com/data2/): description of shared dataset 2
* [Shared dataset 3](https://example.com/data3/): description of shared dataset 3
On the top of the file, surrounded by ---, basic information for this data highlight is provided. It contains the title; publication date (desired; Hugo needs to be run on that day or later for it to appear); summary text that appears on the main page of the Data highlights section; location of the illustration to be displayed on the homepage (banner); location of the illustration to be displayed on the page of the highlight (banner_large); caption text that will appear under the illustration on the page of the highlight; tags that are appropriate for this data highlight; name(s) of the person or persons who wrote this data highlight.
The title, date, summary, illustrations will appear where they are supposed to be. The tags will appear as links so that other highlights tagged with the same tag can be seen (tags are also used to select similar previosly published highlights that appear on the bottom of each highlight page), and author name(s) will appear as link(s) so that other highlights written byt the same author(s) can be seen.
The Platform news section contains announcements about the SciLifeLab Data Platform and services hosted on the Platform.
Each news item displayed in the Platform news section is stored as a file inside the /content/news/ folder. Each file should be named with the publication date of news item using the following format: 2006-01-02.md which stands for January 2nd 2006. Each file should have extension .md but contain data in YAML format followed by text in Markdown format as shown below.
---
title: Important new dataset shared
date: 2006-01-02
---
This is the text of the news item. Write one or max two paragraphs here. Markdown formatting can be used in the text. For example, you can make a piece of text italic by placing an asterisk at the beginning and end, *like this*. You can make a piece of text bold by placing two asterisks at the beginning and end, **like this**. You can also add a link with square brackets following round round brackets, [like this](https://example.com/data/).
The items in the Service catalogue are contained inside the data/services.json JSON file. The parameters that can be defined for each services are provided below. Select one or more values in case of the list parameters (for target audience and type). The logo of the service needs to be uploaded to the folder /static/img/service_logos/ and given here (without the /static part in the URL). Indicate one or more ways in which the users can receive support (email, website, github repository).
{
"target": ["researchers", "facilities"],
"type": ["database", "tool", "portal", "helpdesk"],
"name": "Service title",
"description": "Short description of the service",
"url": "https://...",
"logo_location": "/img/service_logos/...",
"maintained_by": "One or more maintainers as text",
"maintained_by_url": "https://...",
"support_email": "..@..",
"support_website": "https://...",
"support_github": "https://github.com/..."
}