search

openedx / docs.openedx.org

[BETA] A new home for learning about Open edX
https://docs.openedx.org
Other
6 stars 56 forks source link

docs: Add how-to for Python development (virtualenvs, make test) #392

Closed timmc-edx closed 10 months ago

timmc-edx commented 10 months ago

We currently have "Getting Started" instructions in each repo's README, but they're terse and often out of date. By moving them to a central place, we can instead link to those docs and reduce our maintenance burden.

This would also involve updating OEP-55 to specify a link to this doc page rather than suggesting an inlined Getting Started section.

feanil commented 10 months ago

@timmc-edx let me know when you think this is ready to merge and if you'd like me to squash it or retain all the commits.

timmc-edx commented 10 months ago

I think I've addressed all feedback except Kyle's regarding the issue of conflicting instructions. Still pondering what to do there; suggestions very welcome.

timmc-edx commented 10 months ago

OK, I think it's ready to go.

feanil commented 10 months ago

@timmc-edx do you want to squash to something you're happy with or is it cool to just squash all the commits together upon merge?

timmc-edx commented 10 months ago

PR title & desc should be fine for the squashed commit message.

feanil commented 10 months ago

Thanks Tim! 🎉