search

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

docs: OEP-67 - Document our best practice tools and tech. #518

Closed feanil closed 10 months ago

feanil commented 11 months ago

The topic for consideration in this PR

We should have an OEP to help us know which tools and technology we as a community should standardize on. This OEP will help us track these items and provide a structure place for us to have future conversations when we want to change community standards.

We currently have some of this for the frontend but having something a bit more standard across the entire ecosystem would be helpful for making decisions going forward.

Note for Reviewers: The tools/standards in the frontend section were simply moved from OEP-11, they are NOT up for re-consideration in this PR. If they are wrong or need updates, I recommend supporting this OEP and then making a new ADRs to update a recommendation that you feel is incorrect.

Tasks for After the OEP is Approved

brian-smith-tcril commented 11 months ago

This is great! It looks like everything (except for Codecov) from OEP-11 can go under the "Frontend Technology Selection" section as it's all pretty frontend specific.

feanil commented 10 months ago

@bradenmacdonald the review period is complete, I think there are a lot of follow-up updates but as far as I can tell, no disagreement on this OEP existing and the goals it's trying to solve for. Do you have any concerns that I should address because I make the rest of the re-organization changes and land this OEP?

bradenmacdonald commented 10 months ago

@feanil Nope! I don't have any concerns, and I think people seem quite happy with this change. (And eager to make the follow-up updates, as it seems like quite a few things have gotten outdated from the original.)

bradenmacdonald commented 10 months ago

@feanil Also, can we track all the follow-up ADRs known to be needed in one place? I see codecov is in the PR description, greenkeeper is #524, Redux is not tracked, etc.

feanil commented 10 months ago

@bradenmacdonald good call, I'll make a new top-level issue and collect all the known updates we need into that for now.

feanil commented 10 months ago

@bradenmacdonald I've created https://github.com/openedx/open-edx-proposals/issues/531 to track the current known updates that we need. Let me know if you think there's anything else that needs to be done before we land this.