Accept or Obsolete "Provisional" OEPs

Open
#608 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Review the provisional OEPs and ADRs identified by the sub-issues, then compare each with its current implementation and community use. Determine whether each should be Accepted, Replaced, or Obsolete, and update the relevant proposal documentation and status. Done means every identified provisional document has an appropriate, evidence-based status.

Written by the indexing model from the issue text.

Description

feb25 under discussion

Several OEPs were authored aspirationally, and then never implemented. Other were partially implemented, but have stalled or diverged from reality. Yet others should be followed by the community, but are erroneously marked as "Provisional".

In order to establish OEPs as a trustworthy source of documentation, we should mark OEPs that never came to be as "Replaced" or "Obsolete" (whichever or is more appropriate). We should revise and "Accept" OEPs that are still relevant but mismatched with reality. We should simply "Accept" OEPs that are for all practical purposes adopted by the community.

Sub-issues have been made for all the found Provisional OEPs & ADRs.

Dominant language
Python
Stars
49
Forks
47
Avg merge
3d 16h
Merged PRs (30d)
3

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openedx/openedx-proposals

All issues in openedx/openedx-proposals

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.