Re: Proposal for review: simplifying and updating the OEP process

12 views
Skip to first unread message

Nimisha Asthagiri

unread,
May 3, 2018, 11:52:52 AM5/3/18
to edx-...@googlegroups.com, Calen Pennington, John Walker
Hi all.

Here's another attempt at further simplifying the OEP process, including the submission process and the OEP template:


Please review and provide any feedback.

Review Period: May 02, 2018 -> May 11, 2018

Motivation

Going forward, we want to encourage teams to write down and propose their architectural and system-wide decisions so we can align with best practices, processes, and system architectures.

Our hypothesis is that the rigid structure required by the PEP-based OEP template deters and confuses authors. Also, we find that some authors continue to prefer other documentation and discussion tools. So this PR introduces 2 other OEP templates to accommodate those needs:
  • ADR-based template (much simpler format than PEP)
  • External-link catered template (requiring distilled decisions to still be captured in the OEP, but discussions and other details can be captured elsewhere)
Thanks,
Nimisha

On Tue, Feb 6, 2018 at 3:45 PM, Nimisha Asthagiri <nasth...@edx.org> wrote:
Hello edx-code,

Proposal for Review

We would like to simplify the process for creating/maintaining Open edX Proposals. Going forward, we want to lower the barrier for proposing architectural and system-wide decisions so we can align with edX best practices, processes, and architectures.

Additionally, we are updating the process given recent changes in the org (i.e., the formation of an Architecture team in lieu of a chief architect).

Please refer to the PR for updating and simplifying OEP-1.

Note

In particular, please notice that a proposed change is that future OEPs would be announced on slack and may not always be announced on edx-code. So folks who are interested in architecture proposals can be informed through a more focused channel.

Review Feedback

You may share your comments/feedback by:
  • posting on the PR.
  • starting a thread on #architecture on slack, which we would eventually record in the OEP PR.
  • contacting me or Cale (the Arbiter of this edit), with the intent of capturing a summary of the conversation on the PR.
Timeline

As specified in the PR, the target review end date is Feb 15th.  If needed, we will extend the deadline.

Thanks,
Nimisha (and Cale as "Arbiter")


Reply all
Reply to author
Forward
0 new messages