Coder Social home page Coder Social logo

fecgov / fec-eregs Goto Github PK

View Code? Open in Web Editor NEW
33.0 33.0 13.0 6.83 MB

The Federal Election Commission's web-based application that makes regulations easier to find, read and understand.

Home Page: https://www.fec.gov/regulations/

License: Other

Python 6.83% HTML 5.24% JavaScript 1.53% Handlebars 2.32% SCSS 83.66% Shell 0.42% Procfile 0.01%

fec-eregs's People

Contributors

adborden avatar annalee avatar anthonygarvan avatar ccostino avatar cmc333333 avatar cnlucas avatar djgarr avatar dogweather avatar dorothyyeager avatar fec-jli avatar fecjjeng avatar hcaofec avatar jason-upchurch avatar jessieay avatar johnnyporkchops avatar jonellaculmer avatar kathycarothers avatar lbeaufort avatar lindsayyoung avatar patphongs avatar paulclark2 avatar pkfec avatar qqss88 avatar rfultz avatar rjayasekera avatar tadhg-ohiggins avatar tmpayton avatar xtine avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

fec-eregs's Issues

Navigation: Index

Would it be useful to include the 11 CFR Index to the e-regs (by link or otherwise) - some people are more comfortable with that than with coming up with specific search terms. Suggest having Ed's 18F UX team discover user thoughts on the issue.

Effective date

The effective date for all parts seems to be 2/22/2016. This is incorrect.

Implement all AOs returned page

Currently we display the combined search page which only displays the top 10 results.

Let's implement the next page where the user has clicked on display all results for AOs.

Usability test: Advisory Opinion canonical page

I'd like to assess the ease of use and comprehension of two versions of the Advisory Opinion canonical page, a basic version and one with the addition of a summary from the FEC Record newsletter.

Required activities:

  • Create test materials
  • Run test
  • Post conclusions here

Test materials

Task: Advisory Opinion pages

Version 1 link: https://gsa.invisionapp.com/share/9Q710V45R#/screens/152290010
Version 2 link: https://gsa.invisionapp.com/share/9Q710V45R#/screens/152290007

Script:

Version 1

  • (Go to link 1)
  • What is this page about?
  • What is this Advisory Opinion about?
  • Where can you go from here?

Version 2

  • (Go to link 2)
  • What is different now?
  • What is this Advisory Opinion about?

Retros

Stories that are coming out of our retrospective feedback

Presentation: reserved sections

Part 6: Because each individual section is separately labeled "reserved" (instead of grouped together), the Part is hard to navigate, and the TOC scrolling bar is so small that it disappears behind the TOC header.

Create documentation on deploying fec-eregs

Given aches and pains of folks deploying fec-eregs; we need to have light weight documentation for devs to be able to follow.

These should be added as part of or a link to the readme for this repo.

Presentation: subsections

Some subsection designations are hidden behind the text of the subsection title (e.g., 114.4(b)(1), 114.4(c)(3)(i), 114.4(c)(7)(i)).

Integrate content area into Legal landing page

The content area below the hero can be prepared and integrated into the site. Initial testing showed people able to navigate the area and it closely follows patterns established elsewhere.

@emileighoutlaw We should talk about content needs, which are pretty basic here.

legal home - alt alert

For sections not ready, we should fade/deactivate them.

cc @Porta @adborden

Design Spike - Merge eregs into beta.fec

Lets discuss this during planning.

In the next few sprints, we want to have eregs visible from beta.fec.gov so that
a) we will be able to release it to the public
b) we are able to search across eregs and other legal resources

To the untrained user, it should feel as if they are just viewing beta.fec.

However, currently eregs is a separate stack of assets from a separate instance of elastic search backend to a separate app. Integrating this into beta.fec is not a trivial task.

Does it make sense for us to design spike the way we will merge the two? Or do we start the work (but need guidance on how to split it up into manageable stories)

Things to keep in mind

  • eregs search vs. integrated search : do we keep both or just support integrated search?
    • if we just support integrated search, will that preclude us from supporting historical diff searches in the future.
  • iFrame?
  • Keep separate backends
  • etc etc

Presentation: CFR conventions

Subsections are designated throughout by the subsection letter/number followed by a period -- CFR convention is to put the letter/number within parens. Similarly, on the main TOC, the Title is labeled "Title XI" -- that should be "Title 11" per CFR convention.

Load AO PDFs into S3 and link to them

Currently, we are linking to the PDFs hosted on fec.gov. We should port the AOs into cloud.gov and update links in elasticsearch:

  • Get binary data out of Oracle into file
  • Add S3 write API (/load/legalfile/)
  • Write shipper code to post file to /load/legalfile/

