Skip to content
This repository has been archived by the owner on Nov 10, 2020. It is now read-only.

Commit

Permalink
Merge pull request #4447 from ONRR/dev
Browse files Browse the repository at this point in the history
Dev-->master
  • Loading branch information
jennmalcolm authored Aug 19, 2019
2 parents f628fe5 + d5ddaef commit 5eca316
Show file tree
Hide file tree
Showing 275 changed files with 140,561 additions and 204,692 deletions.
4 changes: 2 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: 2
jobs:
build:
docker:
- image: circleci/node:11.7.0
- image: circleci/node:10.16.0
steps:
- checkout
- restore_cache:
Expand All @@ -16,7 +16,7 @@ jobs:
- node_modules
- run:
name: Build gatsby
command: NODE_OPTIONS=--max_old_space_size=4096 npm run build
command: npm run build
- run:
name: Run tests
command: npm test
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,8 @@ yarn.lock
/public
.DS_Store
_site

# vscode
/.vscode
launch.json
.vscode
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
11.7.0
10.16.0
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,32 @@ This project is in the worldwide [public domain](LICENSE.md). As stated in [CONT
[Ruby]: https://www.ruby-lang.org/en/
[Jekyll]: http://jekyllrb.com/
[Node]: https://nodejs.org/en/

## Development Environment

### How it works
This project uses the [GatsbyJS](https://www.gatsbyjs.org/) open source framework. This framework builds static web pages that then are published to our production environment. You can read more about Gatsby on their website.

#### High Level Overview
Data and content is read into a graphql schema. This graphql schema is then used to create queries to get the data and content needed to create the pages in the site. Pages are generated either by a template or a React component in the pages directory. Once the page is built it is copied to the public directory into the appropriate subdirectory. All javascript, css and data are embedded into the page. At runtime the react components are initialzed and the page is rendered.



### Getting Started
Prerequisites:
- node
- npm

Once you have cloned the repository run:
> `npm install`
Local dev commands:
- `npm run develop` - This will start a local server running on port 8000 by default
- `npm run build` - This will create the static html pages that are used in the production environment
- `npm run server` - If you have run the local build command this wil start a web server so you can view the static html files on port 9000 by default
- `npm run clean` - This wil clean the cache created by the gatsby build process. Use this when you need a refresh the data the site uses.
- `npm run format` - This site uses eslint for fomratting and syntax checking
- `npm run test` - We current use Jest to create unit tests. This command will run all the tests locally.



41 changes: 30 additions & 11 deletions blog-site/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

85 changes: 85 additions & 0 deletions blog-site/src/pages/beyond-open-data/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: "Beyond open data"
authors:
- Lindsay Goldstein
excerpt: "How we’re going beyond government mandates to provide truly open data."
tags:
- open data
- OPEN Data Act
- IDEA
- data
- accessibility
- user experience
- user research
date: "2019-08-19"
---

## Background

At the Office of Natural Resources Revenue (ONRR), we were already well positioned to comply with new government open-data mandates that have been signed into law over the past year. We have a long history of publishing our federal natural resources revenue data – first in books, then on CDs, and then in an online format in the early 2000s. We took it a step further after joining the Extractive Industries Transparency Initiative (EITI) in 2011, which requires transparency and accountability in managing oil, gas, and mineral resources. Our implementation of the EITI standard required us to not only disclose revenue from energy and mineral extraction, but also required us to show how revenue moves through the government and benefits the public.

We published the first natural resources revenue website in 2015. Although the US withdrew from EITI in 2017, we committed to aligning with the current administration’s Management Agenda and providing open data to support good governance and transparency. We continue to embrace the principles of transparency and continue to work in the open, with open source code, and design with user needs in mind.

As a unique steward of U.S. natural resource revenue data, we are informing policy debates and raising public awareness by building the definitive source of timely and useful data about how the government manages federal energy and mineral resources, revenue, and disbursements.

Because we are internally driven to maintain high standards, we stay current with international trends in open data and are constantly searching for ways for our data to go beyond what is expected. We are happy to report that we have already implemented many of the guidelines mandated by recently passed federal laws.

## 21<sup>st</sup> Century Integrated Digital Experience Act (IDEA)

The [21<sup>st</sup> Century Integrated Digital Experience Act (IDEA)](https://www.congress.gov/bill/115th-congress/house-bill/5759/text) was signed into law in December 2018.

Here are some of the requirements of 21<sup>st</sup> Century IDEA:

### Section 508 compliance (accessibility)

Our content strategist is well versed in accessibility compliance and works with our team to make sure our content is accessible. He documented simple procedures in the [accessibility section](https://github.com/ONRR/doi-extractives-data/wiki/Content-guide#accessibility) of our [content guide](https://github.com/ONRR/doi-extractives-data/wiki/Content-guide) to help team members create content on their own. Our content strategist then performs quarterly accessibility audits, and we set out to fix the errors. In addition to the work we are doing on our own website, our content strategist is creating a workshop to share how to comply with accessibility requirements with other groups within ONRR.

### Avoid duplication

This provision states that a website “does not overlap with or duplicate any legacy websites, and, if applicable, ensures legacy websites are reviewed, eliminated, and consolidated.” Natural Resources Revenue Data ([revenuedata.doi.gov](https://revenuedata.doi.gov/)) has fully replaced both the EITI website and a public statistics website by combining the data from both websites in one location.

### Searchable

We already have a search function on our website.

### User-driven design

This provision states that the website must be “designed around user needs with data-driven analysis influencing management and development decisions, using qualitative and quantitative data to determine user goals, needs, and behaviors” and that we should “continually test the website...to ensure that user needs are addressed.” We follow a user-centered development practice to design our site led by our user experience expert. As such, our user experience designer guides our [user-centered design and development cycle](https://github.com/ONRR/doi-extractives-data/wiki/User-Centered-Design-Process).

### Mobile Devices

We already design for and test our website’s functionality across different browsers and mobile devices to ensure proper functioning.

## The Open, Public, Electronic, and Necessary (OPEN) Government Data Act

The Open, Public, Electronic, and Necessary (OPEN) Government Data Act was signed into law in January 2019. The [OPEN Government Data Act](https://www.congress.gov/bill/115th-congress/house-bill/4174/text) was included in the Foundations for Evidence-Based Policymaking Act (Public Law 115-435) as Title II. The OPEN act is more extensive than the 21<sup>st</sup> Century IDEA. The law expands upon important features of a 2013 Executive Order on Open Data. We already adhere to many of the OPEN act’s key directives.

Here are some of the requirements of the OPEN Government Data Act:

### Open data

Our website is built and maintained by [open source code](https://github.com/ONRR/doi-extractives-data/) for the purpose of providing [open data](https://revenuedata.doi.gov/downloads/). We publish as much natural resources revenue data as possible, without revealing proprietary company information or personally identifiable information.

### Machine-readable

Agencies need to ensure that any public data asset of the agency is machine-readable. We refrain from creating content that isn’t machine readable by default, such as PDFs, and are working to convert legacy content into machine readable formats. We also publish data in both Excel and `csv` formats, so viewing and using the data isn’t dependent on specific software applications.

### Outside collaboration

Agencies must facilitate collaboration with non-Government entities (including businesses), researchers, and the public for the purpose of understanding how users value and use government data. In addition to extensive user testing, we also welcome collaboration on our source code and data through GitHub and invite users to email us with questions and suggestions. Our agile content management, design, and development practices enable our team to respond quickly to user needs, as we did recently when a user contacted us about ambiguous content.

### User-centered design/outreach

Agencies must engage the public in using public data assets of the agency and encourage collaboration. In addition to being able to collaborate via [GitHub](https://github.com/ONRR/doi-extractives-data/issues), we also maintain an email address and social media accounts as avenues for public interaction. We conduct extensive user testing as we iterate our product and include this feedback in our final product. We also participate in outreach via public forums such as conferences and workshops.

### Analytics

Agencies must identify and implement methods for collecting and analyzing digital information on data asset usage by users within and outside of the agency, including designating a point of contact within the agency to assist the public and to respond to quality issues, usability issues, recommendations for improvements, and complaints about adherence to open data requirements within a reasonable period of time. While we won’t lead the agency initiative on this directive, we already maintain monthly [analytics](https://github.com/ONRR/doi-extractives-data/wiki/Analytics) to help us identify and cater to our audience. Our users can also always reach us via [GitHub](https://github.com/ONRR), social media, or our email address: [[email protected]](mailto:[email protected]).

### Metrics

Agencies must develop and implement a process to evaluate and improve the timeliness, completeness, consistency, accuracy, usefulness, and availability of open Government data assets. We have instituted [metrics](https://github.com/ONRR/doi-extractives-data/wiki/Goals-and-metrics) that address the above requirements and track them on a regular basis.

### Conclusion

Given that we are continually assessing our performance using internal metrics that encompass the areas addressed by IDEA and OPEN Government Data Act, we are confident that we will continue to meet or exceed federal laws and regulations governing open data. We also expect these metrics to evolve as we identify new opportunities through our mission to set the gold standard for open government data.
Binary file removed downloads/CY 03-18 Federal Revenues.xlsx
Binary file not shown.
Binary file removed downloads/FY 03-18 Federal Revenues.xlsx
Binary file not shown.
Binary file not shown.
Loading

0 comments on commit 5eca316

Please sign in to comment.