Contribute 2020 Challenge - add improvements & examples to GraphQL Getting Started
Problem to solve
Contribute 2020 Challenge to improve documentation.
Proposal
Based on personal, initial usage from SA/TAM/IE, we are proposing the following doc updates to assist Users getting started with GraphQL and GraphiQL.
-
Add additional working examples -
Walkthru showing how to take a GraphiQL query and automate in scripting -
Additional working examples with curl -
Example(s) filtering output with e.g. jq -
Example using chrome devtools, [e.g. copy as curl] -
Using GraphiQL to explore the GraphQL data model
-
-
Clarify authentication -
Personal Token access settings
-
-
Troubleshooting -
Add Charlie & Sameer's Contribute videos
Who can address the issue
Notes
- SME: Simon Mansfield
- Channel: f_graphql
Other links/references
Getting Started Guide: https://docs.gitlab.com/ee/api/graphql/getting_started.html
Edited by Sameer Kamani