Life is hard and so is learning GraphQL

Slide 1

Slide 1 text

Life is hard and so is learning GraphQL @carolstran

Slide 2

Slide 2 text

@carolstran

Slide 3

Slide 3 text

@carolstran graph.cool

Slide 4

Slide 4 text

@carolstran

Slide 5

Slide 5 text

@carolstran

Slide 6

Slide 6 text

@carolstran

Slide 7

Slide 7 text

@carolstran

Slide 8

Slide 8 text

@carolstran

Slide 9

Slide 9 text

@carolstran

Slide 10

Slide 10 text

@carolstran

Slide 11

Slide 11 text

@carolstran

Slide 12

Slide 12 text

@carolstran

Slide 13

Slide 13 text

GraphQL @carolstran

Slide 14

Slide 14 text

GraphQL @carolstran

Slide 15

Slide 15 text

@carolstran

Slide 16

Slide 16 text

@carolstran

Slide 17

Slide 17 text

Go to GraphiQL and “try it out” @carolstran bit.ly/graphiql-demo

Slide 18

Slide 18 text

Work your way through the documentation @carolstran graphql.org

Slide 19

Slide 19 text

@carolstran graphql.org

Slide 20

Slide 20 text

@carolstran

Slide 21

Slide 21 text

@carolstran

Slide 22

Slide 22 text

@carolstran

Slide 23

Slide 23 text

@carolstran graphql.org

Slide 24

Slide 24 text

@carolstran graphql.org

Slide 25

Slide 25 text

@carolstran graphql.org/learn

Slide 26

Slide 26 text

@carolstran graphql.org/learn

Slide 27

Slide 27 text

@carolstran

Slide 28

Slide 28 text

@carolstran

Slide 29

Slide 29 text

@carolstran Anyone who encounters GraphQL, needs to be able to understand it

Slide 30

Slide 30 text

@carolstran gatsbyjs.org

Slide 31

Slide 31 text

@carolstran

Slide 32

Slide 32 text

The problems and what we can do about it @carolstran

Slide 33

Slide 33 text

Just because GraphQL is “self- documenting," doesn’t mean you should stop writing docs @carolstran Problem

Slide 34

Slide 34 text

@carolstran bit.ly/github-gql-api

Slide 35

Slide 35 text

@carolstran bit.ly/github-gql-api

Slide 36

Slide 36 text

“This type of documentation is great after you understand the domain area and the business cases and you’ve built some conﬁdence making queries and mutations… @carolstran — Andrew Johnston bit.ly/andrew-api-docs

Slide 37

Slide 37 text

…but without more detailed documentation that covers the conceptual materials, you’re not going to get there.” @carolstran — Andrew Johnston bit.ly/andrew-api-docs

Slide 38

Slide 38 text

“Documenting API endpoints explains how individual tools work, explaining how to use those tools together is a whole other area of documentation effort. ” @carolstran — Chris Ward bit.ly/documenting-graphql

Slide 39

Slide 39 text

@carolstran gatsbyjs.org/docs/querying-with-graphql/

Slide 40

Slide 40 text

GraphQL is dominated by the JavaScript community @carolstran Problem

Slide 41

Slide 41 text

@carolstran bit.ly/graphql-def

Slide 42

Slide 42 text

@carolstran

Slide 43

Slide 43 text

@carolstran JavaScript TypeScript Ruby PHP Python Java C/C++ Swift .NET Erlang Elixir Haskell Rust Go Scala Clojure R (and more)

Slide 44

Slide 44 text

@carolstran graphql.org/learn

Slide 45

Slide 45 text

@carolstran graphql.org/learn

Slide 46

Slide 46 text

@carolstran graphql.org/code

Slide 47

Slide 47 text

Assumed knowledge and speciﬁc terminology Problem @carolstran

Slide 48

Slide 48 text

@carolstran Everyone is a beginner at some point

Slide 49

Slide 49 text

Listing pre-reqs for a tutorial will help prevent headaches @carolstran

Slide 50

Slide 50 text

@carolstran bit.ly/graphql-glossary

Slide 51

Slide 51 text

@carolstran bit.ly/fb-graphapi

Slide 52

Slide 52 text

Quick wins some short documentation tips @carolstran

Slide 53

Slide 53 text

Be conﬁdent with your deﬁnitions Quick win @carolstran

Slide 54

Slide 54 text

Don’t integrate tools or services without explanation Quick win @carolstran

Slide 55

Slide 55 text

Be transparent about any downfalls Quick win @carolstran

Slide 56

Slide 56 text

More resources for learning GraphQL and beyond @carolstran

Slide 57

Slide 57 text

HowToGraphQL.com Resource @carolstran

Slide 58

Slide 58 text

@carolstran howtographql.com

Slide 59

Slide 59 text

A Frontend Developer’s Guide to GraphQL Resource @carolstran github.com/peggyrayzis/guide-to-graphql

Slide 60

Slide 60 text

@carolstran css-tricks.com/front-end-developers-guide-graphql/

Slide 61

Slide 61 text

GitHub's GraphQL API Resource @carolstran bit.ly/github-gql-api

Slide 62

Slide 62 text

@carolstran bit.ly/github-gql-api

Slide 63

Slide 63 text

Community Resources on ofﬁcial GraphQL docs Resource @carolstran graphql.org/community

Slide 64

Slide 64 text

@carolstran graphql.org/community

Slide 65

Slide 65 text

https://so-you-want-to-learn- graphql.netlify.com/ Resource @carolstran github.com/carolstran/so-you-want-to-learn-graphql