Skip to content

Add ORCID to docs #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PhilReedData wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add ORCID to docs #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 43 additions & 10 deletions TeSS_docs/overview/definitions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ ELIXIR TeSS Portal
The [ELIXIR TeSS](https://tess.elixir-europe.org/) portal, the training registry for Europe's distributed infrastructure for life-science data, is built using the TeSS Platform.

Event
An event in TeSS is a link to a single training event sourced by a provider along with description and other meta information (e.g. date, location, audience, ontological categorization, keywords).

An event in TeSS is a link to a single training event sourced by a provider along with description and other meta information (e.g. date, location, audience, ontological categorization, keywords).
In SciLifeLab TeSS, this is called a Course. <br>
Training events can be added manually or automatically harvested from a provider's website.

Exchange (TeSS-X)
Expand All @@ -32,8 +32,7 @@ Exchange (TeSS-X)
See [What do we mean by eXchange?](https://elixirtess.github.io/mTeSS-X/exchange) on the mTeSS-X project website for details.

Instance
One installation of the TeSS Platform, on a server, managed by a technical administrator. An instance may have multiple spaces, if this option has been enabled by the administrator.

One installation of the TeSS Platform, on a server, managed by a technical administrator. An instance may have multiple spaces, if this option has been enabled by the administrator. <br>
Examples of TeSS instances can be viewed on the [global usages page](global).

Learning path
Expand All @@ -50,14 +49,13 @@ Space (mTeSS)
See [Introduction to spaces](../spaces/intro-spaces) for details.

TeSSHub
The platform name for a TeSS instance with multiple [spaces](#term-Space-mTeSS)
The strategic name for a TeSS instance with multiple [spaces](#term-Space-mTeSS)
that can [exchange](#term-Exchange-TeSS-X) materials with other instances.
The TeSSHub is one of the outputs from the mTeSS-X project,
where [ELIXIR TeSS (life sciences)](https://tess.elixir-europe.org/)
and [PaN-Training (photon and neutron)](https://www.panosc.eu/training-catalogue/)
will be running multipe spaces from the same server, appearing as distinct catalogues,
and can share relevant materials.

and can share relevant materials. <br>
Communities may be welcome to [request their own space](../spaces/instance-or-space/)
on a TeSSHub, providing them with their own registry,
without the need to host and maintain their own instance.
Expand All @@ -66,8 +64,7 @@ TeSS Platform
The main codebase which is used for development, written in Ruby on Rails. The code is open source and [available on GitHub](https://github.com/ElixirTeSS/TeSS) under a BSD 3-Clause licence.

Training material
In the context of TeSS, a training material is a link to a single online training material sourced by a content provider (such as a text on a Web page, presentation, video) along with description and other meta information (e.g. ontological categorization, keywords).

In the context of TeSS, a training material is a link to a single online training material sourced by a content provider (such as a text on a Web page, presentation, video) along with description and other meta information (e.g. ontological categorization, keywords). <br>
Materials can be added manually or automatically harvested from a provider's website.

Workflow
Expand All @@ -93,7 +90,9 @@ Resource Type
The predominant category that describes the kind of learning material, for example, a presentation, video, handout, publication, poster.

Scientific Topics
The scientific subject or field that the training material focuses on, for example, bioinformatics, genetics, biodiversity, genomics.
The scientific subject or field that the training material focuses on, for example, bioinformatics, genetics, biodiversity, genomics.
In ELIXIR TeSS, this field uses the [EDAM ontology](https://edamontology.github.io/edam-browser/).
In PaN-Training, this field uses the [PaNET ontology](https://github.com/pan-ontologies/PaNET).

Keywords
Free text about topics clearly identifying the training material.
Expand All @@ -120,9 +119,11 @@ Content Provider

Authors
Individuals who made substantial intellectual or technical contributions to the conception, design, execution of the training material.
This field supports freetext name and [ORCID](https://orcid.org/).

Contributor
Individuals or entities who provided specific assistance, technical input, data, or materials to the work but may not meet the full criteria for authorship.
This field supports freetext name and [ORCID](https://orcid.org/).

Target Audience
The intended group of users or learners for whom the training material is designed, such as researchers, students, postdocs, trainers.
Expand All @@ -139,6 +140,10 @@ Learning Objectives
Events
Workshops, seminars, conferences, summer or winter schools that contribute to or disseminate the training.

Operations
Functions that process a set of inputs and result in a set of outputs.
In ELIXIR TeSS, this field uses the [EDAM ontology for Operation](https://www.ebi.ac.uk/ols4/ontologies/edam/classes/http%253A%252F%252Fedamontology.org%252Foperation_0004?lang=en).

```


Expand Down Expand Up @@ -256,6 +261,34 @@ Show archived materials/learning paths/collections

```

## User profile

Definitions of public user details associated with a TeSS use account.

```{glossary}

First name
Your first name.

Last name
Your last name.

Website
Your individual, professional website.

ORCID
Your [ORCID](https://orcid.org/): a free, unique, persistent identifier (PID) that allows individuals to be uniquely distinguished and claim credit for their scholarship work, no matter how many people have a similar name.
You can authenticate your ORCID from the button on your user profile page.

Image
The image displayed with your profile is the Gravatar image associated with the provided contact email address, unless you upload another image.
Gravatar provides a way to link an avatar to an email address so that it can be used across sites and platforms.
To set-up a linked avatar, go to the [Gravatar site](https://en.gravatar.com).

Contact email address
Your email address to receive essential service messages such as a password reset.

```

## Roles

Expand Down
36 changes: 35 additions & 1 deletion TeSS_docs/overview/fair.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,44 @@ For providers, the TeSS Platform makes it easy to make resources [FAIR](http://d

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


## ORCID for accurately recognising authors of training materials

Training materials in TeSS can be attributed to any number of authors (for substantial input) and contributors (for a smaller level of input).
When the author or contributor is a person, their ORCID can be included.

::::{grid} 1 1 2 2
:gutter: 3

:::{grid-item-card}
:link: https://orcid.org/
{fas}`id-badge;sd-text-secondary` **ORCID**
^^^

This free, unique, persistent identifier (PID) allows individuals to be uniquely distinguished and claim credit for their scholarship work, no matter how many people have a similar name.
:::
::::

When you [manually edit your training material in TeSS](../content/manual-events-materials), as you type the name of each author or contributor, TeSS will suggest a name and ORCID. If you are entering this person for the first time, paste their ORCID in the box after their name.
If your training material is [automatically ingested into TeSS](../content/structured-data-types), you can add the ORCID URL of each person into the Bioschemas markup under the `@id` or `identifier` property (either property will work). For example:

```json
{
"author": [
{
"@type": "Person",
"name": "Daniela Schneider",
"identifier": "https://orcid.org/0000-0001-9536-5587",
"@id": "https://orcid.org/0000-0001-9536-5587"
}
]
}
```


## Integration with tools, policies, standards and data registries

In [ELIXIR TeSS](https://tess.elixir-europe.org/), you can associate your training materials with resources held in other ELIXIR resources:
Expand Down