Skip to content

Commit a95f891

Browse files
committed
Added definitions page
1 parent b1d9940 commit a95f891

3 files changed

Lines changed: 86 additions & 1 deletion

File tree

TeSS_docs/_toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ parts:
77
- caption: Overview
88
chapters:
99
- file: overview/tess
10+
- file: overview/definitions
1011
- caption: Account creation
1112
chapters:
1213
- file: accounts/user

TeSS_docs/overview/definitions.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Definitions
2+
3+
Definitions of terms and user roles.
4+
5+
## Terms
6+
7+
Definition of common terms used across TeSS.
8+
9+
### Exchange (TeSS-X)
10+
11+
If a community runs its own instance then a TeSS-X plugin sets up an exchange with other instances.
12+
In the mTeSS-X project, we will show how several TeSS-instance catalogues exchange nominated training resources.
13+
See [What do we mean by eXchange?](https://elixirtess.github.io/mTeSS-X/exchange) on the mTeSS-X project website for details.
14+
15+
16+
### Instance
17+
18+
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.
19+
20+
Examples of TeSS instances can be viewed on the [global usage page](https://elixirtess.github.io/mTeSS-X/global) of the mTeSS-X project website.
21+
22+
23+
### mTeSS-X Project
24+
25+
The [mTeSS-X Project](https://elixirtess.github.io/mTeSS-X) (Multi-space Training e-Support System with eXchange) overcomes the fragmentation of training resources across Research Infrastructures and the European Science Clusters.
26+
The project aims to enhance existing TeSS-based training registries or catalogues like [ELIXIR TeSS (life sciences)](https://tess.elixir-europe.org/) and [PaN-Training (photon and neutron)](https://www.panosc.eu/training-catalogue/) by building an aggregator for these and similar platforms.
27+
28+
29+
### Space (mTeSS)
30+
31+
A single TeSS instance presents multiple tailored spaces (catalogues) whose selections of training material are “views” on a global catalogue.
32+
Each community registers, maintains and curates their material for their members in their own virtual space in the common portal environment.
33+
See [What do we mean by Multi-space/tenancy?](https://elixirtess.github.io/mTeSS-X/multi-space) on the mTeSS-X project website for details.
34+
35+
36+
### TeSSHub
37+
38+
The first TeSS instance with multiple spaces. This will be 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 multipe spaces running from the same server, appearing as distinct catalogue.
39+
40+
Communities will be welcome to request their own space on the TeSSHub, providing them with their own registry, without the need to host and maintain their own instance.
41+
42+
43+
### TeSS Platform
44+
45+
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.
46+
47+
48+
### TeSS Portal
49+
50+
Shorthand for the [ELIXIR TeSS](https://tess.elixir-europe.org/) portal, the training registry for Europe's distributed infrastructure for life-science data, built using the TeSS Platform.
51+
52+
53+
54+
## Roles
55+
56+
Definitions of user roles in TeSS.
57+
58+
### Administrator
59+
60+
The technical administrator, responsible for installation, configuration and maintenance of a TeSS instance.
61+
62+
### Curator
63+
64+
A person with limited administrator permissions.
65+
66+
### Space Manager
67+
68+
The person responsible for managing a space within an instance.

TeSS_docs/overview/tess.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
11
# Introduction to TeSS
22

3-
[ELIXIR TeSS](https://tess.elixir-europe.org/)
3+
**Training e-Support Service (TeSS)**
4+
5+
TeSS is a platform that was developed to provide a one-stop shop for trainers and trainees to discover online information and content, including training materials, events and interactive tutorials.
6+
For training providers, TeSS provides opportunities to promote training events and news, and to contribute to a growing catalogue of materials;
7+
for trainers, the portal offers an environment for sharing materials and event information;
8+
for trainees, it offers a convenient gateway via which to identify relevant training events and resources, and to perform specific, guided analysis tasks via customised training workflows.
9+
10+
The [mTeSS-X Project](https://elixirtess.github.io/mTeSS-X) (Multi-space Training e-Support System with eXchange) overcomes the fragmentation of training resources across Research Infrastructures and the European Science Clusters.
11+
The project aims to enhance existing TeSS-based training registries or catalogues like [ELIXIR TeSS (life sciences)](https://tess.elixir-europe.org/) and [PaN-Training (photon and neutron)](https://www.panosc.eu/training-catalogue/) by building an aggregator for these and similar platforms.
12+
13+
TeSS was originally developed as part of [ELIXIR](https://elixir-europe.org/), Europe's distributed infrastructure for life-science data.
14+
One of the goals of ELIXIR is to train research scientists to better use available computational infrastructures to address critical research questions.
15+
This requires access both to face-to-face training opportunities and to disparate training materials and resources, currently dispersed across Europe.
16+
17+
18+
19+

0 commit comments

Comments
 (0)