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 documentation for createRemoteFileNode #4330

Merged
merged 3 commits into from
Mar 2, 2018

Conversation

ajayns
Copy link
Contributor

@ajayns ajayns commented Mar 2, 2018

Addresses #4302

I've added rough documentation for createRemoteFileNode. As you can see it's still needs a lot of improvement. Any guidance would be appreciated.

What's to be added/improved:

  • Add better descriptions for what each parameter of createRemoteFileNode does. For instance the store and cache that's passed in.
  • Add a hint on what node.localFile___NODE = fileNode.id does
  • Write a bit about how these File nodes can be queried in GraphQL in the end of doc.

@m-allanson @KyleAMathews @pieh

@ajayns
Copy link
Contributor Author

ajayns commented Mar 2, 2018

I realize the indentation is a bit messed up, I'll fix that as well in the next commit.

@gatsbybot
Copy link
Collaborator

gatsbybot commented Mar 2, 2018

Deploy preview for gatsbygram ready!

Built with commit e63a358

https://deploy-preview-4330--gatsbygram.netlify.com

@KyleAMathews
Copy link
Contributor

Looks good from a quick pass over! Lemme know when you've fixed things to your satisfaction.

@ajayns
Copy link
Contributor Author

ajayns commented Mar 2, 2018

@KyleAMathews I've patched up whatever I could think of from whatever I know; do make suggestions if any, else I guess it can be merged.

@ghost ghost assigned KyleAMathews Mar 2, 2018
@ghost ghost added the review label Mar 2, 2018
@KyleAMathews KyleAMathews merged commit 56b88fe into gatsbyjs:master Mar 2, 2018
@ghost ghost removed the review label Mar 2, 2018
@KyleAMathews
Copy link
Contributor

Thanks! Made a few more tweaks. Glad to have this documented!

@ajayns ajayns deleted the docs-remotefilenode branch March 2, 2018 20:55
@ajayns
Copy link
Contributor Author

ajayns commented Mar 2, 2018

Glad to contribute, also it looks great now! Thanks @KyleAMathews

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants