feanil/unify docs #32780
feanil/unify docs #32780
Conversation
BREAKING CHANGE: The technical docs will not be published independent of the rest of the edx-platform docs.
Now that the content in `guides` is all of the edx-platform docs, move them all into the top-level docs directory to reduce confusion. BREAKING CHANGE: Guides are now just docs. This will require updating the publishing settings so that RTD looks for the conf in a different location.
Now that there is only one sphinx project, the RTD config can be more specific and stop relying on the old style config which is about to be deprecated.
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
|
This broke a link in OEP-50 - The documentation for the available hooks at any point should be kept in-code at openedx/edx-platform. This location should contain a document that covers the design principles and details that did not land in the OEP as well as the final decisions made in the OEP. Also will index the list of hooks and their current status. It should not cover the history and all the previous states of the framework. It should reflect the latest way of thinking and examples of how to use the framework. |
|
openedx/open-edx-proposals#644 should fix the broken link in a resilient way. |
Before this there were multiple documentation projects in edx-platform so it was hard to tell where to put information. After this change, the content of the
guidesproject supersedes all the other docs projects and contains all the information they used to contain. So we remove the last other project (edx-platform Technical) and re-organize the docs repo which now contains only a single sphinx project.