Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions TeSS_docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ parts:
- file: overview/mtess-x
- file: overview/definitions
- file: overview/what-we-catalogue
- file: overview/fair
- caption: Search
chapters:
- file: search/searching
Expand Down
9 changes: 8 additions & 1 deletion TeSS_docs/developers/code-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,20 @@ View our available widgets

## API

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:
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:

```
https://tess.elixir-europe.org/events.json_api
https://tess.elixir-europe.org/materials.json_api?scientific_topics=RNA-Seq
https://tess.elixir-europe.org/content_providers.json_api
https://tess.elixir-europe.org/workflows.json_api
https://tess.elixir-europe.org/materials/how-to-make-your-messy-data-usable-openrefine.json_api
```

To get [Bioschemas](https://bioschemas.org) JSON-LD representation of individual materials or events, append `.jsonld` instead:

```
https://tess.elixir-europe.org/materials/how-to-make-your-messy-data-usable-openrefine.jsonld
```

The full documentation for the TeSS JSON API can be found here:
Expand Down
Binary file added TeSS_docs/images/overview/metadata-source.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions TeSS_docs/overview/fair.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# How we support FAIR

Training materials and events are widely dispersed and fragmented, making it challenging for users to identify relevant materials.
Training e-Support System (TeSS) is a web-based open-source platform consolidating resources from various providers into an easy-to-use portal.
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.

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):

- **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.)
- **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).
- **Interoperable**: Metadata uses a standard vocabulary (EDAM for ELIXIR). We expose content using Schema.org (Bioschemas), JSON-LD, and OAI-PMH open standards.
- **Reusable**: License is requested for all materials, such as Creative Commons.


## Interoperate using Linked Data

When you view a material or event on TeSS, there is machine-readable metadata behind the human-readable content.
If you were to view the HTML source of the page, you would see this code, written as [JSON-LD](https://json-ld.org/).

```{image} ../images/overview/metadata-source.png
:alt: View Source to see the embedded metadata
:class: mb-1
:width: 300px
:align: center
```

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:

```
https://tess.elixir-europe.org/materials/how-to-make-your-messy-data-usable-openrefine
```

...becomes
```
https://tess.elixir-europe.org/materials/how-to-make-your-messy-data-usable-openrefine.jsonld
```