Usability Testing - Blanket validation of Design Concept

We have presented several mockups in our demos and used the feedback there to implement code.
Now that we have a healthy user experience designed, we want to get into a cadence of performing usability testing to validate the designs before implementing.

In this sprint we want to test:

  • Browsing
  • AO canonical landing page

Get parser to run on all FEC regulations

Upon running the 18F/regulations-parser on FEC regulations (title 11), there were 50 regulations that parsed properly (at least, completed parsing- have not manually verified accuracy), and 3 that failed. This issue may be closed once all 53 regulations can be parsed.

Usability test: Advisory Opinion landing page

I'd like to get initial thoughts on the advisory opinion landing page.

Required activities:

  • Create test materials
  • Run test
  • Post conclusions here

Test materials

Task: Look at this page and talk about what you can do here.

[Note: I'm interested in getting some pretty basic initial responses to the page as currently designed, including what the subject matter is and what actions a person can take from the page.]

Link: https://invis.io/9Q710V45R#/152290006_AOs_Landing

Script:

  • Are you familiar with Advisory Opinions?
    • (If no, read this) An Advisory Opinion is when a campaign or committee asks the FEC to determine if something they are interested in doing is legal. Once the FEC decides, other campaigns and committees look at the Advisory Opinion as guidance.
  • I'd like to have you take a look at a page and tell me about it. You'll notice some of the content is placeholder text, but I'd like to hear what you think the text would be about.
  • Load page
  • Talk me through this page. What is it? What do you see? What can you do?
  • If you wanted to find an advisory opinion about, say, "filing", can yo do that?
  • (If they haven't talked about the left column...) What's going on in that gray column on the left?

Hide references to regulation timeline and effective date

Currently functionality to support regulation timelines is not supported. We have both bugs that need to be resolved as well as missing Federal Register data required to support that functionality. Due to a prioritization discussion, we want to hide that functionality in the fec-eregs instance.

I can also see this being a flag that we may want to enabled/disable on core as there are other agencies that may have the same problem (validate with #eregs)

We need to:

  • Hide the regulations timeline icon
  • Hide the effective date in the top bar
  • HIde the "Regulation Effective" date field on the search menu

Links/definitions: Some definitions inaccurate

Some of the linked definitions don't accurately reflect the term as used in context (e.g., in 1.1(b), "Act" is linked to the definition of FECA, even where the word is used in term "Privacy Act"; in 100.1, "Election" and "Commission" are individually linked even when used within the phrases "Federal Election Commission" and "Federal Election Campaign Act")

Develop the AO canonical page

The canonical page for an advisory page is ready for development. The information was generally understood as straight forward in initial testing and I think it's fairly non-controversial.

Citations: The mock-up below includes citations on the right, which I do not believe are available. I think we could include the box with grayed-out "Coming" text.

Audio: the mock-up below includes a link to the audio from the hearing. This is not ready and should not be included yet.

image

Please note that this version does not include the FEC Record summary. That would be an enhancement in the future, so please be aware of it, but don't built it yet. Here's is the current placement of that potential future content:

image

CC @porta-antiporta @adborden

Load & Index Current MURs into elastic search

To support MURs, we want to include current and archived MURs in our search. Archived MURs are part of a separate story. This story focuses on loading current MURs into elastic search.

Assumptions

  • FEC has loaded MURs up in Postgres

Tasks

  • Enhance the API developed in #220 to include current MURs (should be same API for current and archived)
  • Load MURs into S3
  • Index MURs in Elastic search
  • Set up celery tasks to ensure freshness and consistency across our environments
  • Create tests

Mockup
https://gsa.invisionapp.com/share/AR7U3Y662

Improvements to search AO

  • Enhance API to load data
  • Load remaining AOs
  • Paging
  • Putting in AO Ids should give AO as first hit
  • Snippets
  • Proximity search
  • Include total result count

Adjustable snippet length from legal search API

If possible, let's configure the legal search snippet text length to be longer. Ideally added as a query parameter to the API so we can play with it.

The current snippet text is too short. We're including all the hits concatenated together, joined with ellipsis. This is misleading because it looks like the text is related but in fact these snippets could be pages apart in the document.

screenshot from 2016-04-27 18-50-51

cc @edmullen

Move AO Loading Code to fec-shipper

Move to fec-shipper:

  • - Get Oracle running on MacOS. I'm over the Oracle VM.
  • - Connect to Oracle with pyodbc
  • - Decide on maintainable solution for code execution
  • - Implement AO shipping code in fec-shipper repo

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.