Skip to content

Commit 322cbfc

Browse files
MaferMazuMaferMazu
committed
docs: add the default roles and permissions documentation
1 parent cb10b9a commit 322cbfc

3 files changed

Lines changed: 124 additions & 0 deletions

File tree

‎docs/concepts/core_roles_and_permissions/content_library_roles.rst‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
Core Roles and Permissions: Content Library
2+
#############################################
3+
4+
This document outlines the built-in roles and permissions associated with the Content Library feature in the Open edX platform.
5+
6+
Index
7+
-----
8+
9+
- `Core Roles and Permissions: Content Library`_
10+
- `Permissions`_
11+
- `Library Permissions`_
12+
- `Library Content Permissions`_
13+
- `Library Team Permissions`_
14+
- `Library Collections Permissions`_
15+
- `Permissions Inheritance`_
16+
- `Roles`_
17+
- `Roles and Permissions Summary Table`_
18+
19+
Permissions
20+
-----------
21+
22+
The following permissions are associated with the content library roles:
23+
24+
Library Permissions
25+
=======================
26+
27+
- **View the library** (``view_library``): Allows users to view the content library.
28+
- **Manage library tags** (``manage_library_tags``): Allows users to manage the tags associated with library items.
29+
- **Delete the library** (``delete_library``): Allows users to delete the entire content library.
30+
31+
32+
Library Content Permissions
33+
===============================
34+
35+
- **Edit library content** (``edit_library_content``): Allows users to edit existing content within the library.
36+
- **Publish library content** (``publish_library_content``): Allows users to publish content to or from the library.
37+
- **Reuse library content** (``reuse_library_content``): Allows users to reuse content from the library in other contexts.
38+
39+
40+
Library Team Permissions
41+
=============================
42+
43+
- **View the library team** (``view_library_team``): Allows users to view the list of users or roles associated with the library.
44+
- **Manage the library team** (``manage_library_team``): Allows users to add, remove, or change the roles of users in the library team.
45+
46+
47+
Library Collections Permissions
48+
===================================
49+
50+
- **Create library collections** (``create_library_collection``): Allows users to create new collections within the library.
51+
- **Edit library collections** (``edit_library_collection``): Allows users to modify existing collections within the library.
52+
- **Delete library collections** (``delete_library_collection``): Allows users to delete collections within the library.
53+
54+
Permissions Inheritance
55+
========================
56+
57+
* **Managing library tags** (``manage_library_tags``) implies **editing library content** (``edit_library_content``).
58+
* **Deleting the library** (``delete_library``) implies **editing library content** (``edit_library_content``).
59+
* **Publishing library content** (``publish_library_content``) implies **editing library content** (``edit_library_content``).
60+
* **Editing library content** (``edit_library_content``) implies **viewing the library** (``view_library``).
61+
* **Reusing library content** (``reuse_library_content``) implies **viewing the library** (``view_library``).
62+
* **Publishing library content** (``publish_library_content``) implies **viewing the library** (``view_library``).
63+
* **Managing the library team** (``manage_library_team``) implies **viewing the library team** (``view_library_team``).
64+
* **Deleting a library collection** (``delete_library_collection``) implies **editing a library collection** (``edit_library_collection``).
65+
* **Creating a library collection** (``create_library_collection``) implies **editing a library collection** (``edit_library_collection``).
66+
* **Editing a library collection** (``edit_library_collection``) implies **viewing the library** (``view_library``).
67+
68+
Roles
69+
-----
70+
71+
- The **Library Admin** has full control over the library, including managing users, modifying content, and handling publishing workflows. They ensure content is properly maintained and accessible as needed.
72+
73+
- The **Library Author** is responsible for creating, editing, and publishing content within a library. They can manage tags and collections but cannot delete libraries or manage users.
74+
75+
- The **Library Collaborator** can create and edit content within a library but cannot publish it. They support the authoring process while leaving final publishing to Authors or Admins.
76+
77+
- The **Library User** can view and reuse content but cannot edit or delete anything.
78+
79+
Roles and Permissions Summary Table
80+
------------------------------------
81+
82+
.. table:: Matrix of Content Library Roles and Permissions
83+
:widths: auto
84+
85+
============================= ================= ================ ====================== ==============
86+
Permissions Library Admin Library Author Library Collaborator Library User
87+
============================= ================= ================ ====================== ==============
88+
**Library**
89+
view_library ✅ ✅ ✅ ✅
90+
manage_library_tags ✅ ✅ ✅ ❌
91+
delete_library ✅ ❌ ❌ ❌
92+
**Content**
93+
edit_library_content ✅ ✅ ✅ ❌
94+
publish_library_content ✅ ✅ ❌ ❌
95+
reuse_library_content ✅ ✅ ✅ ✅
96+
**Team**
97+
view_library_team ✅ ✅ ✅ ✅
98+
manage_library_team ✅ ❌ ❌ ❌
99+
**Collections**
100+
create_library_collection ✅ ✅ ✅ ❌
101+
edit_library_collection ✅ ✅ ✅ ❌
102+
delete_library_collection ✅ ✅ ✅ ❌
103+
============================= ================= ================ ====================== ==============
104+
105+
106+
**Maintenance chart**
107+
108+
+--------------+-------------------------------+----------------+--------------------------------+
109+
| Review Date | Working Group Reviewer | Release | Test situation |
110+
+--------------+-------------------------------+----------------+--------------------------------+
111+
| 2025-10-13 | RBAC Project | Ulmo | TO DO |
112+
+--------------+-------------------------------+----------------+--------------------------------+

‎docs/concepts/core_roles_and_permissions/index.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Core Roles and Permissions
2+
############################
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
content_library_roles

‎docs/concepts/index.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
Concepts
22
########
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
core_roles_and_permissions/index

0 commit comments

Comments
 (0)