-
Notifications
You must be signed in to change notification settings - Fork 10.3k
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
Part of #7284 --- just dropping in the note #7397
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @moxiegirl!
@amberleyromo can you confirm that the details are technically accurate as well?
docs/tutorial/part-four/index.md
Outdated
Why use two different queries here? These examples were quick introductions to | ||
the query types, how they are formatted, and where they can be used. Just remember, | ||
only pages can make page queries and non-page components, like Layout, can use | ||
StaticQuery. In part 7 the tutorial explains these in more depth. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you rewrite this to say: "non-page components. For example, Layout can use StaticQuery. Part 7 of the tutorial explains this concept in greater depth."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That actually splits up the sentence kind of oddly, imo. I would personally edit to a hybrid of the two:
Why use two different methods to query here? For now, keep in mind that only page components can make page queries (using the
graphql
tag), and non-page components use StaticQuery instead. Part seven of the tutorial explains this concept in greater depth.
In talking about the two different methods I try to pattern it with "page components" and "non-page components" for clarity.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also @moxiegirl I apologize for the tardy response, I missed this notification!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My impression was the whole preceding section is a taster for something to be detailed later thus requiring a short note to point this fact out. @shannonbux that is why I used a simple parenthetical phrase rather than drawing out the topic into its own sentence.
No worries @amberleyromo I know y'all are trying to get a release out. Your rewrite retains the question which isn't answered by the subsequent sentence. The paragraph probably needs to answer the opening question to be logical. IMO, the question is necessary because why did the writer use so much space on the query topic if the information wasn't important.
Anecdotal: I recall the first time I walked through this tutorial as a new Gatsby user wondering why I was put through all this work only to throw it away by reverting the work. The balance was off.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, what about this then:
Why use two different methods to query here? These examples were quick introductions to the query types, how they are formatted, and where they can be used. For now, keep in mind that only page components can make page queries (using the graphql tag), and non-page components use StaticQuery instead. Part seven of the tutorial explains this concept in greater depth.
fc4ca3e
to
2116fff
Compare
It looks like this is not going to merge. It is small...you ok with me closing it? |
Hey @moxiegirl -- Apologies, this just fell off my radar. Can you just add a link on "part 7 the tutorial" to |
Also added in some language from a quick review. Signed-off-by: moxiegirl <[email protected]>
Signed-off-by: moxiegirl <[email protected]>
@amberleyromo this last commit has the requested link. Apologies for the delayed response. |
* Part of gatsbyjs#7204 Also added in some language from a quick review. Signed-off-by: moxiegirl <[email protected]> * Responding to @amberleyromo comment Signed-off-by: moxiegirl <[email protected]> * tweaks
Entering the note mentioned in #7284