Skip to content

Adding content curation documentation - #36

Closed
kennethrioja wants to merge 2 commits into
ElixirTeSS:mainfrom
hep-training:approval
Closed

kennethrioja wants to merge 2 commits into
ElixirTeSS:mainfrom
hep-training:approval

Conversation

@kennethrioja

Copy link
Copy Markdown
Collaborator

As discussed in the dev's meeting on Wed Sep 30, 2026. This describes ElixirTeSS/TeSS#1382 for users

@PhilReedData PhilReedData left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've not run locally yet but from reviewing on GitHub.com, I have made some stylistic suggestions to be consistent with other pages.

Comment thread TeSS_docs/content/curation.md Outdated

Ask your TeSS administrator if the `material_under_admin_approval` or `event_under_admin_approval` features are enabled.

To see if your TeSS instance is supporting this feature, if you [manually register](./manual.md) a training material or event, the message *"This material/event will need to be approved by an administrator before being public"* is shown on the top of the form like the following screenshot:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To see if your TeSS instance is supporting this feature, if you [manually register](./manual.md) a training material or event, the message *"This material/event will need to be approved by an administrator before being public"* is shown on the top of the form like the following screenshot:
To see if your TeSS instance is supporting this feature, if you [manually register](./manual) a training material or event, the message *'This material/event will need to be approved by an administrator before being public'* is shown on the top of the form like the following screenshot:

Hyperlinks work in production and development environments if we exclude the file extensions in the links. (Maybe what you have written works on production too, but this suggested change makes the format of links consistent.)

Also, I am putting in single quotes when we reference text on screen, across all the docs.

Comment thread TeSS_docs/content/curation.md Outdated

## How training resources are curated in TeSS?

When [prerequisites](#prerequisites) are met, any added training material or event (either [manually](./manual.md) or [automatically](./auto.md)) will be **by default** subject to verification and thus, not publicly shown in your TeSS instance. Your resource will be marked with an `Approval status` set to `Requested`, as shown below:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When [prerequisites](#prerequisites) are met, any added training material or event (either [manually](./manual.md) or [automatically](./auto.md)) will be **by default** subject to verification and thus, not publicly shown in your TeSS instance. Your resource will be marked with an `Approval status` set to `Requested`, as shown below:
When [prerequisites](#prerequisites) are met, any added training material or event (either [manually](./manual) or [automatically](./auto)) will be **by default** subject to verification and thus, not publicly shown in your TeSS instance. Your resource will be marked with an 'Approval status' set to 'Requested', as shown below:

Comment thread TeSS_docs/content/curation.md Outdated

*Curators* can then have access to a dashboard to review the newly registered resources by accessing the `your-tess-instance-website.org/curate/resources` page, which can be also found by clicking on the dropdown menu of the user profile on the top-right of the page once logged in > "Curate resources".

In the dashboard, *curators* can filter resources by Type (material, event), User, [Provider](../accounts/provider.md), [Space](../spaces/intro-spaces.md), and Approval Status. `Approve All Filtered` and `Reject All Filtered` buttons can be found at the bottom of the page to allow approval or rejection of the filtered resources. For example, if you have a new Content Provider adding thousands of already curated materials, you can filter the list by their name and approve them all in a few clicks only.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In the dashboard, *curators* can filter resources by Type (material, event), User, [Provider](../accounts/provider.md), [Space](../spaces/intro-spaces.md), and Approval Status. `Approve All Filtered` and `Reject All Filtered` buttons can be found at the bottom of the page to allow approval or rejection of the filtered resources. For example, if you have a new Content Provider adding thousands of already curated materials, you can filter the list by their name and approve them all in a few clicks only.
In the dashboard, *curators* can filter resources by Type (material, event), User, [Provider](../accounts/provider), [Space](../spaces/intro-spaces), and Approval Status. 'Approve All Filtered' and 'Reject All Filtered' buttons can be found at the bottom of the page to allow approval or rejection of the filtered resources. For example, if you have a new Content Provider adding thousands of already curated materials, you can filter the list by their name and approve them all in a few clicks only.

Comment thread TeSS_docs/content/curation.md Outdated

![Information about a material that needs curation](../images/content/material_alert_new.png)

## How training resources are curated in TeSS?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## How training resources are curated in TeSS?
## How are training resources curated in TeSS?

Phrasing as a question if we keep the question mark... or remove the question mark.

Comment thread TeSS_docs/content/curation.md Outdated

![A material with requested view](../images/content/material_requested_view.png)

Once a resource is registered or ingested, the curation/verification can be made by `administrators`,`curators` or `space administrators`, which are specific TeSS user roles (generally speaking, *curators*). Space administrators can only see resources from their space.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once a resource is registered or ingested, the curation/verification can be made by `administrators`,`curators` or `space administrators`, which are specific TeSS user roles (generally speaking, *curators*). Space administrators can only see resources from their space.
Once a resource is registered or ingested, the curation/verification can be made by 'administrators', 'curators' or 'space administrators', which are specific TeSS user roles (generally speaking, *curators*). Space administrators can only see resources from their space.

Comment thread TeSS_docs/content/curation.md Outdated

Once a resource is registered or ingested, the curation/verification can be made by `administrators`,`curators` or `space administrators`, which are specific TeSS user roles (generally speaking, *curators*). Space administrators can only see resources from their space.

*Curators* can then have access to a dashboard to review the newly registered resources by accessing the `your-tess-instance-website.org/curate/resources` page, which can be also found by clicking on the dropdown menu of the user profile on the top-right of the page once logged in > "Curate resources".

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
*Curators* can then have access to a dashboard to review the newly registered resources by accessing the `your-tess-instance-website.org/curate/resources` page, which can be also found by clicking on the dropdown menu of the user profile on the top-right of the page once logged in > "Curate resources".
*Curators* can then have access to a dashboard to review the newly registered resources by accessing the `your-tess-instance-website.org/curate/resources` page, which can be also found by clicking on the dropdown menu of the user profile on the top-right of the page once logged in > 'Curate resources'.

Comment thread TeSS_docs/content/curation.md Outdated

## How to revoke the approval status of a resource?

A *curator* may have misclicked the `Approve` button, they may come back to their decision by editing the resource manually, scroll down, and change the `Approval status` field to `Requested`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A *curator* may have misclicked the `Approve` button, they may come back to their decision by editing the resource manually, scroll down, and change the `Approval status` field to `Requested`.
A *curator* may have misclicked the 'Approve' button, they may come back to their decision by editing the resource manually, scroll down, and change the 'Approval status' field to 'Requested'.

@kennethrioja
kennethrioja deleted the approval branch October 9, 2026 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants