search

Wesleyan-Media-Project / creative_overview

An overview of all repos belonging to the CREATIVE project
Other
1 stars 0 forks source link

Create readme of CREATIVE infrastructure current state #1

Closed SebastianZimmeck closed 1 year ago

SebastianZimmeck commented 1 year ago

@atlasharry and @candace-walker will create a readme with an overview of the current state of the infrastructure. We want to get a handle of where we stand.

@candace-walker and @atlasharry, please clone this repo to your local machines. Go through every repo in the Wesleyan Media org, write what the purpose of the code in repo is, and how it relates to the other repos, if any. Start with the readmes of the individual repos and, to the extent necessary, look at the code. We only want a high level overview. So, no need to get into details. At this point the "what we have" is more important than the "how does it work."

@markusneumann mentioned that some repos are not related to CREATIVE. So, we do not need to include those in the overview.

You can push your changes directly to the main branch. Please distribute among yourselves who covers which repo.

Aim to have this done by our meeting next Monday.

We can discuss here or on Slack ...

SebastianZimmeck commented 1 year ago

Also, what would be good to add to the overview document is what technologies and dependencies are needed to run the different scripts, e.g., do I just need to run Python or R or do I need to install node.js, webpack, and all kinds of things? If the latter, how are dependencies managed? This would be important because if we want to integrate the scripts into one comprehensive system there would be much more work if we have to account for different technologies and/or rewrite a lot of code.

atlasharry commented 1 year ago

Got it! @candace-walker Candace, what about we split this into half and a half? Sorted from the alphabet order, I will cover the repo ABSA, ad_goal_classifier, ad_tone, attack_like, datasets, entity_linking, entity_linking_2022, face_url_scraper_2022, fb_2020, and you will cover the repo fb_entities_2020, github_howto, issue_classifier, party_classifier, party_classifier_pdid, public_data, race_of_focus, tv_2020. But this is just an overall distribution. We should stay in touch because some may connect different repos. Is that okay with you, Candace?

atlasharry commented 1 year ago

Manually merge Harry branch into Main. Now the readme is complete!

SebastianZimmeck commented 1 year ago

@markusneumann, I am repurposing this issue a bit. As discussed, the readme in this repo will serve as a general project overview pointing to the other repos, explain how they are connected, an overall architecture diagram, ... along those lines.

SebastianZimmeck commented 1 year ago

We discussed to treat this repo as the main project repo and entry point to the project. So, overarching points that concern multiple repos can be put in the readme (or wiki) of this repo. And we may also break down this readme into multiple documents if it gets too long. And further down the line deploy this repo via GitHub Pages as a project website.