opencivicdata / docs.opencivicdata.org

Open Civic Data project documentation
https://open-civic-data.readthedocs.io
44 stars 33 forks source link

Add database setup instructions #75

Open jmcarp opened 7 years ago

jmcarp commented 7 years ago

The docs should include or link to instructions for running the database locally--something like

Adding docker instructions would be neat too!

jpmckinney commented 7 years ago

I have very minimal instructions in another project which could be expanded into these docs: https://github.com/opencivicdata/scrapers-ca/#usage

fgregg commented 7 years ago

yeah, I have basically the same https://github.com/opencivicdata/scrapers-us-municipal#initialization

jpmckinney commented 7 years ago

@jmcarp On which page of the docs do you think it would make sense to add this content?

jmcarp commented 7 years ago

How about as a sibling to http://docs.opencivicdata.org/en/latest/scrape/run_scraper.html ? Then, instead of the oblique reference to the database ( if don’t have an opencivicdata postgres database set up ), that page can say something like:

To store scraped data in a database, run (link to database setup). Otherwise, if don’t have an opencivicdata postgres database set up, ...