Skip to content

Commit 9d5d56e

Browse files
committed
Add page about collections
1 parent db5ba4b commit 9d5d56e

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

TeSS_docs/_toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ parts:
3030
- file: content/manual
3131
sections:
3232
- file: content/manual-events-materials
33+
- file: content/collections
3334
- file: content/learning-paths
3435
- caption: Developers
3536
chapters:

TeSS_docs/content/collections.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Collections in TeSS
2+
3+
## What is a collection?
4+
5+
Collections can be thought of as folders in which users may collect particular training materials or events, from the full catalogue available within TeSS to address their specific training needs. Collections are visible to the public by default.
6+
7+
## Creating collections
8+
9+
```{tip}
10+
You must register training materials or events before you create a collection.
11+
```
12+
13+
Steps to create a collection:
14+
15+
1. On the 'Collections' tab, click the 'Create collection' button at the top-right.
16+
2. Give the collection a title (required), description, image and keywords.
17+
3. The collection will be public by default. Un-ticking the 'Public' box will hide this collection from anyone who isn't the creator or a collaborator.
18+
4. To add a training material to the collection, click in the ‘Add a new material’ box and begin to type its name. Select the correct material. You can provide a comment to be displayed with the material, if you wish to provide additional context or explain which parts of the material are relevant to the collection.
19+
5. Repeat step 4 to add multiple materials for this collection.
20+
6. To add an event to the collection, click in the ‘Add a new event’ box and begin to type its name. Select the correct event. You can provide a comment.
21+
7. Repeat step 6 to add multiple materials for this collection.
22+
8. You can reorder the materials and events using the arrow icons.
23+
9. When you have finished, click the ‘Create Collection’ button.
24+
25+
26+
### Managing collaborators
27+
28+
Collaborators are TeSS users who can edit a collection after it has been created. Only the collection owner can add and remove collaborators. To add a collaborator:
29+
30+
1. Navigate to the page for that collection.
31+
2. Click the ‘Collaborators’ button at the top-right of the page.
32+
3. Start to type the name or username of the collaborator you wish to add and select them. The collaborator needs to be a registered user of TeSS.
33+
4. Repeat for any additional collaborators.
34+
5. When you have finished, click the ‘Done’ button.
35+
36+
37+
### Updating collections
38+
39+
To update a collection, you need to be the owner or a collaborator:
40+
41+
1. Navigate to the page for that collection.
42+
2. Click the ‘Edit’ button at the top-right of the page.
43+
3. Make your changes then click the ‘Update Collection’ button at the bottom.
44+
4. If you wish to delete the collection, use the ‘Delete’ button next to the ‘Edit’ button on the page for that item.
45+
46+
47+
## Viewing collections
48+
49+
Collections can be browsed and searched in TeSS. They are organised by keyword.
50+
51+
1. To view the collections, click ‘Collections’ in the main menu. (Tip: To view a collection you do not need to be logged in to TeSS.)
52+
2. Click to view a collection. Read the summary box. The details of the included training materials and events appear in two tabs; click each item to open it. Information about the collection appears on the left.

0 commit comments

Comments
 (0)