Topics

• Developer Docs - what would be most worthwhile to tackle first if I have a resource to help with this?

  • Outcomes:

    • Increase valuable contributions from the community and edX.

  • Case Study

    • ORA changes by OpenCraft → edX eng team

• Thoughts

  • Overall structure of the docs

  • Outdated docs

  • If docs were written when the code was written (e.g., xQueue)

    • How do we enforce they get updated as initial code and assumptions change?

    • Written later: XQueue/XQWatcher Architecture

  • Understand the Jargon

    • Link farm: Organizing links to understand the Jargon

    • Onboard to the unknown unknowns

• Quick survey: how do you write git commit messages? (Not what words: what tool?)

  • seems like most people use command line, git commit -m “foobar”

    • Ned worries this discourages multi-line commit messages

    • No consensus on whether or not multi-line commit messages should be the standard

• centralized bug triage/reporting process?

  • does everyone go through https://openedx.atlassian.net/servicedesk/customer/portal/9 ?

• import linter, anyone??

  • what happened to black??

    • several seemingly small but actually probably important problems with it, specifically in edx-platform :sadpanda:

      • more details:

        • harder diffs for Open edX (esp. removal of line breaks)

        • moving around # pylint disable

    • ACTION @Matt Tuchfarber (Deactivated) : open a discussion with the community on Discourse regarding Black, cc: @sburch (Deactivated)

    • Used in demographics, platform-plugin-coaching, and soon credentials (all owned by aperture)

  • https://github.com/edx/edx-platform/pull/25836

    • consensus:

      • Looks good.

      • Could slow feature teams down when structure violations happen.

        • Is the benefit worth the slow down?

        • Let’s try it and see.

      • Kyle will put final PR in #architecture within next few weeks

      • Will include ADR and docs on managing exceptions.

• Should inter-app APIs be an OEP instead of an ADR? Dave O’s combo of api.py and data.py in a specific LMS app solved my problems, but without David J’s comment, I would have never found it.

  • ACTION @Dave Ormsbee (Deactivated) : we now have a 2nd usage of data.py in Credentials. Arch Hour would appreciate you publishing an OEP for this.

• All of our content is associated with a Course-ID

  • Can we develop libraries that can be applied to all of your courses?

  • TNL & OpenCraft have been discussing this

  • Examples: Discussions tool used within course, at library, at programs, etc.

    • https://github.com/edx/edx-platform/blob/master/openedx/core/djangoapps/xblock/learning_context/learning_context.py

    • WIP ADR for Discussions a part of this PR: https://github.com/edx/edx-platform/pull/25837/files

  • Example: LTI Freedom

    • LTI integrations at different contexts xblock-lti-consumer/docs/decisions/0001-lti-extensions-plugin.rst at master · openedx/xblock-lti-consumer

  • Case study: Common Cartridge

Backlog of Questions/Discussions

• Recent MFE docs

  • [Archive] MFE Rewrite Statusarchived

  • MFE Definition of Done

  • Recommendation: When to MFE

• Requirements for public reposarchived - how will these requirements be reinforced?