fecgov / openFEC-web-app

DEPRECATED See https://github.com/18F/fec-cms for fec.gov's code
Other
43 stars 31 forks source link

Complete mapping data catalog and FTP data to advanced data pages #2318

Closed PaulClark2 closed 6 years ago

PaulClark2 commented 7 years ago

So that we can move data sets from classic to new fec.gov, use the strategy of distributing the data sets by existing advanced data category set in https://github.com/18F/openFEC-web-app/issues/2265 to create an outline with placement and order of the data sets.

Completion criteria

PaulClark2 commented 7 years ago

Raising (Advanced data page:https://www.fec.gov/data/advanced/?tab=raising)

Data Catalog

FTP

Spending (Advanced data page: https://www.fec.gov/data/advanced/?tab=spending)

Data catalog

FTP

Candidates (Advanced data page:https://www.fec.gov/data/advanced/?tab=candidates)

Data catalog

FTP

Committees (Advanced data page:https://www.fec.gov/data/advanced/?tab=committees)

Data catalog

FTP

Filings and reports (Advanced data page: https://www.fec.gov/data/advanced/?tab=filings)

Data catalog

FTP

jenniferthibault commented 7 years ago

Prototype

👀 🖼 InVision prototype with clickable side-menu and accordions

Questions and observations from working with the first draft:

By our principle that data should only live in one place, we should pick the category that fits best instead of duplicating the download link in two places. The following data sets are listed in multiple categories, so we need to decide on a single best fit for them:

More general data placement and source questions:

Observations: Finding a way to present the historical summaries feels like a bigger task than this issue. Are those data sets based in Waltham making it a NOW issue? Or are they based elsewhere which could allow us to pick up that task later?

As you open the accordions, there are also some where I had a hard time finding the exact year range available, or knowing what text to pull for descriptions. Those are noted in pink.


I know this is a lot, glad to talk through!

PaulClark2 commented 7 years ago

Thanks, Jen.

Let's drop Candidate disbursements.

We need to include links to the metadata and to the file formats, too. I'm hoping we can leverage a Wagtail template that allows for tables.

Data in one place

General questions and source data

External sources: Let's not map these to content categories. They aren't FEC data.

jenniferthibault commented 7 years ago

Thanks Paul, I can make the changes to get data into one place in the mockups. Expect that to start next week, unless I have more evening time than expected this week.

Including metadata and file formats are new requirements for this design (and later implementation scoping). To think about: are these critical features, or do you think we can narrow them down at all?

jenniferthibault commented 7 years ago

🎨 Updated InVision prototype

There's a lot in this prototype, so I'm going to try to break it down into a change log with links to specific pages.

Changes

Advanced data

Presidential matching fund info & data

Administrative fine data downloads


Next steps & open questions

PaulClark2 commented 6 years ago

@jenniferthibault thanks for making the changes we asked for. The file formats look good. We'll probably need to do something a little different for the electronically and paper filed reports file formats. They have multiple file formats reflecting filing requirement changes over the years.

jenniferthibault commented 6 years ago

Thanks Paul, can you outline what the file formats are for what year ranges?

PaulClark2 commented 6 years ago

.FEC files of electronically filed reports have one of 15 formats. All the file format files are in a single compressed (.zip) file (http://classic.fec.gov/elecfil/eFilingFormats.zip). There is a table, http://classic.fec.gov/finance/disclosure/ftpefile.shtml, on classic that explains when specific versions of the format are valid.

.FEC files of Paper filed reports have one of 10 formats. All the file format files are in a single compressed (.zip) file (http://classic.fec.gov/elecfil/PaperFormats.zip). There is a table, http://classic.fec.gov/finance/disclosure/ftppaper.shtml, on classic that explains when specific versions of the format are valid.

jenniferthibault commented 6 years ago

Update: @PaulClark2 and I just paired through the electronic and paper filing scenarios, which are a little different from the rest. Since files are offered as daily collections (since 2001 and 2005) and it's important that we don't break the file download links for users, we are going to link to the s3 bucket instead of offering the downloads directly from the panel.

Example: Where the link would go to the s3 bucket bulk-accordion-11

I've updated the InVision prototype accordingly, and we're moving to implementation issues. Will follow up with links to those issues and close this when they're in place.

jenniferthibault commented 6 years ago

I've created a virtual flotilla of implementation issues to carry this task forward. 🛥⛵️🛥⛵️ 🛥

There are many issues because I tried to keep the tasks as small as possible for the nearest-term items, which will allow them to be split among more folks.

To prepare the designs, I started with a task to restyle the template as a whole:

Then focused on the bulk data tab as one section to complete

Followed by the same set of tasks for the data catalog data in the Raising, Spending, Candidates, Committees, and Filing and Reports tabs.

And isolated the same type of work for administrative fines and presidential public fund submissions. The difference here is that this work happens mostly in the CMS through Wagtail. It could be taken on by a content manager with a little help from someone comfortable with HTML tables.

Since the historical statistics link (which currently goes to the transition site) would be losing its home on the new site with the change, we're providing a tentative home for it in a new section on the Adv data tab. These collective changes meant we needed to update the items shown and order of the data landing page cards, and menu content.

--- This would be the point where v1 is complete! ---

We identified the need and desire to rewrite the data descriptions with more plain language so that they could be accessible to a wider audience. This work could be happening while the above work is in progress, but is not expected to be finished in time for the v1 release.

And finally, a new research and design task for understanding and transferring the historical statistic data onto the new site from transition. Since this information doesn't rely on Waltham, I've placed this tag in the backlog to help keep it separate from earlier priorities.

Since the implementation and follow up issues are in place, I'll close this issue.