Skip to content

Commit 3d52b71

Browse files
PhilReedDataPhilReedData
committed
Rework the Overview section
1 parent 1ad151a commit 3d52b71

8 files changed

Lines changed: 147 additions & 87 deletions

File tree

‎TeSS_docs/_config.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#######################################################################################
77
# Book settings
88
title : TeSS Platform Documentation # The title of the book. Will be placed in the left navbar.
9-
author : Phil Reed, Munazah Andrabi, Finn Bacall, Carole Goble # The author of the book
9+
author : Phil Reed, Munazah Andrabi, Finn Bacall, Carole Goble (OSCARS mTeSS-X project)
1010
copyright : "2025" # Copyright year to be placed in the footer
1111
logo : images/tess-platform-logo-wide.svg # A path to the book logo
1212

‎TeSS_docs/_toc.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ parts:
77
- caption: Overview
88
chapters:
99
- file: overview/tess
10+
- file: overview/global
11+
- file: overview/mtess-x
1012
- file: overview/definitions
1113
- file: overview/what-we-catalogue
1214
- file: overview/subscribe

‎TeSS_docs/index.md‎

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
This documentation is intended to provide help and information on how to use a training registry created on the TeSS platform.
44

5-
## Getting started
5+
## About TeSS
6+
67

78
::::{grid} 1 1 2 3
89
:class-container: text-center
@@ -12,12 +13,41 @@ This documentation is intended to provide help and information on how to use a t
1213
:link: overview/tess
1314
:link-type: doc
1415

15-
{fas}`panorama;sd-text-secondary` **Overview**
16+
{fas}`panorama;sd-text-secondary` **Introduction**
17+
^^^
18+
19+
What is TeSS, definitions of terms and roles.
20+
:::
21+
22+
:::{grid-item-card}
23+
:link: overview/global
24+
:link-type: doc
25+
26+
{fas}`earth-europe;sd-text-secondary` **Global usage**
1627
^^^
1728

18-
What is TeSS, definitions of terms.
29+
Global usages of the TeSS Platform.
1930
:::
2031

32+
:::{grid-item-card}
33+
:link: overview/mtess-x
34+
:link-type: doc
35+
36+
{fas}`arrows-turn-to-dots;sd-text-secondary` **mTeSS-X**
37+
^^^
38+
39+
Multi-spaces and exchange.
40+
:::
41+
42+
::::
43+
44+
45+
## Getting started
46+
47+
::::{grid} 1 1 2 3
48+
:class-container: text-center
49+
:gutter: 3
50+
2151
:::{grid-item-card}
2252
:link: accounts/user
2353
:link-type: doc
@@ -29,30 +59,32 @@ Creating a user account, setting up a content provider.
2959
:::
3060

3161
:::{grid-item-card}
32-
:link: spaces/intro-spaces
62+
:link: content/intro-content
3363
:link-type: doc
3464

35-
{fas}`boxes-stacked;sd-text-secondary` **Spaces**
65+
{fas}`box-open;sd-text-secondary` **Content registration**
3666
^^^
3767

38-
When to set up a TeSS space, how to credit other spaces' materials.
68+
Automatically or manually register events, materials or learning paths.
3969
:::
4070

71+
4172
:::{grid-item-card}
42-
:link: content/intro-content
73+
:link: spaces/intro-spaces
4374
:link-type: doc
4475

45-
{fas}`box-open;sd-text-secondary` **Content**
76+
{fas}`boxes-stacked;sd-text-secondary` **Space creation**
4677
^^^
4778

48-
Automatically or manually register events, materials or learning paths.
79+
When to set up a TeSS space, how to credit other spaces' materials.
4980
:::
5081

82+
5183
:::{grid-item-card}
5284
:link: developers/code-data
5385
:link-type: doc
5486

55-
{fas}`wrench;sd-text-secondary` **Developers**
87+
{fas}`wrench;sd-text-secondary` **Widgets and API**
5688
^^^
5789

5890
Configure an API or widget.
@@ -65,6 +97,8 @@ Configure an API or widget.
6597

6698
TeSS has been funded by:
6799

