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

[v2] Update docs to cover breaking changes in v2 #5853

Closed
m-allanson opened this issue Jun 12, 2018 · 1 comment · Fixed by #7481
Closed

[v2] Update docs to cover breaking changes in v2 #5853

m-allanson opened this issue Jun 12, 2018 · 1 comment · Fixed by #7481
Assignees
@kkemple
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@m-allanson
Copy link
Contributor

m-allanson commented Jun 12, 2018 •
edited
Loading

Summary

Now that the v2 API's have mostly settled down, make a pass through Gatsby's docs and update them to reference the correct parts of Gatsby's API for v2.

Remove references to layouts, add mentions of StaticQuery. Document pageContext (previously pathContext, but it doesn't seem like there's any docs for that).

Basic example

The Querying with GraphQL doc:

  • doesn't mention StaticQuery, which it should
  • does mention Layouts, which it shouldn't

Motivation

Docs should be in sync with API updates.
@m-allanson m-allanson added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Jun 12, 2018
@fk
Copy link
Contributor

fk commented Jul 2, 2018 •
edited
Loading

Let's see if I'll do this right…

The Actions doc:

  • does still mention boundActionCreators, not sure if this should be actions

@m-allanson m-allanson mentioned this issue Jul 31, 2018
Merged
@shannonbux shannonbux changed the title [v2] Docs update [v2] Update docs to cover breaking changes in v2 Aug 3, 2018
@kkemple kkemple self-assigned this Aug 14, 2018
@kkemple kkemple mentioned this issue Aug 20, 2018
Merged
jlengstorf pushed a commit that referenced this issue Aug 20, 2018
@kkemple @jlengstorf
docs: update docs with v2 compatible examples (#7481)
f0ba07b 
<!--
  Q. Which branch should I use for my pull request?
  A. Use `master` branch (probably).

  Q. Which branch if my change is an update to Gatsby v2?
  A. Definitely use `master` branch :)

  Q. Which branch if my change is an update to documentation or gatsbyjs.org?
  A. Use `master` branch. A Gatsby maintainer will copy your changes over to the `v1` branch for you

  Q. Which branch if my change is a bug fix for Gatsby v1?
  A. In this case, you should use the `v1` branch

  Q. Which branch if I'm still not sure?
  A. Use `master` branch. Ask in the PR if you're not sure and a Gatsby maintainer will be happy to help :)

  Note: We will only accept bug fixes for Gatsby v1. New features should be added to Gatsby v2.

  Learn more about contributing: https://www.gatsbyjs.org/docs/how-to-contribute/
-->
Took a last pass through docs and READMEs looking for examples and docs that make references to v1 APIs and updating them to v2 APIs

Closes #5853
porfirioribeiro pushed a commit to porfirioribeiro/gatsby that referenced this issue Aug 22, 2018
@kkemple @porfirioribeiro
docs: update docs with v2 compatible examples (gatsbyjs#7481)
23290c6 
<!--
  Q. Which branch should I use for my pull request?
  A. Use `master` branch (probably).

  Q. Which branch if my change is an update to Gatsby v2?
  A. Definitely use `master` branch :)

  Q. Which branch if my change is an update to documentation or gatsbyjs.org?
  A. Use `master` branch. A Gatsby maintainer will copy your changes over to the `v1` branch for you

  Q. Which branch if my change is a bug fix for Gatsby v1?
  A. In this case, you should use the `v1` branch

  Q. Which branch if I'm still not sure?
  A. Use `master` branch. Ask in the PR if you're not sure and a Gatsby maintainer will be happy to help :)

  Note: We will only accept bug fixes for Gatsby v1. New features should be added to Gatsby v2.

  Learn more about contributing: https://www.gatsbyjs.org/docs/how-to-contribute/
-->
Took a last pass through docs and READMEs looking for examples and docs that make references to v1 APIs and updating them to v2 APIs

Closes gatsbyjs#5853
mwfrost pushed a commit to mwfrost/gatsby that referenced this issue Apr 20, 2023
@kkemple @jlengstorf
docs: update docs with v2 compatible examples (gatsbyjs#7481)
61e972b 
<!--
  Q. Which branch should I use for my pull request?
  A. Use `master` branch (probably).

  Q. Which branch if my change is an update to Gatsby v2?
  A. Definitely use `master` branch :)

  Q. Which branch if my change is an update to documentation or gatsbyjs.org?
  A. Use `master` branch. A Gatsby maintainer will copy your changes over to the `v1` branch for you

  Q. Which branch if my change is a bug fix for Gatsby v1?
  A. In this case, you should use the `v1` branch

  Q. Which branch if I'm still not sure?
  A. Use `master` branch. Ask in the PR if you're not sure and a Gatsby maintainer will be happy to help :)

  Note: We will only accept bug fixes for Gatsby v1. New features should be added to Gatsby v2.

  Learn more about contributing: https://www.gatsbyjs.org/docs/how-to-contribute/
-->
Took a last pass through docs and READMEs looking for examples and docs that make references to v1 APIs and updating them to v2 APIs

Closes gatsbyjs#5853
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kkemple kkemple

Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update docs with v2 compatible examples gatsbyjs/gatsby
3 participants
@fk @m-allanson @kkemple