docs: add ADR for pathway and pathway item boundaries - #762
Conversation
|
Thanks for the pull request, @Agrendalath! 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. |
ormsbee
left a comment
There was a problem hiding this comment.
Minor comment just to get clarification, but no change required.
| 1. A Pathway holds an ordered list of Pathway Items. The order is author-defined and is the order in which Items are | ||
| presented to learners. In the future, we plan to also support enforcing the order of completion. |
There was a problem hiding this comment.
The fact that we know we're going to have to later accommodate much more sophisticated display rules for Pathways makes me think that the Pathway Item ordering is something that's going to be modeled at arm's length, i.e. a M:M simple learner display ordering model, rather than making ordering an intrinsic part of the PathwayItem. With the idea that eventually other more sophisticated M:M models will be added to encode fancier dependency/ordering/grouping rules. Does that sound right to you?
There was a problem hiding this comment.
@ormsbee, my idea for the ordered list in the MVP was to allow authors to specify the order of item display (e.g., either the suggested order of completion for learners or the content author's pure preference).
I agree that M:M relations will be reasonable for content groups and prerequisites. However, I'm wondering whether we should actually mix the display order with the prerequisites. If not, perhaps keeping the order directly as a PathwayItem field would be a better choice?
There was a problem hiding this comment.
I think we have the same concern—I was just thinking both orderings would be M:M relations. Thinking on it more, I'm fine with putting author-ordering on the PathwayItem directly for student display purposes as you describe.
|
I plan to merge this tomorrow afternoon (1 week after it was initially opened), unless anyone has objections. |
This adds an ADR defining the boundary between a Pathway and its Items.
Related PRs:
Private-ref: BB-10965