100+
- The authors acknowledge the [OSCARS project](https://www.oscars-project.eu/projects/mtess-x-scaling-training-portal-federation-ris-through-multi-tenanting-and-exchange), which has received funding from the European Commission’s Horizon Europe Research and Innovation programme under grant agreement No. 101129751
101+
- [BioFAIR](https://biofair.uk/)
68102
- European Commission, Horizon 2020 Research Infrastructures programme (ELIXIR-EXCELERATE, [grant agreement number 676559](https://cordis.europa.eu/project/rcn/198519_en.html));
69103
- ELIXIR Implementation Study (Registry Integration from a User Perspective);
70104
- ELIXIR Implementation Study (Learning Paths).

‎TeSS_docs/overview/definitions.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Definition of common terms used across TeSS.
1010

1111
Entities (such as academic institutions, non-profit organisations, portals) that provide training materials of relevance.
1212

13+
14+
### ELIXIR TeSS Portal
15+
16+
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.
17+
18+
1319
### Event
1420

1521
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).
@@ -28,7 +34,7 @@ See [What do we mean by eXchange?](https://elixirtess.github.io/mTeSS-X/exchange
2834

2935
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.
3036

31-
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.
37+
Examples of TeSS instances can be viewed on the [global usages page](global).
3238

3339

3440
### Learning path
@@ -38,7 +44,7 @@ A a pathway that guides learners through a set of modules (courses/materials) to
3844

3945
### mTeSS-X Project
4046

41-
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.
47+
The [mTeSS-X Project](mtess-x) (Multi-space Training e-Support System with eXchange) overcomes the fragmentation of training resources across Research Infrastructures and the European Science Clusters.
4248
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.
4349

4450

@@ -61,11 +67,6 @@ Communities will be welcome to request their own space on the TeSSHub, providing
6167
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.
6268

6369

64-
### TeSS Portal
65-
66-
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.
67-
68-
6970
### Training material
7071

7172
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).

‎TeSS_docs/overview/global.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Global usage of TeSS
2+
3+
TeSS is an open source, reusable software platform, and has been deployed by several other communities across the globe.
4+
5+
::::{grid} 1 1 2 3
6+
:class-container: text-center
7+
:gutter: 3
8+
9+
:::{grid-item-card}
10+
:link: https://tess.elixir-europe.org/
11+
{fas}`earth-europe;sd-text-secondary` **ELIXIR TeSS (Training eSupport System)**
12+
^^^
13+
The original TeSS portal, computational resources for life sciences for ELIXIR Europe
14+
:::
15+
16+
:::{grid-item-card}
17+
:link: https://pan-training.eu/
18+
{fas}`earth-europe;sd-text-secondary` **PaN Training Catalogue**
19+
^^^
20+
Training for photon & neutron science around Europe
21+
:::
22+
23+
:::{grid-item-card}
24+
:link: https://dresa.org.au/
25+
{fas}`earth-oceania;sd-text-secondary` **Digital Research Skills Australasia (DReSA)**
26+
^^^
27+
Browsing, discovering and organising digital research events and training resources
28+
:::
29+
30+
:::{grid-item-card}
31+
:link: https://taxila.nl/
32+
{fas}`earth-europe;sd-text-secondary` **Taxila**
33+
^^^
34+
Collection of trainers, events, and materials empowering research in the Netherlands
35+
:::
36+
37+
:::{grid-item-card}
38+
:link: https://training.scilifelab.se/
39+
{fas}`earth-europe;sd-text-secondary` **SciLifeLab Training Portal**
40+
^^^
41+
Training for life science professionals across Sweden
42+
:::
43+
44+
:::{grid-item-card}
45+
:link: https://explora.alliancecan.ca/
46+
{fas}`earth-americas;sd-text-secondary` **Explora**
47+
^^^
48+
Canadian digital research infrastructure training (Digital Research Alliance of Canada)
49+
:::
50+
51+
:::{grid-item-card}
52+
:link: https://training.cern.ch/
53+
{fas}`earth-europe;sd-text-secondary` **HEP Training**
54+
^^^
55+
Training and events for the High Energy Physics community
56+
:::
57+
58+
:::{grid-item-card}
59+
:link: https://everse-training.app.cern.ch/
60+
{fas}`earth-europe;sd-text-secondary` **EVERSE Training**
61+
^^^
62+
Training and events to foster research software quality in Europe
63+
:::
64+
65+
::::
66+
67+
If you are maintaining an instance of TeSS and would like us to include it here, please [contact us](https://tess.elixir-europe.org/about/us#contact).

‎TeSS_docs/overview/mtess-x.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# mTeSS-X
2+
3+
**Scaling training portal federation for RIs through Multi-tenanting and Exchange**
4+
5+
To overcome fragmentation of training resources across Research Infrastructures (RIs)
6+
and the Science Clusters, the mTeSS-X project aims to enhance the existing
7+
[ELIXIR TeSS platform](https://tess.elixir-europe.org/about) —
8+
to build an aggregator for training portals like ELIXIR TeSS and
9+
[PaNOSC training portals](https://www.panosc.eu/training-catalogue/)
10+
— to natively support federation.
11+
12+
Such a fully-featured open-source multi-tenanted training platform is expected to be an
13+
innovation for building a federation of portals to:
14+
15+
- help break down barriers between thematic communities,
16+
- promote a more cohesive European research community,
17+
- and promote FAIR and open training.
18+
19+
The project strives to support the federation of training catalogues using a multi-tenancy approach, and enabling cross-instance content exchange. This will allow RIs and their communities to maintain tailored catalogues with distinct identities, while simultaneously benefiting from a shared global pool of resources.
20+
21+
```{button-link} https://elixirtess.github.io/mTeSS-X/
22+
:color: primary
23+
View the project website
24+
```

‎TeSS_docs/overview/tess.md‎

Lines changed: 0 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -14,71 +14,3 @@ The project aims to enhance existing TeSS-based training registries or catalogue
1414
TeSS was originally developed as part of [ELIXIR](https://elixir-europe.org/), Europe's distributed infrastructure for life-science data.
1515
One of the goals of ELIXIR is to train research scientists to better use available computational infrastructures to address critical research questions.
1616
This requires access both to face-to-face training opportunities and to disparate training materials and resources, currently dispersed across Europe.
17-
18-
## Global instances of TeSS
19-
20-
TeSS is an open source, reusable software platform, and has been deployed by several other communities across the globe.
21-
22-
::::{grid} 1 1 2 3
23-
:class-container: text-center
24-
:gutter: 3
25-
26-
:::{grid-item-card}
27-
:link: https://tess.elixir-europe.org/
28-
{fas}`earth-europe;sd-text-secondary` **ELIXIR TeSS (Training eSupport System)**
29-
^^^
30-
The original TeSS portal, computational resources for life sciences for ELIXIR Europe
31-
:::
32-
33-
:::{grid-item-card}
34-
:link: https://pan-training.eu/
35-
{fas}`earth-europe;sd-text-secondary` **PaN Training Catalogue**
36-
^^^
37-
Training for photon & neutron science around Europe
38-
:::
39-
40-
:::{grid-item-card}
41-
:link: https://dresa.org.au/
42-
{fas}`earth-oceania;sd-text-secondary` **Digital Research Skills Australasia (DReSA)**
43-
^^^
44-
Browsing, discovering and organising digital research events and training resources
45-
:::
46-
47-
:::{grid-item-card}
48-
:link: https://taxila.nl/
49-
{fas}`earth-europe;sd-text-secondary` **Taxila**
50-
^^^
51-
Collection of trainers, events, and materials empowering research in the Netherlands
52-
:::
53-
54-
:::{grid-item-card}
55-
:link: https://training.scilifelab.se/
56-
{fas}`earth-europe;sd-text-secondary` **SciLifeLab Training Portal**
57-
^^^
58-
Training for life science professionals across Sweden
59-
:::
60-
61-
:::{grid-item-card}
62-
:link: https://explora.alliancecan.ca/
63-
{fas}`earth-americas;sd-text-secondary` **Explora**
64-
^^^
65-
Canadian digital research infrastructure training (Digital Research Alliance of Canada)
66-
:::
67-
68-
:::{grid-item-card}
69-
:link: https://training.cern.ch/
70-
{fas}`earth-europe;sd-text-secondary` **HEP Training**
71-
^^^
72-
Training and events for the High Energy Physics community
73-
:::
74-
75-
:::{grid-item-card}
76-
:link: https://everse-training.app.cern.ch/
77-
{fas}`earth-europe;sd-text-secondary` **EVERSE Training**
78-
^^^
79-
Training and events to foster research software quality in Europe
80-
:::
81-
82-
::::
83-
84-
If you are maintaining an instance of TeSS and would like us to include it here, please [contact us](https://tess.elixir-europe.org/about/us#contact).

‎TeSS_docs/spaces/instance-or-space.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# When to choose your own TeSS instance or register a space in TeSSHub
22

3-
TeSS is an open source, reusable software platform, and has been [deployed by several other communities across the globe](../overview/tess). However, with the launch of the [Spaces feature](intro-spaces), it is possible for a community to create their own tailored catalogue or "view" within an existing TeSS instance. The TeSSHub is a public instance that supports the Spaces feature (launching soon).
3+
TeSS is an open source, reusable software platform, and has been [deployed by several other communities across the globe](../overview/global). However, with the launch of the [Spaces feature](intro-spaces), it is possible for a community to create their own tailored catalogue or "view" within an existing TeSS instance. The TeSSHub is a public instance that supports the Spaces feature (launching soon).
44

55

66
## Why register a space with TeSSHub?

0 commit comments

Comments
 (0)