[DEPR]: Renaming edx-platform to openedx-platform

[kdmccormick]

RFC Start Date

N/A -- Already Accepted

Target Plan Accepted Date

N/A -- Already Accepted

Target Transition Unblocked Date

No transition steps needed

Earliest Breaking Changes Unblocked Date

2025-01-26

Rationale

This was discussed #37604

Description

On Monday, January 26th, we will rename edx-platform to openedx-platform.

We do not anticipate any breaking changes, but we're making a DEPR ticket just to broaden the reach of this announcement. We have renamed repositories before, and observed that web URLs, git references are redirected seamlessly and perpetually. For reference, here are GitHub's docs on removing repositories: https://docs.github.com/en/repositories/creating-and-managing-repositories/renaming-a-repository

Task List

No response

[kdmccormick]

https://discuss.openedx.org/t/renaming-edx-platform-to-openedx-platform-on-jan-26/18225

[robrap]

@kdmccormick:

• Maybe some of the info in the closed-as-duplicate issue should be summarized/copied into the rationale section for this DEPR?
• I would imagine you'd have some task list in addition to renaming the repo, if you really want to reduce confusion and not add confusion.
  • Maybe you have that list somewhere else?
  • There are so many references to edx-platform: https://github.com/search?q=org%3Aopenedx+edx-platform&type=code. Have you thought through what will be updated, what will not be updated, and how we'll try to avoid confusion in the interim?
  • At a minimum, I'd imagine you'd want an ADR or some doc detailing this change and the history of the name, etc. I could also imagine a note in the openedx-platform README that includes the old name to try to head off confusion?

In any case, as noted, maybe you already have more tasks around this documented elsewhere. It just feels like a single rename with no supporting effort may not accomplish the goal.

[kdmccormick]

The renaming has happened ✅

I've opened a PR to update the README, codeowners, and catalog-info: #37938

I think we'll naturally update references over time. I will make a point to do some sweeps, but I'd rather not rush a blanket find-and-replace, as there are probably usages of the token "edx-platform" within docs URLs, wiki URLs, etc., which would break if changed to "openedx-platform". We'll want to proceed thoughtfully there.

I don't actually expect remaining references to "edx-platform" to cause too much confusion. I think that open-source developers will be quick to deduce that a repo named "openblah/blah-platform" was probably the former name for "openblah/openblah-platform". If this turns out to be wrong then I'm happy to make the find-and-replace sweeps a higher priority.

[kdmccormick]

Please subscribe to the forum thread for further updates and post there to report issues: https://discuss.openedx.org/t/renaming-edx-platform-to-openedx-platform-on-jan-26/18225