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

Publish readmes from edx-platform #108

Open
nedbat opened this issue Mar 3, 2023 · 7 comments
Open

Publish readmes from edx-platform #108

nedbat opened this issue Mar 3, 2023 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation more contributions This contributes to our goal of increasing valued contributions

Comments

@nedbat
Copy link
Contributor

nedbat commented Mar 3, 2023

To document djangoapps in edx-platform, we want to write READMEs and have them published to readthedocs.

Acceptance criteria for this ticket:

    • Work with tCRIL to get an RTD instance stood up that can render arbitrary documentation within edx-platform
    • Identify a few useful docs to share out & clean up if needed (there are plenty of rst in there but idk if they render weird or are well-formed)

Next Steps / Nice to have:

  • Can we group deprecated django apps together somehow and hide them from the main index?
  • Can we link to maintainers for a django app?
  • Can we link to docs for related services? (e.g. there is a credentials django app in edx-platform that just services Credentials and we should have a pattern for documenting that where we link to the Credentials RTD.)
@nedbat nedbat added the documentation Improvements or additions to documentation label Mar 3, 2023
@hurtstotouchfire
Copy link

We recently updated docs here: https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/user_api/README.rst
So this is one that I'd like to make more visible.

@hurtstotouchfire
Copy link

@feanil I updated the description here and added some nice to have / question items at the end there.

@feanil
Copy link

feanil commented Jul 3, 2023

Cool, @nedbat can you add me as an assignee so I have this on my list. Some of the recent API related work has brought us closer to getting this over the line.

Related Issue: openedx/edx-platform#32610

@e0d
Copy link

e0d commented Jul 24, 2023

@feanil any updates on this for tomorrow?

@feanil
Copy link

feanil commented Jul 24, 2023

The consolidation for the sphinx projects in edx-platform should un-block this but I have not yet had time to work on this specifically. Though we are now publishing the docstrings.

@nedbat nedbat added the more contributions This contributes to our goal of increasing valued contributions label Aug 7, 2023
@nedbat
Copy link
Contributor Author

nedbat commented Sep 19, 2023

Feanil is handing this to the Aximprovements team.

@feanil
Copy link

feanil commented Sep 20, 2023

FYI the ticket tracking this work in edx-platform is openedx/edx-platform#33047

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation more contributions This contributes to our goal of increasing valued contributions
Projects
Status: Prioritized
Development

No branches or pull requests

4 participants