Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ADR 8. Project structure #105

Merged
merged 3 commits into from
Jan 18, 2024
Merged

ADR 8. Project structure #105

merged 3 commits into from
Jan 18, 2024

Conversation

pomegranited
Copy link
Contributor

Description

Supersedes ADR 6. Areas of Responsibility with a new ADR 8. Project structure.

Also updates the README to provide links to the Tutor plugin and rendered documentation.

Supporting information

Part of #61

@openedx-webhooks
Copy link

Thanks for the pull request, @pomegranited! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 17, 2024
This was referenced Jan 17, 2024
Merged
Closed
Base automatically changed from jill/oars-now-aspects to main January 17, 2024 14:22
bmtcril
bmtcril reviewed Jan 17, 2024
View reviewed changes
Copy link
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

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

This is great, just one comment

docs/decisions/0008_project_structure.rst Outdated
Aspects depends on a few Django plugins to move events from the LMS into its processing pipeline
(currently `openedx-event-sink-clickhouse`_ and `event-routing-backends`_). These plugins should
live in their own repositories, and be installed to the LMS/CMS as "extra requirements", using the
chosen deployment's best practices.
Copy link
Contributor

Choose a reason for hiding this comment

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

We actually install these via Tutor's OPENEDX_EXTRA_PIP_REQUIREMENTS since the versions are critical to Aspects.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @bmtcril , is 05786e7 better?

bmtcril
bmtcril approved these changes Jan 18, 2024
View reviewed changes
Copy link
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

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

👍

@bmtcril bmtcril merged commit 0358c83 into main Jan 18, 2024
3 checks passed
@bmtcril bmtcril deleted the jill/plugin-structure branch January 18, 2024 14:23
@openedx-webhooks
Copy link

@pomegranited 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bmtcril bmtcril bmtcril approved these changes

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pomegranited @openedx-webhooks @bmtcril