DOI-ONRR / doi-extractives-data

Information on the extractive industries in the U.S. from federal data.
https://revenuedata.doi.gov/
Other
77 stars 41 forks source link

Design for archive #3539

Closed mcharg closed 5 years ago

brentryanjohnson commented 5 years ago

We have a number of content assets (pages, sections, PDFs, directories, timelines) that need to be archived. We can lock down this content and exclude them from the build process, leaving only the compiled assets and link to them.

We can use the existing subheading/column style on the how-it-works default page. The whole page will be branded as the USEITI archive (even though some content assets weren’t mandated by the EITI Standard).

Single page for archive (/archive)

Template: (/how-it-works) Intro: The United States participated in the Extractive Industries Transparency Initiative (EITI) from 2011 to 2017. EITI is a voluntary, international standard that promotes open and accountable management of natural resources. This site was originally created to publish the USEITI annual report as interactive data and supporting information.

In November 2017, the U.S. government decided to no longer formally implement the EITI Standard, but remains a strong supporter of the good governance and the principles of transparency represented by the EITI.

The goal will be to exclude the following from the build process and simply maintain the compiled, static output. That could be a problem if we change CSS or behaviors for the rest of the site that affects these archive pages. We'll need to audit them from time to time.

Also, we'll need to figure out the best way to include the static opt-in charts in the archived state pages. My thought was that we could simply include the static HTML that's generated in _site, but that markup contains react ids. @master12 Can we relocate this static markup without creating duplicate ids or creating collisions?

Archive sections

History and timeline (currently on /about/ page)

Executive summaries (2015, 2016, 2017)

Audits and Reconciliation

States and counties

Economic impact

brentryanjohnson commented 5 years ago

Starting to build out the archive based on the markup in how-it-works.

Archive page with USEITI logo and history and timeline

brentryanjohnson commented 5 years ago

The draft archive design is in this archive branch for your review, @jennmalcolm and @mcharg.

I'm not yet opening a PR for the following reasons:

mcharg commented 5 years ago

Looks good to me.

jennmalcolm commented 5 years ago

I agree. I like the structure and that we will be consolidating the EITI info and data we are not updating. The timeline for EITI is better here, and unnecessary in the about page now (#3583).

brentryanjohnson commented 5 years ago

We have our design in place for the archive. Next steps (in this order):

  1. Build archive pages for opt-in states and migrate opt-in content from current state pages to new pages (#3629)
  2. Repair and test links
  3. Restructure state summary content (#3277)
  4. Remove content that will not be archived in its current form (i.e., economic impact data, which will now just link to the agencies that provide the data)
  5. Remove archived assets from build process (we need to scope this and figure out if it's desirable) optional