openedx / open-edx-proposals

Proposals for Open edX architecture, best practices and processes
http://open-edx-proposals.readthedocs.io/
Other
44 stars 32 forks source link

Update Technology Recommendations and Related Decisions #531

Open feanil opened 11 months ago

feanil commented 11 months ago

OEP-67 recommendations that need to be reviewed and potentially updated.

Updates to existing recommendations

Historic Standards that need notes and ADRs

Related: Frontend changes

524

480

sarina commented 4 months ago

@feanil in order to facilitate me finding some people to help out with this, is there any more detail you could add around the "Historic Standards"? I'm not sure how anyone would write ADRs for some of the basic ones like Django. And does edx-lint not have some stuff existing about why it was created?

feanil commented 4 months ago

Many of the de-facto technologies don't have a lot of history about why they were picked. I think the why they were chosen over other things is less important than summarizing that we have chosen these things and that they are the current standard for this project. For example, we don't need the summary for Django to justify Django as much as we need it to acknowledge and codify that "By default any backend webserver that interacts with databases in the Open edX project, should use Django as the framework. Django has a lot of reasonable defaults and security capabilities built in and the community is already familiar with it, currently we are not looking to add other technologies as alternatives to Django for backend webservers."

sarina commented 4 months ago

OK, that makes sense. This feels like a ticket many people could pick up a part of, I'll edit the description to be checkboxes.

sarina commented 3 months ago

To anyone picking this up: I suspect we should hold off on expanding a Codecov recommendation until we figure out if Codecov remains the best tool for the job (recent changes in Codecov has made it a less reliable service)