docs: graphql api page and other incremental improvements #17516
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Conflicts: # www/src/data/sidebars/doc-links.yaml
gillkyle
commented
Sep 9, 2019
LekoArts
added
the
type: documentation
LekoArts
suggested changes
Sep 16, 2019
marcysutton
suggested changes
Sep 16, 2019
marcysutton
suggested changes
Sep 20, 2019
There was a problem hiding this comment.
this is amazing! I left a few small suggestions. It's super close. Thank you so much for your work on this, @gillkyle!
Co-Authored-By: Marcy Sutton <[email protected]>
gillkyle
added
the
status: awaiting reviewer response
marcysutton
reviewed
Sep 20, 2019
Co-Authored-By: Marcy Sutton <[email protected]>
marcysutton
approved these changes
Sep 23, 2019
gillkyle
added
bot: merge on green
LekoArts
approved these changes
Sep 24, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Initial improvements to the Gatsby GraphQL API's, mostly around querying and using image fragments.
The changes in this PR are to help make GraphQL content easier for people new to Gatsby to grok and discover. Some docs had names that weren't explicit as to their purpose and made finding the page with relevant information difficult. An example of this was the "GraphQL Reference" and "Introducing GraphiQL" docs which were updated to "GraphQL Query Options Reference" and "Running Queries with GraphiQL" respectively.
A GraphQL API page was added to the Gatsby API section to serve as a holistic foundation for GraphQL uses in Gatsby like sourcing data, querying data, using fragments, and linking to guides on advanced uses like schema customization. This page still has plenty to add to it, particularly with querying options like
sort,filter, etc as outlined in #15231GraphQL API page
This doesn't resolve all updates to the GraphQL workflow but is a start 👍
Related Issues
Partially addresses points in:
#16981
#15231