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

No documentation found or referred to in tutorials for createFilePath #4028

Closed
ajayns opened this issue Feb 14, 2018 · 4 comments
Closed

No documentation found or referred to in tutorials for createFilePath #4028

ajayns opened this issue Feb 14, 2018 · 4 comments
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@ajayns
Copy link
Contributor

ajayns commented Feb 14, 2018

Description

While going through tutorial 4, there seem to a couple of functions which seem to be just appear and do things magically. No links or documentation could be found for details on how node, getNode, createFilePath works.

Only documentation I could find was for gatsby-source-filesystem

@m-allanson m-allanson added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Feb 14, 2018
@m-allanson
Copy link
Contributor

Thanks for raising this @ajayns, I agree it's not very clear where they're coming from.

You're right that createFilePath comes from gatsby-source-filesystem, it could do with being documented.

A node object is the basis of how Gatsby structures its data, there's a bit more info about nodes on the Node Interface docs page.

It looks like getNode() is commonly used by plugins, but I can't see any docs on it. There's actually a lot more data that gets passed to the API methods like onCreateNode.

How should we document node, getNode and the other data that gets passed to the API methods? Should there be an in-depth page in the Reference section that covers a bit more about how Gatsby works internally?

@ajayns
Copy link
Contributor Author

ajayns commented Feb 14, 2018

To get started with, the Node Interface docs page can be mentioned in the section where nodes come in tutorial 4, this would help guide people who wanna know a bit in depth of how it works in the back.

Further more, you're right getNode() is commonly used by these plugins and there are no docs. This wouldn't really affect a person who's building projects on GatsbyJS but then for developers working on plugins, this could be a matter of importance. I haven't gotten into developing plugins myself right now, so I can't exactly say, but, a Reference section would really help if it explained a bit of how everything goes together without being verbose. @m-allanson

@KyleAMathews
Copy link
Contributor

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!

@selrond
Copy link
Contributor

selrond commented Jan 14, 2019

@ajayns just stumbled upon createFilePath, and haven't found any docs for it - any updates?

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

No branches or pull requests

4 participants