Create new documentation - Githubissues

opennorth / represent-canada

Point or postcode to electoral district service for Canada, its provinces and municipalities

http://represent.opennorth.ca/

MIT License

65 stars 9 forks source link

Create new documentation #99

Closed jpmckinney closed 7 years ago

jpmckinney commented 7 years ago

Tasks: Request boundaries

[x] Requesting boundaries (similar sections to Represent CSV Schema docs)
[x] Adding a boundary: define task, run all tasks with --base, run spreadsheet as normal
[x] Handling slug collisions, like 'Richmond, NS' and 'Paroisse de Plessisville'
[x] Making an MFIPPA request (sample text, upload past requests)
[x] Refer to Google Sheets Mail Merge

Tasks: Respond to emails

[x] Requests for new data (ask budget)
[x] Offers to supply data (spreadsheet option)
[x] Postal code errors (boilerplate response)
[x] Outdated/missing data (fix scrapers-ca)
[x] Creating app (ask for link when ready)
[x] Updating the users spreadsheets

jpmckinney commented 7 years ago

Overview

Data sources:

[x] boundaries
[x] web scrapers
[x] CSV scrapers
[x] CSV proxies

Repositories:

[x] represent-canada project and related apps
[x] represent-canada-data and represent-canada-private-data
[x] scrapers_ca_app and scrapers-ca
[x] represent-canada-csv-proxy
[x] ocd-division-ids
[x] govkit-ca gem, Drupal module and WordPress plugin

Deployment

Servers:

[x] Access to servers
[x] Server configuration
[x] AWS failover configuration
[x] Fabric commands

Heroku:

[x] Access to Heroku
[x] Heroku apps
[x] image-proxy and Cloudfront

Maintenance

[x] Flesh out maintenance tasks more, like using headers to sort dashboard
[x] Interpreting the different events that can occur when performing maintenance tasks
[x] The rare changes to make to represent-canada: data.js, demo.js order

CSV Schema

[x] Going through and updating the CVS Schema spreadsheet
[x] Sending "Elected Officials' Contact Information" emails with attachment
[x] Adding the logo to http://represent.opennorth.ca/government/
[x] Writing and configuring CSV scrapers
- Add BC candidates

Maintaining boundaries

[x] Writing a definition.py file: writing name_func and id_func
[x] Document when a new license URL is discovered (constants.py)
[x] Discuss different sources: online, email, MFIPPA, purchase
[x] Add a docs sheet: data dictionary, making sense of other sheets, sort order
[x] Link to https://github.com/opennorth/represent-canada/issues/102

Cleanup

[x] scrapers-ca: run invoke tidy and document expected output
[x] Delete this wiki page and finish redocumenting and cleaning up unnecessary shapefiles for ca_qc_districts, ca_qc_boroughs, ca_qc_wip
[x] Finish maintenance steps

Maintenance support

[x] represent-canada-data: Add a task to display all files without data_url, including notes
[x] represent-canada-data: Add a task to create a manifest file with number of (valid) geometries and sample values for name and id functions, to more quickly update shapes
[x] scrapers-ca: Describe the validations performed
[x] scrapers-ca: Describe any other modifications to Pupa (e.g. helper methods)