Skip to content

Commit 4ac9408

Browse files
committed
docs: update the readme
1 parent edd7b40 commit 4ac9408

1 file changed

Lines changed: 95 additions & 2 deletions

File tree

README.rst

Lines changed: 95 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
openedx-authz
2-
#############
1+
Open edX AuthZ
2+
###############
33

44
|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
55
|license-badge| |status-badge|
@@ -13,8 +13,101 @@ This repository centralizes the architecture, design decisions, and reference im
1313

1414
See the `Product Requirements document for Roles & Permissions`_ for detailed specifications and requirements.
1515

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.
60+
61+
.. _Slack invitation: https://openedx.org/slack
62+
.. _community Slack workspace: https://openedx.slack.com/
63+
64+
License
65+
*******
66+
67+
The code in this repository is licensed under the AGPL 3.0 unless
68+
otherwise noted.
69+
70+
Please see `LICENSE <LICENSE>`_ for details.
71+
72+
Contributing
73+
************
74+
75+
Contributions are very welcome.
76+
Please read `How To Contribute <https://openedx.org/r/how-to-contribute>`_ for details.
77+
78+
This project is currently accepting all types of contributions, bug fixes,
79+
security fixes, maintenance work, or new features. However, please make sure
80+
to discuss your new feature idea with the maintainers before beginning development
81+
to maximize the chances of your change being accepted.
82+
You can start a conversation by creating a new issue on this repo summarizing
83+
your idea.
84+
85+
The Open edX Code of Conduct
86+
****************************
87+
88+
All community members are expected to follow the `Open edX Code of Conduct`_.
89+
90+
.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/
91+
92+
People
93+
******
94+
95+
The assigned maintainers for this component and other project details may be
96+
found in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``
97+
file in this repo.
98+
99+
.. _Backstage: https://backstage.openedx.org/catalog/default/component/openedx-authz
100+
101+
Reporting Security Issues
102+
*************************
103+
104+
Please do not report security issues in public. Please email [email protected].
105+
106+
16107
.. _Product Requirements document for Roles & Permissions: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4724490259/PRD+Roles+Permissions
17108

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
110+
18111
.. |pypi-badge| image:: https://img.shields.io/pypi/v/openedx-authz.svg
19112
:target: https://pypi.python.org/pypi/openedx-authz/
20113
:alt: PyPI

0 commit comments

Comments
 (0)