Repository navigation
docs: add ADR 0030 Tutor Implementation for authz schema discovery - #519
Conversation
|
Thanks for the pull request, @carlos-marquez-wgu! 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. |
9011dc1 to
0b554ba
Compare
48964de to
3cc4788
Compare
rodmgwgu
left a comment
There was a problem hiding this comment.
I agree with this approach, thanks!
BryanttV
left a comment
There was a problem hiding this comment.
Thanks, @carlos-marquez-wgu! I just have a couple of comments.
we should update the ADR number, since 0028 is already taken.
3cc4788 to
9a3218b
Compare
9a3218b to
db3711b
Compare
rodmgwgu
left a comment
There was a problem hiding this comment.
ADR 0029 has already been taken, can you please update this to be ADR 0030?
f42f323 to
5826bd7
Compare
Done, thanks! 😄 |
| 3. Ship the Tutor integration as a plugin | ||
| ========================================== | ||
|
|
||
| We will implement the Tutor integration as a new plugin in `openedx-tutor-plugins`_. The plugin will: |
There was a problem hiding this comment.
Why would this be in a different repo and not here as a monorepo with the other tooling? Was the alternative we discussed in this thread considered? https://openedx.slack.com/archives/C07PRCN6G0N/p1791302390271369
There was a problem hiding this comment.
Oh, I totally misread that part of the conversation and thought the suggested approach was using openedx-tutor-plugins repo, sorry and thanks for pointing it out!
Yeah having the tutor plugin here as a monorepo makes more sense, I updated the ADR to use a tutor subfolder here in the same repo
Thanks @mariajgrimaldi!
5826bd7 to
395c02c
Compare
Description
Adds ADR-0029 which defines how the Tutor implementation for authorization schema discovery works.
Authorization schema discovery already proposed a Tutor patch route in ADR 0019 and ADR 0023. This ADR fills the gap of how we feed the resulting authz schema YAML file to be discoverable.
The proposal includes adding a new Django setting for discovery to find the file, which needs to be an absolute filesystem path, and then using a Tutor plugin to place the rendered patch (
openedx-authz-schema) where it can be found by this setting.I also include two rejected alternatives: riding an existing installed package that Tutor already mounts files to, and scanning
/openedx/config/which already contains unrelated YAML configurations shipped by Tutor.Key decisions
OPENEDX_AUTHZ_SCHEMA_FILESdiscovery.py(filesystem paths) andloading.py(multi-document parsing)Merge checklist:
Check off if complete or not applicable:
AI Usage
Kiro + Claude were used to assist with the creation of documentation while throughly and carefully guided, everything was reviewed and corrected manually by an actual person and ensured the changes were up to standard and met the closing issue requirements.