Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fsbraun authored and marksweb committed Jan 15, 2024
1 parent 4882fbc commit 2dd3b7b
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions docs/version_locking.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,38 @@
.. _locking-versions:

****************
Locking versions
****************
================

Explanation
-----------
The lock versions setting is intended to modify the way djangocms-versioning works in the following way:

The lock versions setting is intended to modify the way djangocms-versioning works in
the following way:

- A version is **locked to its author** when a draft is created.
- The lock prevents editing of the draft by anyone other than the author.
- That version becomes automatically unlocked again once it is published.
- Locks can be removed by a user with the correct permission (``delete_versionlock``)
- Unlocking an item sends an email notification to the author to which it was locked.
- Manually unlocking a version does not lock it to the unlocking user, nor does it change the author.
- The Version admin view for each versioned content-type shows lock icons and offers unlock actions
- Manually unlocking a version does not lock it to the unlocking user, nor does it
change the author.
- The Version admin view for each versioned content-type shows lock icons and offers
unlock actions

Activation
----------
In your project's ``settings.py`` add::

DJANGOCMS_VERSIONING_LOCK_VERSIONS = True
In your project's ``settings.py`` add:

.. code-block::
DJANGOCMS_VERSIONING_LOCK_VERSIONS = True
Email notifications
------------------------
Configure email notifications to fail silently by setting::
-------------------

Configure email notifications to fail silently by setting:

.. code-block::
EMAIL_NOTIFICATIONS_FAIL_SILENTLY = True

0 comments on commit 2dd3b7b

Please sign in to comment.