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

fix(docs): add note for exception when using gatsby-source-contentful #15926

Merged
merged 5 commits into from
Aug 7, 2019

Conversation

jokokoloko
Copy link
Contributor

Using gatsby-transformer-sharp along with gatsby-source-contentful, while using the default behavior of the source plugin to link to Contentful's CDN instead of downloading the assets to the to the local filesystem, results in a warning during compiling.

Description

Extended the existing note to mention that using gatsby-transformer-sharp together with gatsby-source-contentful, while using the default behavior of the source plugin to link to Contentful's CDN instead of downloading the assets to the local filesystem, results in a warning during compiling.

The gatsby-source-contentful plugin creates a ContentfulAsset node for every image with links to Contentful’s CDN while gatsby-transformer-sharp can not find any assets to generate nodes for.

The warning:

Screen Shot 2019-07-19 at 4 04 17 PM

ImageSharp nodes generated:

Screen Shot 2019-07-19 at 4 12 17 PM

Screen Shot 2019-07-19 at 4 13 11 PM

ContentfulAsset nodes generated:

Screen Shot 2019-07-19 at 4 11 18 PM

Screen Shot 2019-07-19 at 4 11 46 PM

Related Issues

https://www.gatsbyjs.org/packages/gatsby-source-contentful/#download-assets-for-static-distribution

Using gatsby-transformer-sharp along with gatsby-source-contentful, while using the default behavior of the source plugin to link to Contentful's CDN instead of downloading the assets to the to the local filesystem, results in a warning during compiling.
@jokokoloko jokokoloko requested a review from a team as a code owner July 20, 2019 10:57
@jokokoloko jokokoloko added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Jul 20, 2019
Co-Authored-By: Kitten King <53072918+kittenking@users.noreply.github.com>
gillkyle
gillkyle previously approved these changes Aug 7, 2019
Copy link
Contributor

@gillkyle gillkyle left a comment

Choose a reason for hiding this comment

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

Thanks for adding this note @jokokoloko 🙂 I moved the exception note down into the other paragraph and put a little Note tag in front of it to call it out as more of an exception.

packages/gatsby-transformer-sharp/README.md Outdated Show resolved Hide resolved
packages/gatsby-transformer-sharp/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@gillkyle gillkyle left a comment

Choose a reason for hiding this comment

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

Thanks!

@gillkyle gillkyle merged commit 810174d into master Aug 7, 2019
@gillkyle gillkyle deleted the jokokoloko-patch-1 branch August 7, 2019 22:02
m-allanson added a commit that referenced this pull request Aug 9, 2019
* master: (67 commits)
  chore(starters): add gatsby-starter-profile-site (#16433)
  Update tailwind-css.md CSS-in-JS instructions (#16443)
  fix: update dependency theme-ui to ^0.2.31 (#16436)
  chore(gatsby): Improve typings for reporter (#16441)
  docs(gatsby-remark-images): Fix description of showCaptions (#16442)
  fix(tests): Remove unreliable timeout logic from development-runtime (#16454)
  fix(docs): adds back some missing guides to sidebar (#16437)
  chore(sites): add coffee shop creative (#16447)
  Add "Using Google Fonts" recipe to Style section (#15911)
  fix(docs): add note for exception when using gatsby-source-con… (#15926)
  chore(starters): Update username in starter entry (#16413)
  chore(docs): added note about shorter titles and breadcrumbTit… (#16438)
  feat(blog): Theme Jam wrap-up post (#16440)
  docs(gatsby-plugin-layout): fix bracket typos (#16418)
  docs: fix minor grammar in remark plugin tutorial (#16435)
  feat(gatsby-remark-primsjs): Support overriding prompt user/host. (#16421)
  docs(themes): Wrong file name in building theme docs (#16430)
  chore(showcase): Add QuantumBlack (#16426)
  blog(www): Gazette August Edition (#16404)
  chore(docs): add note for app shell and its meaning in server logs (#16423)
  ...
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
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants