Closed mradamcox closed 1 year ago
@mradamcox This is all fine with me. Thank you for laying out your proposal and thinking behind it. From both a technical and long-term sustainability perspective, it makes sense.
@spaykin Sounds good. I'll start working on it soon and leave this ticket open until it's all squared away.
I've created a new repository from the branch as described (much easier than I was thinking it would be): https://github.com/healthyregions/oeps-explorer. However, before going further with the rest of this ticket, I think we need to address the build issue, which is tracked in https://github.com/healthyregions/oeps-backend/issues/21. That way we can get a staging deployment of the new location setup and do a cleaner switch when the urls change.
After a few different attempts at redirect configuration, the new deployment is fully up and running at https://oeps.healthyregions.org and deployed from the new repo. Final tasks here are to update the readme, etc. and remove the explorer branch.
All tasks now completed. There was just one commit in the explorer-debug
branch, marking it here for future reference: https://github.com/GeoDaCenter/opioid-policy-scan/commit/ea8eb285e0164587f1e0717ffde8f514d495beab
I've been reading through this repo and its accompanying wiki and other documentation in order to understand it better (which is thorough and really helpful), and I'd like to propose that the
explorer
branch, which holds the static website and is deployed through Netlify, is split into a separate repository. Here are a few reasons I think this would be a good move:explorer
branch is completely independent of themain
branch, and CSV files are manually copied frommain
toexplorer
for publication, or fetch calls inexplorer
access content inmain
through direct calls tohttps://github.raw....
, so there is no functional logic to link the two (I may be missing something though).main
branch are published to Zenodo (one per release) and associated with a DOI.explorer
branch isn't really possible, at least without adding a good bit of confusion to the release lineage.main
branch, like moving theexplorer
codebase into it as a subdirectory, seem inappropriate.We should be able to clone the branch independently into a new repo while retaining all relevant commit history--the process would be something like this not just a copy-paste into a new blank repo. This means that all past contribution history would remain intact (this is a requirement as far as I'm concerned).
I'm thinking the new repo would be something like
healthyregions/oeps-explorer
.Anyway, I'm writing this ticket out mostly to get the idea in front of @spaykin and @nofurtherinformation, as you have been the main contributors to this repo, and I don't think a change like this can happen without your input. Like I mentioned, work will definitely need to happen on the explorer at some point this summer, so this is essentially a preparatory step for that.
to complete:
explorer-debug
branch (merge intoexplorer
, or just document and delete?)explorer
branch from this repo