You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -13,8 +13,101 @@ This repository centralizes the architecture, design decisions, and reference im
13
13
14
14
See the `Product Requirements document for Roles & Permissions`_ for detailed specifications and requirements.
15
15
16
+
Integration with edx-platform
17
+
******************************
18
+
19
+
This repository became an edx-platform's dependency starting with the Ulmo release. From that release onwards, system policies are automatically updated.
20
+
21
+
If you need to update the policies manually, it is recommended to use the ``./manage.py lms load_policies`` command.
22
+
23
+
.. note::
24
+
Currently, this package only supports the `content libraries' roles and permissions as documented here`_, and the migration of data from the old system to the new one is performed automatically.
25
+
26
+
If you need to migrate the information manually, you should run ``./manage.py lms migrate openedx_authz``.
27
+
28
+
29
+
Getting Started with Development
30
+
********************************
31
+
32
+
Please see the Open edX documentation for `guidance on Python development`_ in this repo.
33
+
34
+
.. _guidance on Python development: https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html
35
+
36
+
Getting Help
37
+
************
38
+
39
+
Documentation
40
+
=============
41
+
42
+
See `documentation on Read the Docs <https://openedx-authz.readthedocs.io/en/latest/>`_.
43
+
44
+
More Help
45
+
=========
46
+
47
+
If you're having trouble, we have discussion forums at
48
+
https://discuss.openedx.org where you can connect with others in the
49
+
community.
50
+
51
+
Our real-time conversations are on Slack. You can request a `Slack
52
+
invitation`_, then join our `community Slack workspace`_.
53
+
54
+
For anything non-trivial, the best path is to open an issue in this
55
+
repository with as many details about the issue you are facing as you
56
+
can provide.
57
+
58
+
https://github.com/openedx/openedx-authz/issues
59
+
For more information about these options, see the `Getting Help <https://openedx.org/getting-help>`__ page.
Please do not report security issues in public. Please email [email protected].
105
+
106
+
16
107
.. _Product Requirements document for Roles & Permissions: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4724490259/PRD+Roles+Permissions
17
108
109
+
.. _content libraries' roles and permissions as documented here: https://openedx-authz.readthedocs.io/en/latest/concepts/core_roles_and_permissions/content_library_roles.html
0 commit comments