Conversation
ghost
added
the
shadaj
force-pushed
the
vscode-extension-readme
branch
from
ebcfeca to
14153df
Compare
peggyrayzis
left a comment
peggyrayzis
left a comment
There was a problem hiding this comment.
This is a good start, thanks Shadaj! Before we officially launch, I think there are a lot of unanswered questions regarding the workflow for configuring your schema to work with the extension. What if the developer isn't running their schema locally? Do they point to a deployed version? What about Engine?
@stubailo also has opinions on what this should look like. Let's all work together to come up with a recommended workflow that covers all of these scenarios.
|
|
||
| Open up VS Code and search for the extension "Apollo". | ||
|
|
||
| ## How to get it set up? |
There was a problem hiding this comment.
What about uploading your schema to Engine? What if you're not running your GraphQL server locally?
|
|
||
| ## How to get it? | ||
|
|
||
| Open up VS Code and search for the extension "Apollo". |
There was a problem hiding this comment.
Will this extension conflict with any other GraphQL extensions you have installed?
There was a problem hiding this comment.
Probably, since both register a GraphQL syntax. Should I add a line to warn users about installing it alongside other extensions?
|  | ||
|  | ||
|
|
||
| ## Features |
There was a problem hiding this comment.
Does this extension work with non-Apollo GraphQL servers?
There was a problem hiding this comment.
Yes! Is there somewhere we can make this more clear?
|
|
||
| The extension enables query execution when an `endpoint` is specified for the schema you are targeting. When you hit `Run query/mutations/subscription`, the extension will open a menu for you to input variables if there are any defined or directly run the query otherwise. | ||
|
|
||
| Queries and mutations are executed with the same [Apollo Link HTTP](https://www.apollographql.com/docs/link/links/http.html) configured to run queries against the specified endpoint. Subscriptions are handled with [Apollo Link WS](https://www.apollographql.com/docs/link/links/ws.html) configured to run against the `subscriptions` key in your schema or your endpoint with `http` replaced by `ws` if the key is not defined. |
There was a problem hiding this comment.
Instead of mentioning Apollo Link HTTP & WS, we should probably just mention that it uses the same network interface you use with Apollo Client.
|
|
||
| If you're having trouble with the extension not launching or not detecting your configuration files, you can check the language server logs. | ||
|
|
||
| 1. Open the VS Code output tab from the bottom of your editor |
There was a problem hiding this comment.
What's the VSCode output tab? This should be more clear.
|
Merging what we have so far since we depend on the images in this PR for the marketplace description. |
3 participants
No description provided.