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.

Sign up for GitHub

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

Jump to bottom

docs: Update bootstrap sequence #19775

Merged
merged 8 commits into from
Jan 30, 2020
Merged

docs: Update bootstrap sequence #19775

merged 8 commits into from
Jan 30, 2020

Conversation

alexlobera
Copy link
Contributor

@alexlobera alexlobera commented Nov 25, 2019 •
edited by sidharthachatterjee

Description

  • Removes some of the links to Gatsby source code as requested
  • Updates the sequence with missing steps. I'm not sure I explained too much. I found it useful to know those.
  • In the previous "Bootstrap sequence" there were two lists: 1) During "bootstrap" Gatsby, 2) The sequence of the main bootstrap Node API lifecycles. I've merged both lists into one so the "Bootstrap sequence" contains only one list so it's easier to understand the sequence. The Node API lifecycles are hyperlinks so it's easy to spot them in the list in case readers only want to know the " The sequence of the main bootstrap Node API lifecycles"

Addresses Issues

#9350

@alexlobera alexlobera requested a review from a team as a code owner November 25, 2019 12:19
@alexlobera alexlobera mentioned this pull request Nov 25, 2019
Closed
@LekoArts LekoArts added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Nov 26, 2019
@alexlobera
Copy link
Contributor Author

I've run the job twice on CircleCI and got two different errors, I'm not sure what the problem is 🤔. Any help, please?

@laurieontech
Copy link
Contributor

Hey @alexlbr, there is a dependency vulnerability that's causing that test to fail. It's not from your code and our team is on it!

@laurieontech
Copy link
Contributor

Thanks for the PR! Looks great. Going to get a couple other eyes on this to double check all in the info. But super excited for this one!

@sidharthachatterjee sidharthachatterjee self-assigned this Nov 26, 2019
@LekoArts LekoArts requested a review from a team January 13, 2020 13:42
@LekoArts LekoArts added the status: awaiting reviewer response A pull request that is currently awaiting a reviewer's response label Jan 13, 2020
@marcysutton marcysutton added this to In progress in Documentation Roadmap via automation Jan 17, 2020
@marcysutton marcysutton moved this from In progress to PRs for Review in Documentation Roadmap Jan 17, 2020
m-allanson
m-allanson previously requested changes Jan 17, 2020
View reviewed changes
Copy link
Contributor

@m-allanson m-allanson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @alexlbr this looks great! I added one suggestion based on a recent change in Gatsby.

@sidharthachatterjee sidharthachatterjee removed the status: awaiting reviewer response A pull request that is currently awaiting a reviewer's response label Jan 17, 2020
@sidharthachatterjee sidharthachatterjee removed their assignment Jan 17, 2020
sidharthachatterjee
sidharthachatterjee suggested changes Jan 17, 2020
View reviewed changes
Copy link
Contributor

@sidharthachatterjee sidharthachatterjee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for this @alexlbr

Left a couple of comments!

docs/docs/gatsby-lifecycle-apis.md Outdated Show resolved Hide resolved
docs/docs/gatsby-lifecycle-apis.md Outdated Show resolved Hide resolved
docs/docs/gatsby-lifecycle-apis.md Outdated
- reads and validates `gatsby-config.js` to load in your list of plugins (it doesn't run them yet).
- deletes HTML and CSS files from the previous build (public folder)
- initializes its cache (stored in `/.cache`) and checks if any plugins have been updated since the last run, if so it deletes the cache
- runs the plugins
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

runs gatsby-node

Suggested change
- runs the plugins
- sets up `gatsby-browser` and `gatsby-ssr` for plugins that have them

docs/docs/gatsby-lifecycle-apis.md Outdated Show resolved Hide resolved
docs/docs/gatsby-lifecycle-apis.md Outdated Show resolved Hide resolved
docs/docs/gatsby-lifecycle-apis.md Outdated Show resolved Hide resolved
docs/docs/gatsby-lifecycle-apis.md Outdated
- runs source nodes again and it updates the GraphQL schema since pages can include queries to other data. Notice this is the second time source nodes run due to a "chicken and the egg problem". We need the pages to extract the queries but we need to create the schema first which requires to source nodes
- runs [onPreExtractQueries](/docs/node-apis/#onPreExtractQueries) e.g. implemented by [`gatsby-transformer-sharp`](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-transformer-sharp/src/gatsby-node.js) and [`gatsby-source-contentful`](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-source-contentful/src/gatsby-node.js), and extracts queries from pages and components (`StaticQuery`)
- compiles queries using a Relay compiler and creates the AST
- applies validation rules in the schema
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- applies validation rules in the schema
- runs query validation based on schema

docs/docs/gatsby-lifecycle-apis.md Outdated Show resolved Hide resolved
docs/docs/gatsby-lifecycle-apis.md Outdated Show resolved Hide resolved
docs/docs/gatsby-lifecycle-apis.md Outdated Show resolved Hide resolved
@laurieontech laurieontech added the status: awaiting author response Additional information has been requested from the author label Jan 27, 2020
@laurieontech laurieontech removed this from PRs for Review in Documentation Roadmap Jan 27, 2020
@alexlobera
Copy link
Contributor Author

@sidharthachatterjee, @m-allanson, @laurieontech thanks a lot for all the feedback. I've updated the PR with your comments. Sorry that it took a bit to come back to this PR. Thanks a lot again!

@sidharthachatterjee sidharthachatterjee removed the status: awaiting author response Additional information has been requested from the author label Jan 30, 2020
@sidharthachatterjee
Copy link
Contributor

Thank you so much for writing this up @alexlbr 🥇

@sidharthachatterjee sidharthachatterjee added the bot: merge on green Gatsbot will merge these PRs automatically when all tests passes label Jan 30, 2020
@gatsbybot gatsbybot merged commit 98cf042 into gatsbyjs:master Jan 30, 2020
@gatsbot
Copy link

gatsbot bot commented Jan 30, 2020

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

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

  1. 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. We’ve got Gatsby t-shirts, stickers, hats, scrunchies, and much more. (You can also unlock even more free swag with 5 contributions — wink wink nudge nudge.) See gatsby.dev/swag for details.
  2. 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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@laurieontech laurieontech laurieontech left review comments

@sidharthachatterjee sidharthachatterjee sidharthachatterjee approved these changes

@m-allanson m-allanson Awaiting requested review from m-allanson

Assignees
No one assigned
Labels
bot: merge on green Gatsbot will merge these PRs automatically when all tests passes type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@alexlobera @laurieontech @sidharthachatterjee @m-allanson @LekoArts @gatsbybot