Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] add doc on "Life and Times of a Gatsby Build" #14937

Closed
marcysutton opened this issue Jun 19, 2019 · 2 comments
Closed

[docs] add doc on "Life and Times of a Gatsby Build" #14937

marcysutton opened this issue Jun 19, 2019 · 2 comments
Assignees
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@marcysutton
Copy link
Contributor

marcysutton commented Jun 19, 2019

Summary

Through feedback provided on gatsbyjs.org, it has become clear that the stub article on Life and Times of a Gatsby Build is an important one that needs filling out to explain Gatsby concepts: https://www.gatsbyjs.org/docs/life-and-times-of-a-gatsby-build/

"This is possibly the most important page and it's empty!"

This page is a stub in the Conceptual Guide section, and would be a great opportunity to clarify what happens at build time vs. runtime. I couldn't find a GitHub issue for it, so I created this one to capture it as something we need.

There was a related question about the doc on Client Data Fetching, which assumes a lot of knowledge about build time vs. runtime processes. A dedicated doc on this would be very helpful, and this seems like a good one.

@marcysutton marcysutton added help wanted Issue with a clear description that the community can help with. effort: med labels Jun 19, 2019
@marcysutton marcysutton added this to To prioritize in Documentation Roadmap via automation Jun 19, 2019
@gatsbot gatsbot bot added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Jun 19, 2019
@marcysutton marcysutton moved this from To prioritize to Parking lot in Documentation Roadmap Jun 20, 2019
@marcysutton marcysutton moved this from Parking lot to To prioritize in Documentation Roadmap Jun 20, 2019
@m-allanson m-allanson added this to To prioritize in OSS Roadmap via automation Jul 9, 2019
@marcysutton marcysutton moved this from To prioritize to Backlog in Documentation Roadmap Jul 25, 2019
@m-allanson
Copy link
Contributor

I made a start on this, but didn't get to the main "what's actually happening" section. Posting here in case someone else gets to this before me.


Life and Times of a Gatsby Build

Building with Gatsby

Gatsby is a framework for creating web sites and web apps. As part of creating your site you’ll provide Gatsby with the code, configuration and data it needs to output a speedy, optimised site.

When working with Gatsby it has two modes. You can start gatsby in either mode by running gatsby develop or gatsby build.

gatsby develop

Gatsby develop is optimised for rapid feedback and extra debugging information.

Using gatsby develop runs a server in the background enabling useful features like hot reloading and Gatsby’s data explorer.

gatsby build

You’ve added the finishing touches to your site and everything looks great. What now? This is where the build step comes in. Run gatsby build to create a version of your site with

will package up your site’s config, data, and code then optimise the heck out of it, and finally

What happens when you run gatsby build

This is a high-level overview. For more detailed information, check TODO, TODO, TODO.

@alexluong
Copy link
Contributor

I happened to write a blog post covering this topic. It's a bit more anecdotal as I describes what's going on with codes, but I think some part of it can be recycled to a documentation page.

If you're interested, you can find it here.

Would love to hear your thoughts on it and hope that it helps writing this doc!

@marcysutton marcysutton removed the help wanted Issue with a clear description that the community can help with. label Aug 2, 2019
@gillkyle gillkyle moved this from Backlog to In progress in Documentation Roadmap Sep 24, 2019
@gillkyle gillkyle closed this as completed Oct 3, 2019
OSS Roadmap automation moved this from To prioritize to Done Oct 3, 2019
Documentation Roadmap automation moved this from In progress to Done Oct 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
No open projects
Development

No branches or pull requests

8 participants