Skip to content

docs: add purpose of this repo to argue the use of this repo for authz#28

Merged
sarina merged 4 commits intoopenedx:mainfrom
eduNEXT:MJG/purpose-of-repo
Sep 8, 2025
Merged

docs: add purpose of this repo to argue the use of this repo for authz#28
sarina merged 4 commits intoopenedx:mainfrom
eduNEXT:MJG/purpose-of-repo

Conversation

@mariajgrimaldi
Copy link
Copy Markdown
Member

Description

Add reasoning behind the decision to implement this project in a separate Django application instead of including it in the edx-platform directly. This is an early implementation decision, so it remains open to discussion until openly approved.

@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @openedx/committers-openedx-authz.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Aug 27, 2025
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Aug 27, 2025
@mariajgrimaldi
Copy link
Copy Markdown
Member Author

mariajgrimaldi commented Aug 27, 2025

⚠️ We still need to setup this as a plugin / library so we have proper CI for the documentation.

Comment thread docs/decisions/0001-purpose-of-this-repo.rst Outdated

- Architectural Decision Records (ADRs) that document the evolution of the authorization model.
- Design documents for scopes, policies, and integration approaches.
- Reference implementations, libraries, and supporting code.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this mean that this repository will be limited to example and experimental code? Or should we specify that the objective is that this repo will eventually be the source of truth for Authz implementation for the platform, as a library to be imported by other apps?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, as you mentioned the idea for this library would be to implement the final authorization framework for the ecosystem. I added more clarification to avoid confusion:
6bcbbb2
563fa9d

Copy link
Copy Markdown
Contributor

@rodmgwgu rodmgwgu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clarifications, looks good!

@sarina
Copy link
Copy Markdown
Contributor

sarina commented Sep 2, 2025

@bmtcril is on holiday but I'll let him give the final 👍🏻 and merge.

Copy link
Copy Markdown
Contributor

@MaferMazu MaferMazu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me ✨

@bmtcril
Copy link
Copy Markdown
Contributor

bmtcril commented Sep 3, 2025

Looks good to me once the conflicts are resolved

@sarina sarina moved this from Needs Triage to Ready to Merge in Contributions Sep 4, 2025
@sarina
Copy link
Copy Markdown
Contributor

sarina commented Sep 4, 2025

@mariajgrimaldi can you resolve conflicts so we can merge?

@sarina sarina merged commit b6f8b81 into openedx:main Sep 8, 2025
13 checks passed
@github-project-automation github-project-automation Bot moved this from Ready to Merge to Done in Contributions Sep 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

6 participants