From fab6bb2f26587f6112a0cf0e631d461600d62bee Mon Sep 17 00:00:00 2001 From: Valentin Ryckaert Date: Thu, 2 Jul 2026 11:30:44 +0200 Subject: [PATCH] docs: add docs for groups --- TeSS_docs/_toc.yml | 3 +++ TeSS_docs/groups/intro-groups.md | 14 ++++++++++++++ TeSS_docs/overview/definitions.md | 4 ++++ TeSS_docs/spaces/instance-or-space.md | 2 +- TeSS_docs/spaces/intro-spaces.md | 4 ++++ TeSS_docs/spaces/request-space.md | 2 +- 6 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 TeSS_docs/groups/intro-groups.md diff --git a/TeSS_docs/_toc.yml b/TeSS_docs/_toc.yml index 1bfad7c..6cf37e9 100644 --- a/TeSS_docs/_toc.yml +++ b/TeSS_docs/_toc.yml @@ -25,6 +25,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 diff --git a/TeSS_docs/groups/intro-groups.md b/TeSS_docs/groups/intro-groups.md new file mode 100644 index 0000000..220e6fa --- /dev/null +++ b/TeSS_docs/groups/intro-groups.md @@ -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. \ No newline at end of file diff --git a/TeSS_docs/overview/definitions.md b/TeSS_docs/overview/definitions.md index 20b9372..0813df6 100644 --- a/TeSS_docs/overview/definitions.md +++ b/TeSS_docs/overview/definitions.md @@ -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. diff --git a/TeSS_docs/spaces/instance-or-space.md b/TeSS_docs/spaces/instance-or-space.md index 4a689b9..d550e97 100644 --- a/TeSS_docs/spaces/instance-or-space.md +++ b/TeSS_docs/spaces/instance-or-space.md @@ -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 diff --git a/TeSS_docs/spaces/intro-spaces.md b/TeSS_docs/spaces/intro-spaces.md index e72f731..22fbb0e 100644 --- a/TeSS_docs/spaces/intro-spaces.md +++ b/TeSS_docs/spaces/intro-spaces.md @@ -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 diff --git a/TeSS_docs/spaces/request-space.md b/TeSS_docs/spaces/request-space.md index 4c9964a..574433c 100644 --- a/TeSS_docs/spaces/request-space.md +++ b/TeSS_docs/spaces/request-space.md @@ -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.