Skip to content

Commit 2e7b83e

Browse files
shundreadThiago Chaves de Oliveira HortafsbraunMacLake
authored
docs: Fix instructions on setting editor permissions (#8208)
* docs: Fix instructions on setting editor permissions * Update docs/explanation/permissions.rst Co-authored-by: Jens-Erik Weber <MacLake@users.noreply.github.com> --------- Co-authored-by: Thiago Chaves de Oliveira Horta <thiago.coh@gmail.com> Co-authored-by: Fabian Braun <fsbraun@gmx.de> Co-authored-by: Jens-Erik Weber <MacLake@users.noreply.github.com>
1 parent 8908243 commit 2e7b83e

File tree

1 file changed

+37
-9
lines changed

1 file changed

+37
-9
lines changed

docs/explanation/permissions.rst

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,46 @@ You can find the permissions you can set for a user or groups in the Django admi
2828
Page permissions mode.
2929

3030
Filtering by ``cms`` will show the ones that belong to the CMS application. Permissions that a CMS
31-
editor will need are likely to include:
31+
editor will need are likely to include the following core package permissions:
3232

33-
* ``cms | cms plugin``
34-
* ``cms | page``
35-
* ``cms | placeholder``
36-
* ``cms | placeholder reference``
37-
* ``cms | static placeholder``
38-
* ``cms | placeholder reference``
39-
* ``cms | title``
33+
* ``django CMS | cms plugin``
34+
* ``django CMS | page``
35+
* ``django CMS | placeholder``
36+
* ``django CMS | placeholder reference``
4037

4138
Most of these offer the usual add/change/delete options, though there are some exceptions, such as
42-
``cms | placeholder | Can use Structure mode``.
39+
``django CMS | placeholder | Can use Structure mode``.
40+
41+
In addition to the core package permissions, an editor will likely need the following permissions
42+
from 3rd-party packages:
43+
44+
* `djangocms-alias <https://pypi.org/project/djangocms-alias/>`_
45+
46+
* ``django CMS Alias | alias``
47+
* ``django CMS Alias | alias content``
48+
* ``django CMS Alias | category``
49+
50+
* `djangocms-frontend <https://pypi.org/project/djangocms-frontend/>`_
51+
52+
* ``django CMS Frontend | UI item``
53+
* After adding these permissions, save and use the ``python manage.py frontend sync_permissions``
54+
command as documented in `djangocms-frontend's documentation
55+
<https://djangocms-frontend.readthedocs.io/en/stable/tutorial/builtin_components.html#assigning-permissions>`_
56+
57+
* `djangocms-text <https://pypi.org/project/djangocms-text/>`_
58+
59+
* ``django CMS Rich Text | text``
60+
61+
* `djangocms-versioning <https://pypi.org/project/djangocms-versioning/>`_
62+
63+
* ``django CMS Versioning | alias content version``
64+
* ``django CMS Versioning | page content version``
65+
* ``django CMS Versioning | version``
66+
67+
Typically when adding other 3rd party packages or custom plugins you may need to add additional
68+
permissions to enable their features. Sometimes documentation for such needed permissions may be
69+
missing, in that case you can compare the list of available permissions with the package enabled
70+
and disabled on your site.
4371

4472
See :ref:`use-permissions-on-groups` below on applying permissions to groups rather than users.
4573

0 commit comments

Comments
 (0)