search

edgi-govdata-archiving / web-monitoring

Documentation and project-wide issues for the Website Monitoring project (a.k.a. "Scanner")
Creative Commons Attribution Share Alike 4.0 International
105 stars 17 forks source link

Revamp and update README #137

Closed Mr0grog closed 5 years ago

Mr0grog commented 5 years ago

A lot of information in the README was out of date, and I've also seen lots of people have trouble sorting through it at meetups. With these changes, I'm hoping to offer a clearer overview and more direct access to all the sub-projects where most of the work happens.

I've dropped the "technologies used" list because it's so broad it doesn't feel especially helpful. I've tried to preserve some flavor of it by including some of the major technologies/languages in the list of sub-projects.

You can view a diff in the “files changed” tab, but for a straight preview of the new version, check https://github.com/edgi-govdata-archiving/web-monitoring/blob/readme-revamp-2019-08/README.md

I’m not sure this is perfect, but hopefully an improvement. Feel free to suggest edits!

lightandluck commented 5 years ago

Also, glad we got rid of lots of outdated stuff 👍

Mr0grog commented 5 years ago

I was surprised to find that the IA / Wayback Machine isn't in the list of sponsors & partners. Should they be added?

😳 Whoa, they should definitely be there! Will add.

SYU15 commented 5 years ago

Agreed, I like the changes! It'd be nice to see the architecture doc revamped/relinked at some point though (I mentioned it in the other issue before I saw that you removed the reference here). Even one similar to the one in your notebook could be helpful :)

SYU15 commented 5 years ago

Agreed, I like the changes! It'd be nice to see the architecture doc revamped/relinked at some point though (I mentioned it in the other issue before I saw that you removed the reference here). Even one similar to the one in your notebook could be helpful :)

Wait nvm, actually you just moved it, my bad. So my comment on the other issue in terms of revamping it stands, I think.

Mr0grog commented 5 years ago

Yes, definitely want to revamp/update/expand the architecture doc, too! One thing at a time, though. :)

Mr0grog commented 5 years ago

Ok, I added a badge (and link at the bottom of the description, too) for the project board. I know I generally say I’m not a fan of having a huge row of badges, but I felt like I wanted a nice shortcut for this. Thoughts?

Screen Shot 2019-08-09 at 9 59 41 AM