search

caciviclab / odca-jekyll

New ODCA front end
https://www.opendisclosure.io
GNU Affero General Public License v3.0
17 stars 14 forks source link

Share calculation methodologies in FAQ #185

Open elinaru opened 6 years ago

elinaru commented 6 years ago

See: https://www.opendisclosure.io/faq/#odca-calculation-methodologies

Currently this FAQ section reads, "The code we use to make these calculations can be found in the caciviclab/disclosure-backend-static repository (https://github.com/caciviclab/disclosure-backend-static/tree/master/calculators)."

This isn't really accessible to non-developers. Can we be more explicit how we calculate our totals here?

adborden commented 6 years ago

Since the existence of this project I've wanted to create a campaign finance wiki as it's own project to document how all of this stuff works in California. It's all pretty complicated to put in an FAQ, but maybe we want to link to a wiki. This is something I'd like to take on since we're still learning things about how it all works. How does that sound?

adborden commented 6 years ago

That was kind of a temporary home for the campaign finance wiki, but I'm looking at turning it into a proper website.

elinaru commented 6 years ago

Works for me.

sfdoran commented 6 years ago

Looks like a good start. I'll read through it.

ckingbailey commented 4 years ago

@sfdoran, @anlawyer and I talked about this and have begun to devise a plan.

@tdooner is going to show @anlawyer and me around the backend on Tues 1/28. We will start a notes Google Doc at that time to start to document how the various calculations work. That document can serve as the starting point for resolving this issue.

We see this issue as high priority for quality control, our own accountability, and onboarding of future backend developers.

A diagram would also be helpful in helping people understand out how we do the calculations.

ckingbailey commented 4 years ago

See helpful reference in @adborden's 9-item list on issue #305