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.

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

docs: introduce DEPR pilot into OEP #660

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

robrap
Copy link
Contributor

@robrap robrap commented Jan 9, 2025

This PR is to introduce the results of a successful pilot of some DEPR change into the DEPR OEP:

This was mostly around updated recommendations around DEPR timelines. The pilot was not perfect, and this update does not mean we can't iterate and improve.

Additionally, the pilot did not come up with a great way to determine when-and-if to DEPR, so separate follow-up will be needed for that.

robrap and others added 2 commits January 9, 2025 10:01
Add some more thoughts and we'll come back with more edits in the next meeting.
@feanil
Copy link
Contributor

feanil commented Jan 9, 2025

@robrap we made some more changes but there is still more to do, we'll continue to work on it at the next DEPR meeting but we will all try to review/add to what is here in the meantime.

@robrap
Copy link
Contributor Author

robrap commented Jan 9, 2025

[Feel free to add to this TODO list if you aren't ready to make the updates.]

oeps/processes/oep-0021-proc-deprecation.rst Outdated Show resolved Hide resolved
oeps/processes/oep-0021-proc-deprecation.rst Outdated Show resolved Hide resolved

This approach would be most appropriate for features that can be left
in place for an extended period before removal and where a transition
to an alternative would require a moderate to large amount of
effort. For more trivial deprecations, it may be appropriate to simply
deprecate and remove within the same release cycle.

TODO: UPDATE THIS AND ALL OTHER PLACES TO MENTION target month + named release. Check the DEPR issue template as well. And scan throught the rest of this DEPR.
Copy link
Contributor

Choose a reason for hiding this comment

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

Also include a link to the release schedule in the DEPR template.

@@ -209,28 +209,40 @@ considers the timing of the next `Open edX named release`_.
periods will vary by the type and scope of the technical change.

Copy link
Contributor

Choose a reason for hiding this comment

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

TODO: Update/replace the image in this DEPR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants