Over time, some OEPs may stay relevant - for example, they may have many
sections or core ideas that are still relevant to the project - while containing
many details that have become stale over time. When we are in agreement that the
OEP needs updating, we use this status to indicate to those browsing the OEPs
that this particular one requires some renewed attention.
When changing status to "Needs Revision", a row titled "Revision Ticket" should
be added to the preamble (directly under the status field) that directs to the
GitHub issue or draft pull request in the open-edx-proposals repository that
describes what about the OEP that needs revisioning.
An example is added with OEP-45. OEP-45 is directionally correct and we shouldn't mark it as obsolete - it contains many great ideas. However it very much needs revision. We've captured the revision needs in https://github.com/openedx/open-edx-proposals/issues/587 and linked that issue to the OEP.
It is not always feasible that we find something wrong in an OEP and have the time right then and there to update the OEP. This status is a nod to that reality and a signpole to community members that they should tread carefully.
Over time, some OEPs may stay relevant - for example, they may have many sections or core ideas that are still relevant to the project - while containing many details that have become stale over time. When we are in agreement that the OEP needs updating, we use this status to indicate to those browsing the OEPs that this particular one requires some renewed attention.
When changing status to "Needs Revision", a row titled "Revision Ticket" should be added to the preamble (directly under the status field) that directs to the GitHub issue or draft pull request in the
open-edx-proposalsrepository that describes what about the OEP that needs revisioning.An example is added with OEP-45. OEP-45 is directionally correct and we shouldn't mark it as obsolete - it contains many great ideas. However it very much needs revision. We've captured the revision needs in https://github.com/openedx/open-edx-proposals/issues/587 and linked that issue to the OEP.
It is not always feasible that we find something wrong in an OEP and have the time right then and there to update the OEP. This status is a nod to that reality and a signpole to community members that they should tread carefully.