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

Add gatsby-plugin-layout docs to v2 migration post #5753

Closed
m-allanson opened this issue Jun 6, 2018 · 6 comments
Closed

Add gatsby-plugin-layout docs to v2 migration post #5753

m-allanson opened this issue Jun 6, 2018 · 6 comments
Assignees
Labels
help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@m-allanson
Copy link
Contributor

Summary

There's a Gatsby v1 to v2 migration guide which covers breaking changes in v2.

It doesn't have any information about useful techniques for upgrading larger sites, particularly how to convert layouts. See related discussions below:

Refs: #5575 (review)
Refs: #3986 (comment)

Motivation

Upgrading to v2 should be straightforward for all Gatsby sites, large or small.

@m-allanson m-allanson added help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation labels Jun 6, 2018
@shannonbux
Copy link
Contributor

@amberleyromo in case this looks interesting!

@m-allanson
Copy link
Contributor Author

Let's handle this with a new gatsby-plugin-layout plugin

@jlengstorf
Copy link
Contributor

@m-allanson is there an issue for gatsby-plugin-layout? Or is this it?

@m-allanson
Copy link
Contributor Author

The layout plugin will be added in #7204

@jlengstorf jlengstorf changed the title Update v2 migration docs with examples for larger sites Add gatsby-plugin-layout docs to v2 migration post Aug 20, 2018
@jlengstorf jlengstorf assigned kkemple and jlengstorf and unassigned kkemple Aug 20, 2018
@pieh
Copy link
Contributor

pieh commented Aug 20, 2018

There is one-liner in second bullet point in removal layouts section in migration guide - https://next.gatsbyjs.org/docs/migrating-from-v1-to-v2/#remove-or-refactor-layout-components which links to https://www.gatsbyjs.org/packages/gatsby-plugin-layout/ .

It would also be useful for this information to be available outside of migration guide, just not sure what's the best place for it.

@jlengstorf
Copy link
Contributor

I'm closing this for now, because we don't really have a clear goal for how to write this out. It kind of seems like it could support a few narratives, e.g. "how to do page transitions" or "how to prevent component rerenders", but for now the scope of this issue is complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

5 participants