Skip to content

Commit 4ea806a

Browse files
authored
Merge pull request #22 from ElixirTeSS/fair
New page: How we support FAIR
2 parents 30c45c5 + adc9826 commit 4ea806a

4 files changed

Lines changed: 45 additions & 1 deletion

File tree

TeSS_docs/_toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ parts:
1111
- file: overview/mtess-x
1212
- file: overview/definitions
1313
- file: overview/what-we-catalogue
14+
- file: overview/fair
1415
- caption: Search
1516
chapters:
1617
- file: search/searching

TeSS_docs/developers/code-data.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,20 @@ View our available widgets
4343

4444
## API
4545

46-
TeSS has a fully functioning JSON API. You can explore our JSON-API by appending .json_api to the end of the URL of most pages (excluding parameters). For example:
46+
TeSS has a fully functioning JSON API. You can explore our JSON-API by appending `.json_api` to the end of the URL of most pages (excluding parameters). For example:
4747

4848
```
4949
https://tess.elixir-europe.org/events.json_api
5050
https://tess.elixir-europe.org/materials.json_api?scientific_topics=RNA-Seq
5151
https://tess.elixir-europe.org/content_providers.json_api
5252
https://tess.elixir-europe.org/workflows.json_api
53+
https://tess.elixir-europe.org/materials/how-to-make-your-messy-data-usable-openrefine.json_api
54+
```
55+
56+
To get [Bioschemas](https://bioschemas.org) JSON-LD representation of individual materials or events, append `.jsonld` instead:
57+
58+
```
59+
https://tess.elixir-europe.org/materials/how-to-make-your-messy-data-usable-openrefine.jsonld
5360
```
5461

5562
The full documentation for the TeSS JSON API can be found here:
1.08 MB
Loading

TeSS_docs/overview/fair.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# How we support FAIR
2+
3+
Training materials and events are widely dispersed and fragmented, making it challenging for users to identify relevant materials.
4+
Training e-Support System (TeSS) is a web-based open-source platform consolidating resources from various providers into an easy-to-use portal.
5+
It is a one-stop-shop for trainers and trainees to discover training materials, workshops, and online courses in relevant topics such as data management and open research methods.
6+
7+
For providers, the TeSS Platform makes it easy to make resources [FAIR](http://doi.org/10.1038/sdata.2016.18) (Findable, Accessible, Interoperable, and Reusable):
8+
9+
- **Findable**: A unique, persistent identifier such as [DOI](https://www.doi.org/the-identifier/what-is-a-doi/) is requested for all materials. (For example, [publish your materials in Zenodo](https://help.zenodo.org/docs/get-started/quickstart/) to be assigned a DOI.)
10+
- **Accessible**: TeSS materials/events are accessible to all registered users via the TeSS website, [widgets](../developers/code-data) or [JSON API](../developers/code-data). Your content will seen more in search results owing to our search-engine optimisation (SEO).
11+
- **Interoperable**: Metadata uses a standard vocabulary (EDAM for ELIXIR). We expose content using Schema.org (Bioschemas), JSON-LD, and OAI-PMH open standards.
12+
- **Reusable**: License is requested for all materials, such as Creative Commons.
13+
14+
15+
## Interoperate using Linked Data
16+
17+
When you view a material or event on TeSS, there is machine-readable metadata behind the human-readable content.
18+
If you were to view the HTML source of the page, you would see this code, written as [JSON-LD](https://json-ld.org/).
19+
20+
```{image} ../images/overview/metadata-source.png
21+
:alt: View Source to see the embedded metadata
22+
:class: mb-1
23+
:width: 300px
24+
:align: center
25+
```
26+
27+
Developers can access this [Bioschemas](https://bioschemas.org)-compliant JSON-LD metadata, without the human-readable HTML, to use interoperate as [Linked Data](https://en.wikipedia.org/wiki/Linked_data). To do this, append `.jsonld` to the URL. For example:
28+
29+
```
30+
https://tess.elixir-europe.org/materials/how-to-make-your-messy-data-usable-openrefine
31+
```
32+
33+
...becomes
34+
```
35+
https://tess.elixir-europe.org/materials/how-to-make-your-messy-data-usable-openrefine.jsonld
36+
```

0 commit comments

Comments
 (0)