Adding groups documentation - #32
Open
valentinRyckaert wants to merge 3 commits into
Open
Conversation
PhilReedData
requested changes
Aug 5, 2026
PhilReedData
left a comment
PhilReedData
left a comment
Collaborator
There was a problem hiding this comment.
Overall very good. I have made some suggestions about the language in a few places.
|
|
||
| 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. |
Collaborator
There was a problem hiding this comment.
Suggested change
| A user being part of a group has access to every private space which requires the group. | |
| A user of a group has access to every private space associated with that 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 |
Collaborator
There was a problem hiding this comment.
Suggested change
| 2. Prepare the following details of the new group: a title, your username and the list of users/owners of your group | |
| 2. Prepare the following details of the new group: a title, your username and the list of users/owners of your group. |
| - {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) |
Collaborator
There was a problem hiding this comment.
Suggested change
| - {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` Open and public[^freespace] or private (only people in specific groups have access) |
|
|
||
| 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: |
Collaborator
There was a problem hiding this comment.
Suggested change
| There are two types of spaces: | |
| There are two types of spaces, depending on the configuration of the TeSS instance: |
| 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. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - **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. | |
| - **public space** (default): its resources are visible to everybody viewing the space (and visible in the main catalogue with a filter). You do not have to be logged in. |
|
|
||
| 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). |
Collaborator
There was a problem hiding this comment.
Suggested change
| - **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). | |
| - **private space**: its resources are not visible outside the space (even with the filter in the main catalogue to see resources from other spaces). A private space requires the user to be associated with a relevant group. You have to be logged in. |
I don't think we need the detail of multiple groups/lists here.
PhilReedData
approved these changes
Aug 10, 2026
PhilReedData
left a comment
PhilReedData
left a comment
Collaborator
There was a problem hiding this comment.
That's great, thank you @valentinRyckaert. I will wait to merge this PR when the feature code is approved and available from the main TeSS code repo.
| - {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 in specific groups have access) |
Collaborator
There was a problem hiding this comment.
Suggested change
| - {fas}`clipboard-check;sd-text-success` Open and public[^freespace] or private (only people in specific groups have access) | |
| - {fas}`clipboard-check;sd-text-success` Open and public[^freespace] or private (only people in specific [groups](../groups/intro-groups) have access) |
I've found one more change I'd like to make please, but I don't have permission on this branch. @valentinRyckaert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of changes
Add user documentation linked to this pull request