From 24d5425d4c3696436d90e0d7e3e7e6af9bbe4b15 Mon Sep 17 00:00:00 2001
From: Maximilian Moser <maximilian.moser@tuwien.ac.at>
Date: Thu, 6 Feb 2025 10:49:35 +0100
Subject: [PATCH] Update README
* fix links being formatted in MD rather than reST
* mention the new submission review workflow, notification backends, and
background tasks
---
README.rst | 38 ++++++++++++++++++++++++++++++++++----
1 file changed, 34 insertions(+), 4 deletions(-)
diff --git a/README.rst b/README.rst
index 453d145..2816141 100644
--- a/README.rst
+++ b/README.rst
@@ -1,5 +1,5 @@
..
- Copyright (C) 2020-2024 TU Wien.
+ Copyright (C) 2020-2025 TU Wien.
Invenio-Config-TUW is free software; you can redistribute it and/or
modify it under the terms of the MIT License; see LICENSE file for more
@@ -15,10 +15,13 @@ The following list is a quick overview of the most relevant customizations happe
* Configuration values
* Permission policies
+* Mandatory submission reviews
* OIDC authentication handling
* E-Mail notification on errors
+* Customized notification backends
* User profile extension
* Integration with other TU Wien services
+* Custom background tasks
Details
@@ -35,7 +38,7 @@ Permission policies
-------------------
InvenioRDM is not just some sort of cheap storage platform where users can upload their data and update it at any time.
-Instead, it is a platform intended to host digital objects that get [DOIs](https://www.doi.org/) assigned.
+Instead, it is a platform intended to host digital objects that get `DOIs <https://www.doi.org/>`_ assigned.
Since the idea behind DOIs (and persistent identifiers in general) is to point at the same content over time, it does not allow users to change the files after publication.
This is one of the unique features that the system offers that may not be immediately obvious to users.
@@ -48,6 +51,17 @@ Also, communities can be quite confusing in the beginning.
Thus, we restrict the creation of new communities for non-administrators.
+Mandatory submission reviews
+----------------------------
+
+Before any upload can be published, it needs to undergo a mandatory submission review.
+This enhances the quality, reusability, and long-term preservation of uploaded content.
+
+Previously, this was implemented via customized permission policies and required communication via external channels.
+As of ``v2025.1.0``, the workflow is based on `Invenio-Curations <https://github.com/tu-graz-library/invenio-curations>`_.
+This allows the entire workflow to be handled through the system, and allows the system to act as a ticketing system for reviews.
+
+
OIDC authentication handling
----------------------------
@@ -59,7 +73,13 @@ Sometimes we have slightly non-standard requirements, which are satisfied by the
E-Mail notification on errors
-----------------------------
-This module defines a custom log handler for error-level logs which sends out notifications as e-mail to a set of configured recipient addresses.
+This package defines a custom log handler for error-level logs which sends out notifications as e-mail to a set of configured recipient addresses.
+
+
+Customized notification backends
+--------------------------------
+
+To make setting automatic email handling rules simple, we set the ``X-Sender`` email header field to a configurable value.
User profile extension
@@ -73,4 +93,14 @@ Integration with other TU Wien services
---------------------------------------
One of the benefits of hosting InvenioRDM as an institutional repository is that it enables some conveniences by integrating with the local environment more.
-For example, we integrate with [TISS](https://tiss.tuwien.ac.at/) by periodically querying it for TU Wien employees and adding their names to the controlled vocabulary of known ``names``.
+For example, we integrate with `TISS <https://tiss.tuwien.ac.at/>`_ by periodically querying it for TU Wien employees and adding their names to the controlled vocabulary of known ``names``.
+
+
+Custom background tasks
+-----------------------
+
+To make the continued operation of the system smoother, this package also provides some background tasks:
+
+* Reminder notifications to reviewers about open submission reviews
+* Reminder notifications to users about accepted submissions
+* Periodic updates of the ``names`` vocabulary via TISS
--
GitLab