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

"Extending the edX Platform" doc is very out of date #2114

Closed
rgraber opened this issue Mar 2, 2023 · 6 comments
Closed

"Extending the edX Platform" doc is very out of date #2114

rgraber opened this issue Mar 2, 2023 · 6 comments
Labels
backlog An issue we plan to address a little later

Comments

@rgraber
Copy link

rgraber commented Mar 2, 2023

https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/extending_platform/index.html hasn't been updated since 2014 and contains lots of out-of-date information. It is also missing any information about plugins, MFEs, etc. that have been developed since.

@rgraber rgraber added this to Arch-BOM Mar 2, 2023
@jmbowman jmbowman added the backlog An issue we plan to address a little later label Mar 2, 2023
@rgraber rgraber changed the title Extending the edX Platform is very out of date "Extending the edX Platform" doc is very out of date Mar 2, 2023
@rgraber rgraber moved this to Todo in Arch-BOM Mar 2, 2023
@feanil
Copy link
Contributor

feanil commented Mar 2, 2023

@rgraber thanks for taking this on, any chance I could get you to make the new page in the new docs site instead and just replace the old page with a forwarding link? It sounds like what you're going to write would probably go under here: https://docs.openedx.org/en/latest/developers/concepts/index.html

@feanil
Copy link
Contributor

feanil commented Mar 2, 2023

Or maybe a series of how-tos?

@github-project-automation github-project-automation bot moved this to Backlog - Other in docs.openedx.org Mar 2, 2023
@feanil feanil moved this from Backlog - Other to Backlog - To Write in docs.openedx.org Mar 2, 2023
@rgraber
Copy link
Author

rgraber commented Mar 2, 2023

I actually didn't realize we already had a better version of this information. Is the plan to deprecate edx-documentation overall eventually?
ps @robrap , who first pointed me at this

@rgraber
Copy link
Author

rgraber commented Mar 2, 2023

Asking because if we're deprecating the repo entirely this ticket is redundant and I can make a new one to update https://docs.openedx.org/en/latest/developers/concepts/index.html, although that one is pretty up to date. The ticket would be more just to include the things discussed here: openedx/edx-platform#31659

@feanil
Copy link
Contributor

feanil commented Mar 2, 2023

The plan is to eventually deprecate and remove the entire developer guide and move it to the new space. I think as an interim step, it would be good to cross link the new content from this old page but having it in the new repo will reduce future work to move it there. Let me know if that's not clear.

@rgraber
Copy link
Author

rgraber commented Mar 2, 2023

That makes sense to me. I'll close this ticket, make a new one in docs.openedx.org, and add a task in that ticket to change this old page to point to the new one.

@rgraber rgraber closed this as completed Mar 2, 2023
@github-project-automation github-project-automation bot moved this from Backlog - To Write to Done in docs.openedx.org Mar 2, 2023
@github-project-automation github-project-automation bot moved this from Todo to Done in Arch-BOM Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog An issue we plan to address a little later
Projects
Archived in project
Development

No branches or pull requests

3 participants