Skip to content

Commit 10f1552

Browse files
committed
Update docs
1 parent 6ef6e47 commit 10f1552

File tree

10 files changed

+89
-13
lines changed

10 files changed

+89
-13
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/index.rst

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,39 @@ Welcome to "djangocms-versioning"'s documentation!
33

44
.. toctree::
55
:maxdepth: 2
6-
:caption: Quick Start:
6+
:caption: Tutorials:
77

8-
basic_concepts
9-
versioning_integration
10-
permissions
11-
version_locking
8+
introduction/basic_concepts
9+
introduction/versioning_integration
1210

1311
.. toctree::
1412
:maxdepth: 2
15-
:caption: API Reference:
13+
:caption: How-To Guides:
14+
15+
howto/permissions
16+
howto/version_locking
17+
18+
.. toctree::
19+
:maxdepth: 2
20+
:caption: Reference:
1621

1722
api/advanced_configuration
1823
api/signals
19-
api/customizing_version_list
2024
api/management_commands
21-
settings
25+
api/settings
2226

2327
.. toctree::
2428
:maxdepth: 2
25-
:caption: Internals:
29+
:caption: Explanation:
2630

27-
admin_architecture
31+
explanations/admin_architecture
32+
explanations/customizing_version_list
2833

2934
.. toctree::
3035
:maxdepth: 2
3136
:caption: Release notes:
3237

38+
upgrade/2.4.0
3339
upgrade/2.0.0
3440

3541

File renamed without changes.
File renamed without changes.

docs/upgrade/2.0.0.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _upgrade-to-2-0-0:
22

3-
********************************
4-
2.0.0 release notes (unreleased)
5-
********************************
3+
*******************
4+
2.0.0 release notes
5+
*******************
66

77
*October 2023*
88

docs/upgrade/2.4.0.rst

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
.. _upgrade-to-2-0-0:
2+
3+
*******************
4+
2.4.0 release notes
5+
*******************
6+
7+
*July 2025*
8+
9+
Welcome to django CMS versioning 2.4.0!
10+
11+
These release notes cover the new features, as well as some backwards
12+
incompatible changes you’ll want to be aware of when upgrading from
13+
django CMS versioning 1.x.
14+
15+
16+
Django and Python compatibility
17+
===============================
18+
19+
django CMS supports **Django 4.2, 5.0, 5.1, and 5.2**. We highly recommend and only
20+
support the latest release of each series.
21+
22+
It supports **Python 3.9, 3.10, 3.11, and 3.12**. As for Django we highly recommend and only
23+
support the latest release of each series.
24+
25+
Features
26+
========
27+
28+
DefaultGrouperVersioningAdminMixin
29+
----------------------------------
30+
31+
The `DefaultGrouperVersioningAdminMixin` is a mixin that combines the functionality of
32+
both the `StateIndicatorMixin` and the `ExtendedGrouperVersionAdminMixin` into as standard
33+
recommended way to add versioning UI to grouper admin classes.
34+
35+
It also adds the versioning status indicators and the admin list actions to the grouper
36+
change list (if not already done).
37+
38+
39+
Automatic Mixin Integration for GrouperAdmin
40+
--------------------------------------------
41+
42+
* For models using the `GrouperAdmin` of django CMS' core (since 4.1), djangocms-versioning
43+
now automatically adds a mixin to the admin of versioned grouper models.
44+
* This eliminates the need for third-party packages to explicitly depend on
45+
djangocms-versioning for mixin imports, enabling better modularity and
46+
compatibility with alternative versioning solutions.
47+
* Inheritance checks ensure full backward compatibility.
48+
49+
Default pattern for versioned models:
50+
51+
+---------+------------------+------------------+----------------------------------------+
52+
| Models | Model example | Admin class | Admin mixin |
53+
+=========+==================+==================+========================================+
54+
| Grouper | ``Alias`` | ``GrouperAdmin`` | ``DefaultGrouperVersioningAdminMixin`` |
55+
+---------+------------------+------------------+----------------------------------------+
56+
| Content | ``AliasContent`` | ``ModelAdmin`` | ``VersioningAdminMixin`` |
57+
+---------+------------------+------------------+----------------------------------------+
58+
59+
To activate this feature, set the ``grouper_admin_mixin`` property to ``"__default__"`` which
60+
will cause the ``DefaultGrouperVersioningAdminMixin`` to be used:
61+
62+
.. code-block::
63+
64+
VersionableItem(
65+
...,
66+
grouper_admin_mixin="__default__", # or a custom mixin class
67+
...,
68+
)
69+
70+

0 commit comments

Comments
 (0)