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.

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

Architecture diagram updates #449

Open
jmbowman opened this issue Dec 18, 2023 · 0 comments
Open

Architecture diagram updates #449

jmbowman opened this issue Dec 18, 2023 · 0 comments

Comments

@jmbowman
Copy link

An update was made to the Open edX architecture diagram at https://github.com/openedx/docs.openedx.org/blob/main/source/developers/references/developer_guide/images/open-edx-architecture.png when it was moved from the edx-documentation repository (to add Aspects, among other tweaks), but there are a few points that should still be cleaned up to prevent confusion:

  • The "Programs" IDA has been unsupported for years: https://github.com/edx-unsupported/programs
  • The previous version of the diagram is still present at https://github.com/openedx/edx-documentation/blob/master/en_us/shared/images/edx-architecture.png despite nothing seeming to reference it now
  • There's no mention of the registrar or edx-notes-api services.
  • There's no mention of the enterprise-focused IDAs in the openedx organization: enterprise-access, enterprise-catalog, and license-manager (although that may be deliberate).
  • Does "Configuration" still merit a mention, now that Tutor is the only supported Open edX deployment option?
  • If "API Manager" is the 2U-specific https://github.com/edx/api-manager , does it still merit a mention?
  • edx-ui-toolkit and ux-pattern-library are both being actively phased out; should Paragon be mentioned instead of "UX Toolkit & Pattern Library"? It kind of falls under "MFEs", but it is a noteworthy tool in its own right.
  • Typo: "Persistance" -> "Persistence" in the bottom section label
  • "Memcache" -> "Memcached"
  • Maybe rename "Redis and Celery workers" to "Celery Broker (Redis)"? That would avoid conflating persistence with async execution, and make the next point less confusing.
  • Add a persistence system entry for "Event Bus (Kafka or Redis)".

There are probably more things worth calling out in the edx-platform block, but I'll avoid opening that can of worms for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant