Skip to content
This repository has been archived by the owner on Dec 3, 2017. It is now read-only.

Create template page for historical archive lists of documents #540

Closed
jenniferthibault opened this issue Oct 13, 2016 · 13 comments
Closed
Assignees
Milestone

Comments

@jenniferthibault
Copy link
Contributor

For example:

  • complete list of commission meetings
    • agenda from that meeting
    • podcast from that meeting
    • transcript from that meeting
  • complete list of sunshine act notices
  • complete list of public hearings
    • associated documents
  • and others that we'll learn more about along the way
@jenniferthibault
Copy link
Contributor Author

Carrying over from #555:

For looking at index pages there are a few possible flows:

  • Collections/groups of documents that have similar utility to users
    • document type/title
    • sometimes (but not always) an explanation of what the document title means
    • number of documents of that type that exist in each index
  • Lists / indexes of the documents all in one place
    • ability to sort by date/quickly see item date
    • sometimes (but not always) ability to filter by category within item type
    • when item is HTML, ability to view snippet text and link to document canonical page
    • when item does not have HTML copy, ability to easily and quickly access native doc and associated collateral (agendas; transcripts; recordings; sometimes PDFs, sometimes XLS)
  • Canonical item page
    • HTML body copy
    • associated collateral (agendas; transcripts; recordings; sometimes PDFs, sometimes XLS)

We pretty much have templates that fit each scenario 🎉 , but it will be helpful for me to mock up a few specifics about each, especially in cases where we don't have HTML pages, or where we want to attach associated collateral.

cc @emileighoutlaw

@noahmanger
Copy link
Contributor

Just running through things before the demo on Monday. @jenniferthibault do you have anything done that you'd want me to show partners in our end-of-sprint demo?

@jenniferthibault
Copy link
Contributor Author

I finished work on this over the weekend, but don't think it's really demo-able. It's a long series of patterns & flows. I'm going to update this issue this morning, and if it's before your demo, and you think it makes sense, go for it.

@jenniferthibault
Copy link
Contributor Author

jenniferthibault commented Nov 7, 2016

General pattern flows:

1 - [A] Groups of related documents » [B] Browsing within document type » [C] Canonical item page
2 - [B] Browsing within document type » [C] Canonical item page

[A] Groups of related documents

This is the first new pattern in the card family. It's flexible enough to hold a title, brief explainer copy, and document count. It works best in 3-across grids, but should also work in 2-across grids.

If desired, we could implement search across this pattern.

screen shot 2016-11-07 at 10 46 02 am

[B] Browsing within document type: feed

This is an existing module (first seen in the Latest Updates feed) that will need case-by-case tweaks to accommodate:

  • Filtering parameters
  • Item/document completeness. Sometimes items have HTML copy, other times they are just PDFs that will be ported over into an archive.

screen shot 2016-11-07 at 10 46 25 am

[C] Canonical item page

Each item in the feed should link to a canonical page for the item, regardless of level of completeness. Each canonical item should have a shareable unique URL.
We have several existing templates for these pages, including the Weekly digest template, a Registration and Reporting item template, and the in-progress Agenda template.

screen shot 2016-11-07 at 10 47 55 am
screen shot 2016-11-21 at 10 53 33 am

Next steps

@noahmanger / @emileighoutlaw I'd love your help here, not quite sure what comes next.

We could pick a set of items to port over into the new template flows. I think the meeting agenda archive fits neatly into Flow 2 above, and could be a possibility. That means we'd need to finalize the Wagtail agenda template, decide on filtering parameters for open meeting archives, design icons for transcripts and audio, scrape content, etc.

Or we could focus on building out the new card pattern for Flow 1 that would make this a complete set. As of yet I'm not sure if there's agreement on which groups of related documents might go together first, so it might be a while before we use what we'd build.

Or another way forward I haven't mentioned?

@noahmanger
Copy link
Contributor

