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.

Sign up for GitHub

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

Add a Needs Revision status for OEPs #586

Merged
merged 3 commits into from
May 28, 2024
+36 −8
Merged

Add a Needs Revision status for OEPs #586

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d04244
docs: Add a Needs Revision status for OEPs
sarina May 17, 2024
66bc213
docs: Update OEP-45 status as Needs Revision
sarina May 17, 2024
86e4fa4
style: Bulletpoint the authors list on OEP-1
sarina May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions oeps/architectural-decisions/oep-0045-arch-ops-and-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@ OEP-45: Configuring and Operating Open edX
* - Title
- Configuring and Operating Open edX
* - Last Modified
- 2020-04-06
- 2024-05-17
* - Authors
- Bill DeRusha <bill@edx.org>
* - Arbiter
- Felipe Montoya <felipe.montoya@edunext.co>
* - Status
- Accepted
- Needs Revision
* - Revision Ticket
- https://github.com/openedx/open-edx-proposals/issues/587
* - Type
- Architecture
* - Created
Expand Down Expand Up @@ -210,3 +212,10 @@ The following related decisions modify or enhance this OEP, but have not yet bee

oep-0045/decisions/*

Change History
**************

2024-05-16
==========
* Change status to "Needs Revision"
* `Pull request #586 <https://github.com/openedx/open-edx-proposals/pull/586>`_
31 changes: 25 additions & 6 deletions oeps/processes/oep-0001.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ OEP-1: OEP Purpose and Guidelines
+---------------+--------------------------------------------------------------+
| Last-Modified | 2022-06-22 |
+---------------+--------------------------------------------------------------+
| Authors | Calen Pennington <cale@edx.org>, |
| | Joel Barciauskas <joel@edx.org>, |
| | Nimisha Asthagiri <nimisha@edx.org>, |
| | Feanil Patel <feanil@axim.org>, |
| | Sarina Canelake <sarina@axim.org> |
| Authors | - Calen Pennington <cale@edx.org> |
| | - Joel Barciauskas <joel@edx.org> |
| | - Nimisha Asthagiri <nimisha@edx.org> |
| | - Feanil Patel <feanil@axim.org> |
| | - Sarina Canelake <sarina@axim.org> |
+---------------+--------------------------------------------------------------+
| Arbiter | - Eddie Fagin <efagin@edx.org>, |
| | - Calen Pennington <cale@edx.org> |
Expand Down Expand Up @@ -242,10 +242,11 @@ OEP Status
[fontname=Arial]

"Draft" -> { "Under Review" "Deferred" }
"Needs Revision" -> "Under Review"
"Under Review" -> { "Deferred" "Provisional" } [dir=both]
"Under Review" -> { "Accepted" "Rejected" "Withdrawn" }
"Accepted" -> "Final"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once an OEP is in "Needs Revision", where can it go from there? I haven't tried rendering it, but maybe this is enough?

Suggested change
"Accepted" -> "Final"
"Accepted" -> "Final"
"Needs Review" -> "Final"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, and, it's tough because (a) Needs Review should just wrap around to Under Review (and all its possible states), and (b) GitHub isn't rendering the graph in preview and I'm having some issue with my local env at the moment.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ha! I forgot we have a build :) I added like this:

image

How does that look? I don't love it but otoh I love how it's autogenerated!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yes, autogenerated FTW!

That looks good enough.

"Final" -> { "Replaced" "Obsolete" } [style=dashed] [style=dashed]
"Final" -> { "Replaced" "Obsolete" "Needs Revision" } [style=dashed] [style=dashed]
}

Draft
Expand Down Expand Up @@ -308,6 +309,19 @@ guidelines. In this case the OEP's status should be changed to "Obsolete" and
the OEP should be updated with an explanation as to why the OEP is no
longer relevant.

Needs Revision
--------------

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.

Status changes
--------------
Expand Down Expand Up @@ -552,6 +566,11 @@ at the top of the list.
Change History
**************

2024-05-16
==========
* Add a "Needs Revision" status
* `Pull request #586 <https://github.com/openedx/open-edx-proposals/pull/586>`_

2022-10-05
==========
* Require OEPs merged as "Draft" or "Provisional" to provide a reference for
Expand Down
Loading