Monolith WG: 05/09/2017

Agenda

  • Update on Metrics
    • Feedback from arch group
    • Review resources page
    • Update on current Splunk reports
  • Update on Best Practices
    • L'OEPs
  • Flesh out a Best Practice together

Meeting Notes

  • Agreed to focus on the following metrics for now:
    • Hotspots
    • Github big-data (via Jay)
    • Release pipeline trend (via Renzo)
    • Complexity trend (Ben's tool)
  • Best Practices
    • Documentation
      • L'OEPs
        • Lightweight and local OEPs are documented within the repo to capture architectural design decisions
      • IDAs have been keeping all documentation within the docs directory in the repo
      • Guidelines
        • Open edX Developer Guide in the read-the-docs applies to ALL repos
        • Docs within the repo are repo-specific
      • Future ideas
        • Main developer guide can link to repo-specific ones maybe
      •  Swagger
        • Can we enable just for local devstack to get started?
        • For prod, we can integrate with API Gateway

Action Items