-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
110 additions
and
2 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,31 @@ | ||
# faq | ||
GraphQL FAQ | ||
# GraphQL FAQ | ||
|
||
This project hopes to collect common questions and answers into peer reviewed | ||
and easily digestable form. | ||
|
||
## Phase 1: | ||
|
||
Collect FAQ proposals into the [/proposals][] dir as minimal markdown files | ||
collecting links to relevant discussion, issues, comments. | ||
|
||
All contributions should be merged quickly. | ||
|
||
## Phase 2: | ||
|
||
Draft content by taking interesting or high-impact questions from [/proposals][] | ||
and writing a first draft answer and moving into [/drafts][]. This can be derived by copy-pasting from | ||
existing discussion or synthesizing into a new form. | ||
|
||
Some review may happen to these PRs, but they should be merged promptly. | ||
|
||
## Phase 3: | ||
|
||
Review and edit drafts by technical writers or native speakers and move to [/published][]. | ||
|
||
Peer review should be done before merging, though edits and improvements are welcome. | ||
|
||
## Phase 4 (can be done earlier): | ||
|
||
Build Gatsby site which exposes published FAQs as google-crawlable pages along with | ||
a top level page showing all/featured FAQ and a search bar. Use algolia or similar | ||
to search across all FAQ. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
author: @leebyron | ||
question: "What is a _GraphQL Query_?" | ||
term: graphql query | ||
draft: true | ||
--- | ||
|
||
A GraphQL Query is a request for specific data provided by a GraphQL Service | ||
written in the GraphQL language. | ||
|
||
Here's a simple example which asks for my name, and the names of 3 of my friends: | ||
|
||
```graphql | ||
{ | ||
me { | ||
name | ||
friends(first: 3) { | ||
name | ||
} | ||
} | ||
} | ||
``` | ||
|
||
Once sent to a GraphQL Service, this might return the result: | ||
|
||
|
||
```json | ||
{ | ||
"data": { | ||
"me": { | ||
"name": "Lee Byron", | ||
"friends": [ | ||
{ "name": "Ash Huang" }, | ||
{ "name": "Nick Schrock" }, | ||
{ "name": "Dan Schafer" }, | ||
] | ||
} | ||
} | ||
} | ||
``` | ||
|
||
Some important properties of GraphQL Queries this example helps illustrate: | ||
|
||
## A GraphQL Query describes the shape of the resulting data | ||
|
||
TK | ||
|
||
## A GraphQL Query can access data across many "resources" | ||
|
||
TK | ||
|
||
## Query behavior can change by using field arguments | ||
|
||
TK | ||
|
||
# Relevant Links | ||
|
||
* [Learn about the GraphQL Query Language](https://graphql.org/learn/queries/) | ||
* [GraphQL Language Specification](https://graphql.github.io/graphql-spec/June2018/#sec-Language.Document) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"name": "graphql-faq", | ||
"version": "1.0.0", | ||
"main": "index.js", | ||
"repository": "[email protected]:graphql/faq.git", | ||
"author": "Lee Byron <[email protected]>", | ||
"license": "MIT" | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
question: "Do I need _schema stiching_?" | ||
draft: true | ||
--- | ||
|
||
Needs links to relevant content |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
question: "What is a valid field name?" | ||
draft: true | ||
--- | ||
|
||
Needs links to existing discussion |