feat(blog): add post for office of natural resources #11561

brentryanjohnson · 2019-02-05T07:57:11Z

Blog post submission for government open data site to gatsbyjs

merge in recent commits

DSchau

Looking good--left a number of comments! The only blocker is the author field which currently only supports a single author.

DSchau · 2019-02-05T19:12:26Z

docs/blog/2019-02-06-government-open-data-site-with-gatsby/index.md

+
+A few months ago, our small team at the Office of Natural Resources Revenue (ONRR) decided we needed to refactor our [open-data website](https://revenuedata.doi.gov/). We knew we were in for a massive undertaking, as the site was originally built with the static-site generator [Jekyll](https://jekyllrb.com/), with significant custom coding to furnish bespoke features, automate data updates, and compile and deploy the site with [18F's](https://18f.gsa.gov/) fantastic static-site hosting service, [Federalist](https://federalist.18f.gov/).
+
+As covered in our [first post in this series](/homepage-revamp/), we were simultaneously scoping a redesign of our homepage. Rebuilding the homepage would allow us to test some of our assumptions about how to address obstacles in our existing workflow.


You'll have to make these links (/homepage-revamp/) absolute (e.g. prepend the original blog post URL).

Ooops! Yes, thank you.

DSchau · 2019-02-05T19:19:14Z

docs/blog/2019-02-06-government-open-data-site-with-gatsby/index.md

+title: "How we're migrating a government open data site to Gatsby"
+date: 2019-02-05
+authors:
+  - Ryan Johnson


We don't currently support multiple authors :/ Is there a primary author on this post we could use? Otherwise we'll have to implement that feature to ship this blog post.

I can change it to reflect a primary author.

We did modify the gatsby-starter-blog to support multiple authors when we shipped our blog, but I'm not quite happy with the way I'm doing it now (I describe why over here: https://brentryanjohnson.com/content-design-dry/)

DSchau · 2019-02-05T19:19:36Z

docs/blog/2019-02-06-government-open-data-site-with-gatsby/index.md

@@ -0,0 +1,237 @@
+---
+title: "How we're migrating a government open data site to Gatsby"
+date: 2019-02-05


Let's schedule this for Friday

Suggested change

date: 2019-02-05

date: 2019-02-08

(will also need to re-name the file if that's OK with you both!)

No problem.

DSchau · 2019-02-05T19:28:09Z

docs/blog/2019-02-06-government-open-data-site-with-gatsby/index.md

+
+As mentioned above, we use [Federalist](https://federalist.18f.gov/) to build and deploy the site. Federalist builds out every branch in our GitHub repository, so we can preview the changes before we merge them.
+
+We encountered an issue with the Federalist preview URLs and relative links and assets. Gastby solves this by using a `pathPrefix` variable in `gastby-config.js` and a custom component named `Link`.


Suggested change

We encountered an issue with the Federalist preview URLs and relative links and assets. Gastby solves this by using a `pathPrefix` variable in `gastby-config.js` and a custom component named `Link`.

We encountered an issue with the Federalist preview URLs and relative links and assets. Gatsby solves this by using a `pathPrefix` variable in `gastby-config.js` and a custom component named `Link`.

DSchau · 2019-02-05T19:29:30Z

docs/blog/2019-02-06-government-open-data-site-with-gatsby/index.md

+
+  let path = window.location.pathname
+
+  if (path.includes("/explore") && usStateIds.includes(statePathId)) {


Just a note that this snippet is a little confusing. I'm presuming usStateIds is somewhere above the scope of this function?

Maybe just hard code an array for now?

It's code fenced isn't it? I'm not sure why Jeff chose this particular snippet of code to represent this work around. I'm hesitant to change it, since we published it this way on our blog already.

I don't really see what code fencing has to do with this?

I mean that usStateIds and statePathId are not in the scope of this snippet, so it's harder to follow.

I see...I thought you meant the actual logic wouldn't work!

I guess I could link to the full code here as a compromise?

Yeah! That would be great!

The idea comes across, you're basically extending the internal loader to be aware of additional paths, but I can see how it could be confusing when it's broken out of context like this!

I see...that's an array of all 50 states and DC, so it would have taken up some serious screen real estate. I added a link to the repo for that one.

docs/blog/2019-02-06-government-open-data-site-with-gatsby/index.md

DSchau · 2019-02-05T19:33:04Z

docs/blog/2019-02-06-government-open-data-site-with-gatsby/index.md

+
+#### Page URL issue
+
+When Gatsby builds the site, it creates a `public` directory for all required site assets. We copied this directory to a `gatsby-public` folder for the Jekyll build to use. However, we didn't want our URLs to include `gatsby-public`, so we needed to add a permalink attribute to our pages' front matter to override the default path.


General question - why not use the other approach (which seems simpler?) of just re-using the public folder for the Jekyll build?

Guessing you want a clear way to avoid possible duplicates or one build process conflicting with the other? Where is the Jekyll build in gatsby-public?

Also - this is just a question out of curiosity, not a blocker for this PR at all!

I'll see if @master12 wants to reply to this one. :)

DSchau · 2019-02-05T19:35:21Z

docs/blog/2019-02-06-government-open-data-site-with-gatsby/index.md

+
+## Challenges during rebuild
+
+While our experience refactoring the homepage was largely positive, we have faced some challenges migrating to Gatsby. Some of those challenges are inherent in refactoring, caused by maintaining two codebases and build processes simultaneously. Others are perhaps due to the relatively new emergence of Gatsby itself, which is actively being worked on and upgraded.


Gatsby isn't really all that new! We'd love any feedback on areas we can improve upon, here re: challenges you faced.

We are experiencing relatively long build times, @DSchau. Part of the reason is that we're still compiling two separate codebases, but the build time increased a lot when we expanded our graphql schema. We hope eliminating the Jekyll build, and upgrading our Gatsby version, will help mitigate this problem, but we're more than happy to hear tips from Gatsby folks on how we might improve the build.

…ex.md Co-Authored-By: brentryanjohnson <32855580+brentryanjohnson@users.noreply.github.com>

…hnson/gatsby into gov-gatsby-blog-post

brentryanjohnson · 2019-02-05T22:10:36Z

@DSchau I pushed additional commits with the changes you suggested. Let me know if I missed anything...I left the directory name change to you, because I thought that might be easier on your end.

DSchau · 2019-02-05T22:13:20Z

@brentryanjohnson thanks so much! Made that change. I'll give this another once-over, and if it looks good to go I'll just merge.

We have some tooling in place, so we can merge future posts, and they'll just go live when the build date is the date of the post!

brentryanjohnson · 2019-02-05T22:16:21Z

Nice! Thank you for the opportunity to share our experience using Gatsby in the federal government. And we're always happy to hear what we could be doing better.

brentryanjohnson · 2019-02-05T22:41:43Z

I resolved that merge conflict and removed Jeff's entry from authors.yml since we removed him from the author front matter @DSchau.

DSchau

Merging. This should go live this Friday; thanks!

gatsbot · 2019-02-06T21:05:26Z

Holy buckets, @brentryanjohnson — we just merged your PR to Gatsby! 💪💜

Gatsby is built by awesome people like you. Let us say “thanks” in two ways:

We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. (Currently we’ve got a couple t-shirts available, plus some socks that are really razzing our berries right now.)
We just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. Accept the invite by visiting https://github.com/orgs/gatsbyjs/invitation. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again!

brentryanjohnson and others added 3 commits February 4, 2019 23:33

Merge pull request #1 from gatsbyjs/master

a5c3177

merge in recent commits

Adds post about government agency transition from jekyll to gatsby

5bf523e

Edits publish date and opening sentence

488b8d5

brentryanjohnson requested a review from a team February 5, 2019 07:57

DSchau changed the title ~~Blog post submission~~ feat(blog): add post for office of natural resources Feb 5, 2019

DSchau reviewed Feb 5, 2019

View reviewed changes

DSchau and others added 4 commits February 5, 2019 13:08

Update docs/blog/2019-02-06-government-open-data-site-with-gatsby/ind…

606c7e3

…ex.md Co-Authored-By: brentryanjohnson <32855580+brentryanjohnson@users.noreply.github.com>

Round of edits requested via gatsby review

e4f3da7

Merge branch 'gov-gatsby-blog-post' of https://github.com/brentryanjo…

35df0c4

…hnson/gatsby into gov-gatsby-blog-post

Adds link to full code so variable assignment can be found

a3683da

chore: rename post

261dbb5

Merge branch 'master' into gov-gatsby-blog-post

ebdfb17

DSchau approved these changes Feb 6, 2019

View reviewed changes

DSchau merged commit d9e2883 into gatsbyjs:master Feb 6, 2019

brentryanjohnson deleted the gov-gatsby-blog-post branch February 7, 2019 00:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(blog): add post for office of natural resources #11561

feat(blog): add post for office of natural resources #11561

brentryanjohnson commented Feb 5, 2019

DSchau left a comment

DSchau Feb 5, 2019 •

edited

brentryanjohnson Feb 5, 2019

DSchau Feb 5, 2019

brentryanjohnson Feb 5, 2019

brentryanjohnson Feb 5, 2019

DSchau Feb 5, 2019

brentryanjohnson Feb 5, 2019

DSchau Feb 5, 2019

DSchau Feb 5, 2019

brentryanjohnson Feb 5, 2019

DSchau Feb 5, 2019

brentryanjohnson Feb 5, 2019

DSchau Feb 5, 2019 •

edited

brentryanjohnson Feb 5, 2019

DSchau Feb 5, 2019

DSchau Feb 5, 2019

brentryanjohnson Feb 5, 2019

DSchau Feb 5, 2019

brentryanjohnson Feb 7, 2019

brentryanjohnson commented Feb 5, 2019

DSchau commented Feb 5, 2019 •

edited

brentryanjohnson commented Feb 5, 2019

brentryanjohnson commented Feb 5, 2019

DSchau left a comment

gatsbot bot commented Feb 6, 2019


		A few months ago, our small team at the Office of Natural Resources Revenue (ONRR) decided we needed to refactor our [open-data website](https://revenuedata.doi.gov/). We knew we were in for a massive undertaking, as the site was originally built with the static-site generator [Jekyll](https://jekyllrb.com/), with significant custom coding to furnish bespoke features, automate data updates, and compile and deploy the site with [18F's](https://18f.gsa.gov/) fantastic static-site hosting service, [Federalist](https://federalist.18f.gov/).

		As covered in our [first post in this series](/homepage-revamp/), we were simultaneously scoping a redesign of our homepage. Rebuilding the homepage would allow us to test some of our assumptions about how to address obstacles in our existing workflow.


		As mentioned above, we use [Federalist](https://federalist.18f.gov/) to build and deploy the site. Federalist builds out every branch in our GitHub repository, so we can preview the changes before we merge them.

		We encountered an issue with the Federalist preview URLs and relative links and assets. Gastby solves this by using a `pathPrefix` variable in `gastby-config.js` and a custom component named `Link`.


		let path = window.location.pathname

		if (path.includes("/explore") && usStateIds.includes(statePathId)) {


		#### Page URL issue

		When Gatsby builds the site, it creates a `public` directory for all required site assets. We copied this directory to a `gatsby-public` folder for the Jekyll build to use. However, we didn't want our URLs to include `gatsby-public`, so we needed to add a permalink attribute to our pages' front matter to override the default path.


		## Challenges during rebuild

		While our experience refactoring the homepage was largely positive, we have faced some challenges migrating to Gatsby. Some of those challenges are inherent in refactoring, caused by maintaining two codebases and build processes simultaneously. Others are perhaps due to the relatively new emergence of Gatsby itself, which is actively being worked on and upgraded.

feat(blog): add post for office of natural resources #11561

feat(blog): add post for office of natural resources #11561

Conversation

brentryanjohnson commented Feb 5, 2019

DSchau left a comment

Choose a reason for hiding this comment

DSchau Feb 5, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DSchau Feb 5, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brentryanjohnson commented Feb 5, 2019

DSchau commented Feb 5, 2019 • edited

brentryanjohnson commented Feb 5, 2019

brentryanjohnson commented Feb 5, 2019

DSchau left a comment

Choose a reason for hiding this comment

gatsbot bot commented Feb 6, 2019

DSchau Feb 5, 2019 •

edited

DSchau Feb 5, 2019 •

edited

DSchau commented Feb 5, 2019 •

edited