Skip to content

Commit

Permalink
docs: revise moderation feature documentation and enhance navigation
Browse files Browse the repository at this point in the history
* Removed outdated screenshots referencing "suspend."
* Added a new page under the "Features" section for administration.
* Moved text from the "Release" section to the new feature page to serve as a teaser rather than a full description.
  • Loading branch information
Samk13 committed Nov 22, 2024
1 parent 041b362 commit edd284a
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 6 deletions.
Binary file added docs/features/imgs/user-management.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions docs/features/moderation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Administration panel

The administration panel is a feature in InvenioRDM introduced in v10 that provides a graphical user interface for managing users and records. It is designed to be used by administrators and superusers to moderate the content of the repository.
For more technical details you can read the [developer guide to the InvenioRDM administration panel](../develop/topics/administration_panel.md), detailing its programmatic interface and usage.

## Moderation of users and records

![The User Management](imgs/user-management.png){ loading=lazy }

_Introduced in InvenioRDM v12_

The administration panel now includes a "User management" section to deactivate, block and delete users, as well as undo all those actions. Deactivating a user temporarily prevents them from creating records, but lets them appeal their deactivation. Blocked users cannot sign in anymore and deleted users have their records removed from public view and replaced with a tombstone page indicating that the user has been blocked.

Records can also be deleted (with a grace period for appeal or undoing) which empowers administrators to enforce institutional policies and fight spam. This leaves a [tombstone page](../reference/metadata.md#tombstone) in place of the record landing page. See the [Concept DOIs section](../releases/v12/version-v12.0.0.md#dois-for-concept-records-and-no-dois-for-restricted-records) below for a screenshot.

Associated JSON APIs (e.g. `/api/domains`) have been added. Bulk versions of these are in the works.
Binary file modified docs/releases/v12/imgs/user_moderation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 1 addition & 6 deletions docs/releases/v12/version-v12.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,7 @@ This provides flexible, yet reliable access control to the records of an instanc

![The moderation actions](imgs/user_moderation.png)

The administration panel now includes a "User management" section to suspend, block and delete users, as well as undo all those actions.
Suspending a user temporarily prevents them from creating records, but lets them appeal their suspension. Blocked users cannot sign in anymore and deleted users are removed from the system.

Records can also be deleted (with a grace period for appeal or undoing) which empowers administrators to enforce institutional policies and fight spam. This leaves a [tombstone page](../../reference/metadata.md#tombstone) in place of the record landing page. See the [Concept DOIs section](#dois-for-concept-records-and-no-dois-for-restricted-records) below for a screenshot.

Associated JSON APIs (e.g. `/api/domains`) have been added. Bulk versions of these are in the works.
The administration panel now includes a "User management" section to deactivate, block and delete users, as well as undo all those actions. You can Read more about [moderation here](../../features/moderation.md/#moderation-of-users-and-records).

### DOIs for concept records and no DOIs for restricted records

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ nav:
- Customizable: "features/customization.md"
- Interoperable: "features/interoperable.md"
- Powerful: "features/powerful.md"
- Moderation: "features/moderation.md"
- Secure: "features/secure.md"
- Features walk-through:
- Features overview: "features/features-walk-through/index.md"
Expand Down

0 comments on commit edd284a

Please sign in to comment.