docs: Fix NextJS and Gatsby sections on using a GraphQL IDE #1445
Conversation
Only Gatsby provides GraphiQL to explore the API via http://localhost:8000/__graphql. Our NextJS starter doesn't provide something similar, so the section about the using GraphQL Playground is more suitable to it. The section names were inverted.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 6b17ce5:
|
But are GraphQL IDEs, but different ones at that.
GraphiQL is just for Gatsby so it doesn't make sense to single it out.
| # Using GraphiQL to explore the FastStore API | ||
| # Using a GraphQL IDE to explore the FastStore API | ||
|
|
||
| [GraphiQL](https://github.com/graphql/graphiql) is an Integrated Development Environment (IDE) for [GraphQL](https://graphql.org/). You can run GraphiQL on your browser to try out queries and mutations in a GraphQL API. | ||
| [GraphiQL](https://github.com/graphql/graphiql) and [GraphQL Playground](https://github.com/graphql/graphql-playground) are an Integrated Development Environment (IDE) for [GraphQL](https://graphql.org/). You can run them on your browser to try out queries and mutations in a GraphQL API. | ||
|
|
||
| You can explore your store's GraphQL data layer by running a local server of your project. | ||
|
|
||
| ## Getting started | ||
|
|
||
| The first steps to getting GraphiQL up and running are different depending on the framework you are using on your project: | ||
| The first steps to getting them up and running are different depending on the framework you are using on your project: |
There was a problem hiding this comment.
Here's more of a suggestion of being more general using "GraphQL IDE" instead of "GraphiQL" because the latter is only used in Gatsby.
Not sure how to best extend this title modification across other pages and references. Is it safe to rename the file and all other occurrences?
There was a problem hiding this comment.
I believe it is safe to rename the file and corresponding slugs across other docs.
It would be great if we could also create a URL redirect, in case users have saved the old URL somewhere, but I think we do not have this ability for this portal yet. Do we, @carolinamenezes ?
| Follow these steps to run a local server and access GraphiQL: | ||
| Follow these steps to run a local server and access GraphQL Playground: |
There was a problem hiding this comment.
Note they're different apps that help explore a GraphQL API.
| @@ -5,19 +5,19 @@ sidebar_position: 1 | |||
| import Tabs from '@theme/Tabs'; | |||
| import TabItem from '@theme/TabItem'; | |||
|
|
|||
| # Using GraphiQL to explore the FastStore API | |||
| # Using a GraphQL IDE to explore the FastStore API | |||
There was a problem hiding this comment.
The rest of the documentation from "Building queries" explains how to use GraphiQL, so maybe it makes sense to keep the original title? Although it focuses on GraphiQL, with GraphQL Playground it should be pretty similar.
|
Thanks a lot for the suggestions @filipewl ! But I think I'll have to make more changes. I hope to have a new version by the end of next week. GraphiQL stopped working with Gatsby last month, which was what made me rewrite this guide to add separate instructions for next.js and Gatsby in the first place. And I tested it now and could not run a simple query. I think this means this tutorial should be more agnostic as to what playground is used and maybe indicate 2-3 alternatives. Or maybe I am doing something wrong in my tests. |
…GraphiQL" This reverts commit ade518b. Let's keep this change simple!
|
I adjusted the tutorial to be more generic,, @filipewl |
What's the purpose of this pull request?
The section names were inverted. Only Gatsby provides GraphiQL to explore the API via http://localhost:8000/__graphql. Our NextJS starter doesn't provide something similar, so the section about using GraphQL Playground is more suitable for it.
I also suggested renaming the title to "GraphQL IDEs" instead of just "GraphiQL" because the latter is only used in Gatsby.
@vtex/tech-writers feel free to revert/undo/add changes!
References