Skip to content

Commit 670548c

Browse files
committed
chore: add initial plugin folder structure
1 parent 4416b60 commit 670548c

20 files changed

Lines changed: 832 additions & 245 deletions

CHANGELOG.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Unreleased
1616

1717
*
1818

19-
0.1.0 2025-08-27
20-
**********************************************
19+
0.1.0 - 2025-08-27
20+
******************
2121

2222
Added
2323
=====

README.rst

Lines changed: 3 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,16 @@
11
openedx-authz
22
#############
33

4-
.. note::
5-
6-
This README was auto-generated. Maintainer: please review its contents and
7-
update all relevant sections. Instructions to you are marked with
8-
"PLACEHOLDER" or "TODO". Update or remove those sections, and remove this
9-
note when you are done.
10-
11-
|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
124
|license-badge| |status-badge|
135

146
Purpose
157
*******
168

17-
One-line description for README and other doc files.
18-
19-
TODO: The ``README.rst`` file should start with a brief description of the repository and its purpose.
20-
It should be described in the context of other repositories under the ``openedx``
21-
organization. It should make clear where this fits into the overall Open edX
22-
codebase and should be oriented towards people who are new to the Open edX
23-
project.
24-
25-
Getting Started with Development
26-
********************************
27-
28-
Please see the Open edX documentation for `guidance on Python development`_ in this repo.
29-
30-
.. _guidance on Python development: https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html
31-
32-
Deploying
33-
*********
34-
35-
TODO: How can a new user go about deploying this component? Is it just a few
36-
commands? Is there a larger how-to that should be linked here?
37-
38-
PLACEHOLDER: For details on how to deploy this component, see the `deployment how-to`_.
39-
40-
.. _deployment how-to: https://docs.openedx.org/projects/openedx-authz/how-tos/how-to-deploy-this-component.html
41-
42-
Getting Help
43-
************
44-
45-
Documentation
46-
=============
47-
48-
PLACEHOLDER: Start by going through `the documentation`_. If you need more help see below.
49-
50-
.. _the documentation: https://docs.openedx.org/projects/openedx-authz
51-
52-
(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)
53-
54-
More Help
55-
=========
56-
57-
If you're having trouble, we have discussion forums at
58-
https://discuss.openedx.org where you can connect with others in the
59-
community.
60-
61-
Our real-time conversations are on Slack. You can request a `Slack
62-
invitation`_, then join our `community Slack workspace`_.
63-
64-
For anything non-trivial, the best path is to open an issue in this
65-
repository with as many details about the issue you are facing as you
66-
can provide.
67-
68-
https://github.com/openedx/openedx-authz/issues
69-
70-
For more information about these options, see the `Getting Help <https://openedx.org/getting-help>`__ page.
71-
72-
.. _Slack invitation: https://openedx.org/slack
73-
.. _community Slack workspace: https://openedx.slack.com/
74-
75-
License
76-
*******
77-
78-
The code in this repository is licensed under the AGPL 3.0 unless
79-
otherwise noted.
80-
81-
Please see `LICENSE.txt <LICENSE.txt>`_ for details.
82-
83-
Contributing
84-
************
85-
86-
Contributions are very welcome.
87-
Please read `How To Contribute <https://openedx.org/r/how-to-contribute>`_ for details.
88-
89-
This project is currently accepting all types of contributions, bug fixes,
90-
security fixes, maintenance work, or new features. However, please make sure
91-
to discuss your new feature idea with the maintainers before beginning development
92-
to maximize the chances of your change being accepted.
93-
You can start a conversation by creating a new issue on this repo summarizing
94-
your idea.
95-
96-
The Open edX Code of Conduct
97-
****************************
98-
99-
All community members are expected to follow the `Open edX Code of Conduct`_.
100-
101-
.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/
102-
103-
People
104-
******
105-
106-
The assigned maintainers for this component and other project details may be
107-
found in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``
108-
file in this repo.
109-
110-
.. _Backstage: https://backstage.openedx.org/catalog/default/component/openedx-authz
9+
For now, a placeholder repo covering upcoming implementation of RBAC (role-based access control) for the Open edX platform.
11110

112-
Reporting Security Issues
113-
*************************
11+
See the `Product Requirements document for Roles & Permissions`_.
11412

115-
Please do not report security issues in public. Please email security@openedx.org.
13+
.. _Product Requirements document for Roles & Permissions: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4724490259/PRD+Roles+Permissions
11614

11715
.. |pypi-badge| image:: https://img.shields.io/pypi/v/openedx-authz.svg
11816
:target: https://pypi.python.org/pypi/openedx-authz/

codecov.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ coverage:
66
target: auto
77
patch:
88
default:
9-
enabled: yes
9+
enabled: no
1010
target: 100%
1111

1212
comment: false

0 commit comments

Comments
 (0)