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
5 changes: 5 additions & 0 deletions TeSS_docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ parts:
- file: overview/definitions
- file: overview/what-we-catalogue
- file: overview/fair
- caption: Roles
chapters:
- file: roles/administrator
- file: roles/trainer
- file: roles/content_provider
- caption: Search
chapters:
- file: search/searching
Expand Down
4 changes: 2 additions & 2 deletions TeSS_docs/accounts/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ A TeSS instance is viewable by everyone, you do not need to register to search o
The materials that TeSS points to may be restricted-access, but the registry itself is open.
If you want to register your materials, you can register for a user account.

```{admonition} Note for mutli-space TeSS instances
```{admonition} Note for multi-space TeSS instances
:class: note
If a TeSS instanace has multiple [spaces](../spaces/intro-spaces), please register one user account for all spaces.
If a TeSS instance has multiple [spaces](../spaces/intro-spaces), please register one user account for all spaces.
For security reasons, if the spaces are on different domains (`site1.com` and `site2.com`), you will need to log in to each space separately, even though you are using the same account.
```

Expand Down
9 changes: 9 additions & 0 deletions TeSS_docs/roles/administrator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Administrator

As an administrator, you have many rights inside HEP Training. An administrator can:

- create/delete spaces (public and private)
- manage users
- manage resources

They are the primary person to address requests of any kind which require a high level of privileges.
5 changes: 5 additions & 0 deletions TeSS_docs/roles/content_provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Content provider

A content provider is an organization which proposes resources on HEP Training.

To register a content provider, go to [https://heptraining.cern.ch/content_providers/new](https://heptraining.cern.ch/content_providers/new) and add the content provider. You will be the owner of it.
5 changes: 5 additions & 0 deletions TeSS_docs/roles/trainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Trainer

As a trainer, you have a public profile on HEP Training and you are featured on the main page. It helps people to see your work.

To create your profile, click on your username on the top-right of the navigation bar and go to "My profile" > Edit profile. You will find a "Trainer Details" form where you can enter your info.
2 changes: 1 addition & 1 deletion TeSS_docs/search/searching.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ To perform a filtered search on a particular type of training:
1. In the top menu, click the type of training you wish to search.
2. You can enter **keywords** in the search box above the results.
3. You can **sort** results by date or title using the control on the left.
4. You can **filter** results by multiple paramaters using the controls on the left.
4. You can **filter** results by multiple parameters using the controls on the left.
- For example, search across all spaces in a TeSS instance by clicking 'Show materials from all spaces'.
5. You can move through the pages of results at the bottom of the page.

Expand Down
16 changes: 12 additions & 4 deletions TeSS_docs/spaces/intro-spaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,21 @@ 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, depending on the configuration of the TeSS instance:
- **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.
- **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.

```{image} ../images/spaces/graphic-multi-space.svg
:alt: Graphic of multi-spaces
:class: mb-1
:width: 300px
:align: center
```

## Public and private space

There are two types of spaces, depending on the configuration of the TeSS instance:
- **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.
- **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.


## Deleting a space

- **Deleting private space**: deletes the resources linked to the space, but the administrator must erase the route associated to the space to avoid users to still visit the private space URL (which shows the default space).
- **Deleting public space**: moves material in the default space, thus shows it to any user.