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.

Sign up for GitHub

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

Jump to bottom

Setup a root edx-platform documentation site #31874

Open
feanil opened this issue Mar 3, 2023 · 2 comments
Open

Setup a root edx-platform documentation site #31874

feanil opened this issue Mar 3, 2023 · 2 comments
Assignees
@feanil

Comments

@feanil
Copy link
Contributor

feanil commented Mar 3, 2023

Currently there are multiple ReadTheDocs projects that are built out of edx-platform. Most of them are single purpose and there is no unifying edx-platform docs site. This makes it very difficult to display the documentation that lives alongside the code and makes it harder to discover and understand what is in the edx-platform code base.

Setup a root edx-platform documentation site that is integrated with docs.openedx.org and can be used to start indexing the current documentation that lives in the edx-platform repo.

AC:

  • New docs site for edx-platform
  • Is a sub-project of docs.openedx.org
  • Has a clear place to start referencing docs in specific djangoapps.
@jristau1984
Copy link
Contributor

+1, @feanil, this is a great improvement idea !

@feanil
Copy link
Contributor Author

feanil commented Mar 7, 2023

Related 2U OSPWG: edx/open-source-process-wg#108

@feanil feanil self-assigned this Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@feanil feanil

Labels
None yet
Projects
docs.openedx.org
Status: In Progress - tCRIL
Milestone
No milestone
Development

No branches or pull requests
2 participants
@feanil @jristau1984