chore: add initial plugin folder structure#30
Conversation
|
Thanks for the pull request, @BryanttV! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
63dd423 to
0500d29
Compare
|
Is this just the cookie-cutter generation or is there something specific you'd like reviewed? Could you provide a self-review with anything you'd like 👀 on ? |
| Purpose | ||
| ******* | ||
|
|
||
| For now, a placeholder repo covering upcoming implementation of RBAC (role-based access control) for the Open edX platform. |
There was a problem hiding this comment.
Can we update this with a more appropriate description?
There was a problem hiding this comment.
Thanks @mariajgrimaldi, purpose updated: 17d3802. What do you think?
54637ac to
176389a
Compare
Hi @sarina! I just generated the folder structure with the cookiecutter and then:
|
| This repository contains the architecture and design decisions for the new authorization system in Open edX. The project aims to provide a more flexible and powerful framework for managing user access, designed to modernize and replace the legacy permission system. | ||
|
|
||
| See the `Product Requirements document for Roles & Permissions`_. | ||
| See the `Product Requirements document for Roles & Permissions`_ for detailed specifications and requirements. |
There was a problem hiding this comment.
What about:
Open edX AuthZ provides the architecture and foundations of the authorization framework. It implements the core machinery needed to support consistent authorization across the Open edX ecosystem.
We can also draw inspiration from: https://github.com/openedx/openedx-authz/pull/28/files
There was a problem hiding this comment.
Thanks for the suggestion! What do you think about: ec2c951
sarina
left a comment
There was a problem hiding this comment.
Please remove changes to LICENSE.txt, we already have a LICENSE file (https://github.com/openedx/openedx-authz/blob/main/LICENSE)
| :target: https://github.com/openedx/openedx-authz/blob/main/LICENSE.txt | ||
| :alt: License | ||
|
|
||
| .. TODO: Choose one of the statuses below and remove the other status-badge lines. |
There was a problem hiding this comment.
Can you remove the other status badge lines per this comment?
Thanks! deleted: 7e7072e |
Description
This PR adds the initial plugin folder structure. The purpose is to include CI validations in PRs, but it could be used to test implementations.
Generated using edx-cookiecutters > django-app. Some additional changes were made:
README.mdwith theREADME.rst.txtfiles for the initial base requirements by runningmake upgradesetuptoolsrequirement in the quality checks to solve pylint check failures