Gatsby: Write better documentation for loading remote images in source plugins (createRemoteFileNode)

Created on 28 Jul 2018  路  6Comments  路  Source: gatsbyjs/gatsby

A common problem we've been seeing for people creating source plugins is that it's really hard to find information about how to pull in remote images for use with gatsby-image, etc.

The only docs on it now are tucked away in gatsby-source-filesystem. We should create an additional section in the main docs on how to do this. (Really, we need a whole tutorial on writing source plugins in the docs, but we can start here.)

help wanted documentation

All 6 comments

@alexluong wrote up this tutorial, which could lay a great foundation for these docs.

@jlengstorf We already have a tutorial for writing source plugins. I think you're the one who wrote it (gatbsy-source-pixabay). Maybe we can just update it with createRemoteFileNode to use with gatsby-image?

There's also a (nearly hidden) link to a create a source plugin page tucked away near the bottom of that tutorial.

This is actually something I've noticed a few times when using the v2 docs: There are a few things that aren't easily found without scanning thru another page, and they probably need a link from the docs menu for ease of access. (An example that comes to mind is the list of starters.)

Due to the high volume of issues, we're closing out older ones without recent activity. Please open a new issue if you need help!

Also in v2, the various plugin writing docs are all now in the same group 馃帀

This is also a great article: Wrangling remote images with Gatsby

Was this page helpful?
0 / 5 - 0 ratings

Related issues

totsteps picture totsteps  路  3Comments

magicly picture magicly  路  3Comments

ferMartz picture ferMartz  路  3Comments

timbrandin picture timbrandin  路  3Comments

jimfilippou picture jimfilippou  路  3Comments