-
Notifications
You must be signed in to change notification settings - Fork 9
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
feat: add create graphql mutation #61
base: new-docs-draft-two
Are you sure you want to change the base?
Conversation
Signed-off-by: Brent Hoover <[email protected]>
Signed-off-by: Alvaro Bueno <[email protected]>
Signed-off-by: Alvaro Bueno <[email protected]>
Signed-off-by: Brent Hoover <[email protected]>
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.
Looks good
Signed-off-by: Brent Hoover <[email protected]>
Signed-off-by: Brent Hoover <[email protected]>
Rewrite to fit guide format
|
||
## What you need | ||
|
||
You need to understand what key you will use to query the data, and what the payload of the data is. |
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.
We don't have it yet, but are the going to be inlinks into our GraphQL documentation or out to 3rd party GraphQL docs if they need more info on these two items?
|
||
## Define the mutation in the schema | ||
|
||
- If it doesn't already exist, create `schemas` folder in the plugin, and add an `index.js` file there. |
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.
Similar comment to the other. I would drop the bullets and try to consolidate a little, like:
If it doesn't already exist, create schemas folder in the plugin and add an index.js file there. Then check to see if there is a schema.graphql file in your schemas directory within the plugin. If there isn't, create that file now.
Import the GraphQL file...
|
||
> NOTE: For large plugins, you can split to multiple `.graphql` files and export a multi-item array. | ||
|
||
- In the `.graphql` file, add your mutation within `extend type Mutation { }`. Add an `extend type Mutation` section near the top if the file doesn't have it yet. |
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.
Suggest to drop bullets on this one and the 4 items below this to stay in line with what I'm seeing live on /Developer
|
||
## Create the plugin mutation file | ||
|
||
- If it doesn't already exist, create `mutations` folder in the plugin, and add an `index.js` file there. |
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.
Suggest dropping bullets from this lines as well. Seems to me that a step under a heading doesn't need bullets, whereas a step that has multiple sub-steps or things you need to consider within that step may benefit from bullets.
Signed-off-by: Brent Hoover [email protected]