docs: guide on troubleshooting common errors #19966
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gillkyle
added
the
type: documentation
muescha
reviewed
Dec 6, 2019
muescha
reviewed
Dec 6, 2019
Co-Authored-By: Michael <[email protected]>
laurieontech
reviewed
Dec 6, 2019
There was a problem hiding this comment.
This is awesome @gillkyle! Added some minor comments and edits.
Off the top of my head I'm thinking of some GraphQL query errors that we may want to add. They're mostly related to not having the file system plugin set up for the right directory in your project so Gatsby can't see the files you're trying to query. I'll track down the actual phrasing and add that here.
gillkyle
commented
Dec 9, 2019
gillkyle
commented
Dec 9, 2019
gillkyle
commented
Dec 9, 2019
gillkyle
commented
Dec 9, 2019
Closed
25 tasks
AishaBlake
suggested changes
Dec 11, 2019
|
|
||
| ## Errors building and deploying | ||
|
|
||
| The process of building your site [varies slightly from the development process](/docs/overview-of-the-gatsby-build-process/). Some errors can arise when you build your site if |
There was a problem hiding this comment.
You'll want to finish this sentence. I'm not quite sure where it was going but it sounds important. 😄
Co-Authored-By: Aisha Blake <[email protected]>
AishaBlake
approved these changes
Dec 12, 2019
|
|
||
| Another possibility is that empty strings are used for image paths somewhere in your site, and when Gatsby constructs a GraphQL schema it [infers](/docs/glossary#inference) the wrong type because the empty string doesn't look like a path. | ||
| Another possibility that could cause this issue is from empty strings used for image paths somewhere in your site. If this is the case, when Gatsby constructs a GraphQL schema it may [infer](/docs/glossary#inference) the wrong type because the empty string doesn't look like a file path. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a reference guide to the section in the docs on "Debugging Gatsby".
I did a lot of Googling and used a search on GitHub to get the most 👍 (+1'd) comments in the Gatsby repo in DESC order. From there I tried to identify errors that people seemed to hit frequently that weren't real bugs (ie errors in Gatsby that need to be fixed) or things not supported yet (like adding variables to static queries).
I came up with a pretty short list and figured I could open up this PR to see if anyone else had suggestions and/or references for other commonly encountered errors. These are what are covered:
gatsby cleanField "image" must not have a selection since type "String" has no subfieldswindowIn my opinion, this guide shouldn't be an alternative to stackoverflow or the issues tab. I think it does open up discussion about additional ways Gatsby can help guide users through these problems (one I thought of was would a potential
gatsby-plugin-imagelibrary package upgatsby-plugin-sharpgatsby-transformer-sharpso that people don't include them in the wrong order and ease that installation and configuration process?).Documentation
There are some existing mentions of errors described and outlined in what I wrote up elsewhere in the docs and in plugin READMEs. I think an advantage of this doc is centralizing some common gotchas from those peripheral locations but providing links out to the guides that might have even more context.
Related Issues
Related to #19196