Fill out "Sourcing from the filesystem" stub article #8777
Conversation
There was a problem hiding this comment.
Hi! Thanks for getting started on this. It looks like the issue accidentally linked to the wrong tutorial section -- the section of tutorial copied over in this PR is about transforming markdown files (files that have already been sourced from the filesystem) This doc needs to address sourcing from the filesystem (I think this section of the tutorial is more related: https://www.gatsbyjs.org/tutorial/part-five/#source-plugins). Really sorry for that confusion!
I'd suggest the following steps:
- Read through the tutorial part five to see what might make sense to pull over.
- Start drafting the "Sourcing from the filesystem article" by coming up with the sections that make sense. Perhaps reference this recently merged doc: https://www.gatsbyjs.org/docs/sourcing-from-wordpress/.
- Within that structure, start pasting over and rewriting/repurposing the tutorial content to make sense as a doc (rather than reading as a tutorial).
- Review the additional resources listed in the issue description, to see if there's any additional detail that would make sense to pull into the doc as well.
The WordPress doc would be a great model for this effort!
|
Hi @amberleyromo, thanks for the clarification! That makes much more sense, haha. I've migrated information from the correct tutorial this time and restructured the wording to make it more like a doc. If you could take another look, that would be awesome! |
|
|
||
| This guide assumes that you have a Gatsby project set up. If you need to set up a project, please reference the [Quick Start Guide](https://github.com/gatsbyjs/gatsby/tree/master/docs). In addition, it will be useful if you are familiar with Graph_i_QL, a tool that helps you structure your queries correctly. | ||
|
|
||
| ## Introducing Graph_i_QL |
There was a problem hiding this comment.
I don't really think this section is necessary for this doc. I'll explain further in a different comment in this review.
| <p>Your browser does not support the video element.</p> | ||
| </video> | ||
|
|
||
| Here you poke around the built-in `Site` "type" and see what fields are available |
There was a problem hiding this comment.
Same thing, this makes no sense out of context of the tutorial.
| local files, etc. | ||
|
|
||
| Source plugins fetch data from their source. E.g. the filesystem source plugin | ||
| knows how to fetch data from the file system. The WordPress plugin knows how to |
There was a problem hiding this comment.
I think delete the last two sentences of this paragraph -- no need.
| } | ||
| ``` | ||
|
|
||
| Save that and restart the gatsby development server. Then open up Graph_i_QL |
There was a problem hiding this comment.
We're not doing a step by step tutorial here -- I think what we could do here is
- show an example file that gets sourced
- show how to include the plugin (already done above)
- show an example GraphiQL query (without explaining GraphiQL).
When we use a resource like GraphiQL here, we can link directly to where it's explained in other sections. For example, "Not familiar with GraphiQL? Check out this section of the tutorial that introduces it."
| "graph"). Each File object has the fields you queried for. | ||
|
|
||
|
|
||
| ## What's coming next? |
There was a problem hiding this comment.
Same thing here -- this only makes sense in the context of the tutorial.
|
Hi @caseychien! Interested in tackling these comments and closing this out? |
|
Hi @amberleyromo ! I am a bit busy with school, it would probably be best if someone else could finish cleaning up this doc |
|
@shannonbux per #8777 (comment) I cleaned up this doc further and it's ready for review / any further tweaks you wish! |
|
Holy buckets, @caseychien — we just merged your PR to Gatsby! 💪💜 Gatsby is built by awesome people like you. Let us say “thanks” in two ways:
If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’. Thanks again! |
|
closes #8730 |
This issue (gatsbyjs#8730) is part of the content migration project [gatsbyjs#8103](gatsbyjs#8103), which is meant to take existing content and repurpose it so it's easier to find in the docs.
This issue (#8730) is part of the content migration project #8103, which is meant to take existing content and repurpose it so it's easier to find in the docs.