-
Notifications
You must be signed in to change notification settings - Fork 5
Adding groups documentation #32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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 | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| 4. Send these details to the administrator of the TeSS instance. | ||||||
| 5. You will be informed of the outcome shortly. | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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) | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - {fas}`clipboard-check;sd-text-success` No installation or server required | ||||||
| - {fas}`clipboard-question;sd-text-warning` Limited technical customisation options | ||||||
|
|
||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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: | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
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. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
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). | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
I don't think we need the detail of multiple groups/lists here. |
||||||
|
|
||||||
| ```{image} ../images/spaces/graphic-multi-space.svg | ||||||
| :alt: Graphic of multi-spaces | ||||||
| :class: mb-1 | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.