docs: add badges penalty configuration (#178)

raccoongang · May 22, 2024 · 7320c0a · 7320c0a
1 parent 791b105
commit 7320c0a
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/docs/_static/images/badges/badges-admin-penalty-rules.png b/docs/_static/images/badges/badges-admin-penalty-rules.png
diff --git a/docs/badges/configuration.rst b/docs/badges/configuration.rst
@@ -140,6 +140,22 @@ All key paths are generated based on the event type specified for the parent Bad
 
 Please, see `configuration examples`_ for clarity.
 
+Badge Penalties
+---------------
+
+    Penalties allow badge progress resetting based on user activity.
+
+Badge penalties are optional.
+There could be 0 or more badge penalties configured for a badge template.
+
+Each badge penalty is *targeted* to 1 or more badge requirements.
+A penalty setup is similar to a badge requirement, but has different effect: it decreases badge progress for a user.
+
+When a penalty has worked all linked badge requirements are "rolled back" (user's progress for such requirements is reset).
+
+.. image:: ../_static/images/badges/badges-admin-penalty-rules.png
+        :alt: Badge penalty rules edit
+
 Activation
 ----------
 

diff --git a/docs/badges/index.rst b/docs/badges/index.rst
@@ -1,5 +1,5 @@
-Badges (in progress)
-====================
+Badges
+======
 
     The Badges feature allows learners to earn achievements (badges) for their learning activities.
 
@@ -9,6 +9,8 @@ Badges (in progress)
 
 Current Badges version is highly integrated with the `Credly (by Pearson)`_ service, but it is fully prepared to be used separately.
 
+Note: this feature shadows previously deprecated Badges (Badgr-based).
+
 ----
 
 .. toctree::