Sorry it's taken me so long to get to this. I really love these. The only question I have is if a resource doesn't have any actual HTML (e.g. it's just a PDF or MP3) do we need to give it its own page? Doing so makes for an unnecessary step, and leads to pages that are empty except for a link. But on the other hand, it might make it easier for people to share.

I don't have strong feelings — and could be persuaded by one being easier to develop than the other — but wanted to throw that out there.

@jenniferthibault
Copy link
Contributor Author

Even though it will make many scant pages, since these pages are serving archival & research needs, I think having a unique URL for each would be helpful. Otherwise it will be hard to find these documents, transcripts, and details again without finding their position in a feed.

Do you agree, @emileighoutlaw ?

@emileighoutlaw
Copy link
Contributor

Oh a great question! For PDF documents — researchers could theoretically open them in their browsers and save those PDF URLs for future reference, right? Would that serve the same need?

@emileighoutlaw
Copy link
Contributor

I spent some time looking at these templates and the content that's left to port over from FEC.gov— At a first look, I think our templates (Registration and reporting, Weekly Digest, and the in-progress Agenda) should fit all the needs for our canonical pages.

A thought— we don't have a Read next feature in our Registration and reporting template (We've been using the Related topics to guide people in that section of the website), but we do in all the others. This is probably outside the scope of this issue, but I'm wondering if either of y'all think we should consider adding that to our Registration and reporting template for consistency.

Next steps— I'd be eager to dive into something small but useful. Like FOIA reports? But I think that's a Flow 1 item, because it's housed inside the "About FEC" section.

@noahmanger
Copy link
Contributor

@emileighoutlaw yeah, you're right, their PDF URL would always work as a bookmark / permalink.

Re: "read next" -- we decided not to do this for registration and reporting because so many of the pages are shared by different checklists with different flows.

Re: next steps, do you have a set of documents that will fall into these flows?

@emileighoutlaw
Copy link
Contributor

emileighoutlaw commented Dec 2, 2016

Ah, that's right about the "next" feature. Thanks for jogging my memory, Noah.

Documents that fall into these flows:

Flow 1 (groups of related documents that will live in the About FEC section)

  • Department and office pages (~30 HTML pages)
  • Legislative recommendations, history, and reports (~50 mix of PDF/HTML pages)
  • Strategic plans (~8 mix of PDF/HTML pages)
  • Budget plans and reports (~100 mix of PDF/HTML pages)
  • FEC policies and directives (~50 mix of PDF/HTML pages)
  • Annual reports; anniversary reports (~35 PDF pages)
  • Procurement reports (~10 PDF pages)
  • IG reports (~150 mix of PDF/HTML pages)
  • Commissioner pages (~690 mix of PDF/HTML pages)
  • FOIA (~30 mix of PDF/XML pages)

Flow 2 (browsing within Latest updates)

  • FEC record articles
  • Tips for Treasurers
  • Sunshine notices (notices that a meeting is going to happen and generally what will be discussed at that meeting)
  • Meeting agendas (published after Sunshine notices and including more detail)

@emileighoutlaw
Copy link
Contributor

After our chat, I now fear my comment (above) jumped a few steps.

I was imagining that — because we are planning to include many different groups of documents in the About FEC section — the design of the About FEC landing page would include cards (and then feeds) for at least a portion of those document types. However, holding my horses, I think a better answer is:

Every document type that we have said we'll include in Latest updates should be part of the Latest updates feed. Those document types are:

  • FEC record articles
  • Tips for Treasurers
  • Sunshine notices (notices that a meeting is going to happen and generally what will be discussed at that meeting)
  • Meeting agendas (published after Sunshine notices and including more detail

The things that will be included in the About FEC section (however that gets designed) will be:

  • Department and office pages (~30 HTML pages)
  • Legislative recommendations, history, and reports (~50 mix of PDF/HTML pages)
  • Strategic plans (~8 mix of PDF/HTML pages)
  • Budget plans and reports (~100 mix of PDF/HTML pages)
  • FEC policies and directives (~50 mix of PDF/HTML pages)
  • Annual reports; anniversary reports (~35 PDF pages)
  • Procurement reports (~10 PDF pages)
  • IG reports (~150 mix of PDF/HTML pages)
  • Commissioner pages (~690 mix of PDF/HTML pages)
  • FOIA (~30 mix of PDF/XML pages)

But I'll wait to talk strategy and design of the About FEC section with @jenniferthibault.

@jenniferthibault
Copy link
Contributor Author

@emileighoutlaw do you want to close this issue in favor of advancing to https://github.com/18F/fec-cms/issues/626 , or leave it open for anything remaining here?

@noahmanger
Copy link
Contributor

I was just about to close this! #626 is a next step, and I'll be making issues for porting over the rest of the latest updates stuff.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants