Skip to content
Open
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
4 changes: 4 additions & 0 deletions TeSS_docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ parts:
- caption: Overview
chapters:
- file: overview/tess
- file: overview/about
- file: overview/global
- file: overview/mtess-x
- file: overview/tesshub4eosc
Expand All @@ -26,6 +27,9 @@ parts:
- file: spaces/intro-spaces
- file: spaces/instance-or-space
- file: spaces/request-space
- caption: Group creation
chapters:
- file: groups/intro-groups
- caption: Content registration
chapters:
- file: content/intro-content
Expand Down
8 changes: 8 additions & 0 deletions TeSS_docs/content/sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ Currently available **admin-managed** ingestion methods:

For other methods, please [contact us](https://tess.elixir-europe.org/about/us#contact) to discuss how to register your content automatically in TeSS.

## Other ingestion methods

The TeSS team may be able to support other source formats and write an ingestion method for them:

- **RSS feeds**: many websites publish recent posts in a standard news-feed format that can be parsed.
- **Git repositories**: if training resources are developed in GitHub or another Git repository, TeSS can clone the repository and extract resource information. A metadata file in YAML format may be required.
- **Other structured formats**: XML, JSON, CSV, YAML or another metadata export may also be suitable for ingestion after discussion with the TeSS team.

## Google Sheets

Our preferred options are for you to provide [structured data markup](structured-data-types) directly in the webpages that describe your training materials, or provide a single page with the markup for all the materials. This may not be possible, for example, if you have technical restrictions with your content management system.
Expand Down
4 changes: 3 additions & 1 deletion TeSS_docs/developers/code-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,13 @@ https://tess.elixir-europe.org/materials/how-to-make-your-messy-data-usable-open

The full documentation for the TeSS JSON API can be found here:

```{button-link} hhttps://tess.elixir-europe.org/api/json_api
```{button-link} https://tess.elixir-europe.org/api/json_api
:color: primary
View the JSON-API documentation
```

If you already use the old API, technical information is still available in the [legacy API documentation](https://tess.elixir-europe.org/api/legacy).


## Developer guides

Expand Down
2 changes: 2 additions & 0 deletions TeSS_docs/developers/credit.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ The TeSS team would like to acknowledge the help of a number of groups and indiv
- The ELIXIR Training Coordinators group, particularly Celia van Gelder, Patricia Palagi and Gabriella Rustici
- The UK structural bioinformatics group, particularly Christine Orengo

The TeSS platform is based on the [ELIXIR TeSS platform](https://elixir-europe.org/).

## Cite us

> Niall Beard, Finn Bacall, Aleksandra Nenadic, Milo Thurston, Carole A Goble, Susanna-Assunta Sansone, Teresa K Attwood, TeSS: a platform for discovering life-science training opportunities, Bioinformatics, Volume 36, Issue 10, 15 May 2020, Pages 3290-3291, https://doi.org/10.1093/bioinformatics/btaa047
14 changes: 14 additions & 0 deletions TeSS_docs/groups/intro-groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Introduction to groups

Groups is a feature which for now is used only to manage access of private spaces.

A user being part of a group has access to every private space which requires the group.

Each group has multiple owners. A owner can add and remove people to the group.

To request a new group on TeSS for your use case:

1. Select a TeSS instance for your request.
2. Prepare the following details of the new group: a title, your username and the list of users/owners of your group
4. Send these details to the administrator of the TeSS instance.
5. You will be informed of the outcome shortly.
Binary file added TeSS_docs/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 45 additions & 0 deletions TeSS_docs/overview/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# About the TeSS community

## TeSS Club

The TeSS Club brings the community together through fortnightly meetings, hackathons, shared activities, open priority setting and open contribution.

For further details, visit the [TeSS Club website](https://elixirtess.github.io/about/).

## Contact

For enquiries, information or assistance, contact the TeSS support desk at [tess-support@googlegroups.com](mailto:tess-support@googlegroups.com).

## Team

### Leadership

- Carole Goble
- Hedi Peterson

### Project management

- Munazah Andrabi
- Phil Reed

### Software engineering

- Finn Bacall
- Ivan Kuzmin

### Community engagement

- Alexander Botzki
- Olivier Sand

### Past members

- Aleksandra Nenadic, project management and software engineering
- Aleksandra Pawlik, project management
- Teresa K. Attwood, leadership
- Susanna-Assunta Sansone, leadership
- Niall Beard, project management and software engineering
- Milo Thurston, software engineering
- Chris Child, project management and software engineering
- Aitor Apaolaza, software engineering
- Alexia Cardona, leadership
4 changes: 4 additions & 0 deletions TeSS_docs/overview/definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ Space (mTeSS)
Each community registers, maintains and curates their material for their members in their own virtual space in the common portal environment.
See [Introduction to spaces](../spaces/intro-spaces) for details.

Group
A group is an entity which is used to control access to private spaces. A group can have multiple owners, who can add and remove people from a group.
See [Introduction to groups](../groups/intro-groups) for details.

TeSSHub
The strategic name for a TeSS instance with multiple [spaces](#term-Space-mTeSS)
that can [exchange](#term-Exchange-TeSS-X) materials with other instances.
Expand Down
2 changes: 1 addition & 1 deletion TeSS_docs/spaces/instance-or-space.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The ELIXIR TeSSHub is a public instance that supports the Spaces feature (launch
- {fas}`clipboard-check;sd-text-success` Appears as its own distinct catalogue
- {fas}`clipboard-check;sd-text-success` Can exchange materials with other TeSS instances and spaces
- {fas}`clipboard-check;sd-text-success` Support from the global TeSS community
- {fas}`clipboard-check;sd-text-success` Open and public[^freespace]
- {fas}`clipboard-check;sd-text-success` Open and public[^freespace] or private (only people being in specific groups have access)
- {fas}`clipboard-check;sd-text-success` No installation or server required
- {fas}`clipboard-question;sd-text-warning` Limited technical customisation options

Expand Down
4 changes: 4 additions & 0 deletions TeSS_docs/spaces/intro-spaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ Each community registers, maintains and curates their material for their members

This new feature is possible thanks to the [mTeSS-X project](../overview/mtess-x). Catalogues are pooled into a shared instance but look to their community as if they have their own catalogue with their own identity.

There are two types of spaces:
- **public space**: its resources are accessible from the outside (visible in the main catalogue with a special toggle). Anyone, logged in or not, can access it.
- **private space**: its resources are not visible outside the space (even with the toggle in the main catalogue to see resources from other spaces). A private space requires being in at least one of a defined list of groups to have access to it (the list can be one or more groups).

```{image} ../images/spaces/graphic-multi-space.svg
:alt: Graphic of multi-spaces
:class: mb-1
Expand Down
2 changes: 1 addition & 1 deletion TeSS_docs/spaces/request-space.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Further details about the governance of spaces are decided by the administration
To request a new space on TeSS:

1. Select a TeSS instance with multiple spaces for your request.
2. Prepare the following details of the new space: Title, Description, Image (logo for your community), Administrators (list of TeSS usernames to be space managers).
2. Prepare the following details of the new space: Title, Description, Image (logo for your community), Administrators (list of TeSS usernames to be space managers), whether the space is private and, if so, which groups are required (you can ask to create new groups for your specific use case).
3. Select a theme (see below): Default, Green, Blue, Space, Dark.
4. Send these details to the administrator of the TeSS instance.
5. You will be informed of the outcome shortly.
Expand Down