-
Notifications
You must be signed in to change notification settings - Fork 35
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.
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 <[email protected]> | ||
* - Arbiter | ||
- Felipe Montoya <[email protected]> | ||
* - Status | ||
- Accepted | ||
- Needs Revision | ||
* - Revision Ticket | ||
- https://github.com/openedx/open-edx-proposals/issues/587 | ||
* - Type | ||
- Architecture | ||
* - Created | ||
|
@@ -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>`_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,11 +8,11 @@ OEP-1: OEP Purpose and Guidelines | |
+---------------+--------------------------------------------------------------+ | ||
| Last-Modified | 2022-06-22 | | ||
+---------------+--------------------------------------------------------------+ | ||
| Authors | Calen Pennington <[email protected]>, | | ||
| | Joel Barciauskas <[email protected]>, | | ||
| | Nimisha Asthagiri <[email protected]>, | | ||
| | Feanil Patel <[email protected]>, | | ||
| | Sarina Canelake <[email protected]> | | ||
| Authors | - Calen Pennington <[email protected]> | | ||
| | - Joel Barciauskas <[email protected]> | | ||
| | - Nimisha Asthagiri <[email protected]> | | ||
| | - Feanil Patel <[email protected]> | | ||
| | - Sarina Canelake <[email protected]> | | ||
+---------------+--------------------------------------------------------------+ | ||
| Arbiter | - Eddie Fagin <[email protected]>, | | ||
| | - Calen Pennington <[email protected]> | | ||
|
@@ -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" | ||
"Final" -> { "Replaced" "Obsolete" } [style=dashed] [style=dashed] | ||
"Final" -> { "Replaced" "Obsolete" "Needs Revision" } [style=dashed] [style=dashed] | ||
} | ||
|
||
Draft | ||
|
@@ -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 | ||
-------------- | ||
|
@@ -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 | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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:
How does that look? I don't love it but otoh I love how it's autogenerated!
There was a problem hiding this comment.
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.