Add answers for general FAQ questions #930

carolstran · 2020-10-14T17:50:16Z

💓 This PR is part of Google Season of Docs 💓

We decided on the first 10 questions for the FAQ page would be the following:

This PR includes the first attempt at answering these questions. Once approved, it'll be merged into the faq branch.

src/content/faq/General.md

carolstran · 2020-10-20T19:50:26Z

@IvanGoncharov, I tagged this for review (finally). I'm not convinced about all of the links... but I wanted to make sure to give readers resources to learn more! Something we should also decide is whether to include the links inline (like I did in this PR) or have no links inline and put them as a list at the end.

I'm also going to add a few comments throughout that I'd like your opinion on so please keep an eye out for those 💫

src/content/faq/General.md

carolstran · 2020-10-20T19:58:15Z

src/content/faq/General.md


-Pie gummies apple pie marzipan halvah cotton candy toffee tootsie roll oat cake. Brownie pudding pastry candy chupa chups liquorice bear claw pudding jujubes. Pie jelly liquorice dessert sweet roll bonbon. Danish macaroon cupcake jelly beans liquorice brownie dessert muffin candy canes.
+For more practical guides, you can visit the [How to GraphQL](https://www.howtographql.com/) fullstack tutorial website. We also have a free online course with edX, [Exploring GraphQL: A Query Language for APIs](https://www.edx.org/course/exploring-graphql-a-query-language-for-apis). 

 ## Is GraphQL frontend or backend?


@IvanGoncharov Should we explain some of the benefits of GraphQL for frontend and backend devs here? I started to but then the answer became long and complex.

I agree with your comment that you could also use GraphQL just for the backend and just for the frontend.
I believe those are actually important use cases.

The frontend even more in terms of adoption -

Most of our larger clients have difficulties (political, technical) for introducing another gateway into their existing stack.
Adding GraphQL only on the frontend actually made adoption much faster in those companies, that later on were convinced to move that layer as a gateway.
Companies like PayPal, Microsoft and many others have went through that route.
So I believe mentioning that could open easier doors for early adoption.

src/content/faq/General.md

Urigo

I know you didn't ask for my review, but I love that you are woking on this and making it happen and hope that some of my comments would help and not intrude your awesome work.

src/content/faq/General.md

Urigo · 2020-10-21T11:29:02Z

src/content/faq/General.md


-Jelly-o cupcake marshmallow marshmallow. Lemon drops cake caramels donut halvah cupcake topping tootsie roll. Jelly cotton candy candy cheesecake danish [jelly-o icing bonbon]().
+GraphQL and REST can actually co-exist in your stack. For example, you can abstract REST APIs behind a [GraphQL server](https://www.howtographql.com/advanced/1-server/). This can be done by masking your REST endpoint into a GraphQL endpoint using [root resolvers](/learn/execution/#root-fields-resolvers). 



I would also add that you could do the other way around - generate REST on top of GraphQL so you could gradually move to REST but still support consumers who needs regular REST endpoints. (reference)

I've found this to be a very compelling argument when introducing GraphQL to developers for the first time

I agree that I think the use case could be good to include. Would you have an idea for somewhere within the docs to link to? We're trying to keep the FAQ neutral and not link to third-party sites.

src/content/faq/General.md

Urigo · 2020-10-21T11:40:28Z

src/content/faq/General.md


-Pie gummies apple pie marzipan halvah cotton candy toffee tootsie roll oat cake. Brownie pudding pastry candy chupa chups liquorice bear claw pudding jujubes. Pie jelly liquorice dessert sweet roll bonbon. Danish macaroon cupcake jelly beans liquorice brownie dessert muffin candy canes.
+For more practical guides, you can visit the [How to GraphQL](https://www.howtographql.com/) fullstack tutorial website. We also have a free online course with edX, [Exploring GraphQL: A Query Language for APIs](https://www.edx.org/course/exploring-graphql-a-query-language-for-apis). 

 ## Is GraphQL frontend or backend?


I agree with your comment that you could also use GraphQL just for the backend and just for the frontend.
I believe those are actually important use cases.

The frontend even more in terms of adoption -

Most of our larger clients have difficulties (political, technical) for introducing another gateway into their existing stack.
Adding GraphQL only on the frontend actually made adoption much faster in those companies, that later on were convinced to move that layer as a gateway.
Companies like PayPal, Microsoft and many others have went through that route.
So I believe mentioning that could open easier doors for early adoption.

src/content/faq/General.md

carolstran · 2020-10-21T13:14:38Z

Oooooh thanks for the review @Urigo! I'll go through the comments in a bit, but wanted to say thanks and the reason its open source is that people can give their input so I appreciate you taking the time 😁

src/content/faq/General.md

IvanGoncharov · 2020-10-29T15:22:12Z

src/content/faq/General.md

+* Aggregate data from [multiple UI clients](/learn/queries/#fragments) in [a single request](/learn/best-practices/#server-side-batching-caching ).
+* Create a representation of your data that feels familiar and natural ([a graph](/learn/thinking-in-graphs/#it-s-graphs-all-the-way-down-https-en-wikipedia-org-wiki-turtles-all-the-way-down)).
+* Ensure that all of your data is [statically typed](/learn/schema/) and these types inform [what queries the schema supports](/learn/introspection/).
+* Examine queries and responses through community tools like [GraphiQL](https://github.com/graphql/graphiql).


We can add a point about schema evolution and that GraphQL not only has a built-in mechanism for deprecations but also greatly reduces the number of situations where you need to do breaking change.
Moreover, GraphQL actually gives you insights into what data is actually used by your clients so even in situations where you need to do breaking change you can effectively communicate it with affected clients.

Tried to squeeze that all into a bullet point, will be included in the next commit - curious to hear what you think!

carolstran · 2020-11-02T23:10:20Z

Closing this for now, will reopen with a PR to the new faq branch - plus will hopefully be a bit more clear for reviewing!

* Initial commit following Gatsby migration and review from #930 * Update FAQ based on feedback from Andreas * Apply suggestions from Benjie's code review Co-authored-by: Benjie Gillam <[email protected]> * Update license attribution Co-authored-by: Benjie Gillam <[email protected]> * Add prereq note to learn question * Update foundation numbers * Update JS question based on Ivan's review Co-authored-by: Benjie Gillam <[email protected]>

* Initial commit of FAQ page * Add answers for initial FAQ (#943) * Initial commit following Gatsby migration and review from #930 * Update FAQ based on feedback from Andreas * Apply suggestions from Benjie's code review Co-authored-by: Benjie Gillam <[email protected]> * Update license attribution Co-authored-by: Benjie Gillam <[email protected]> * Add prereq note to learn question * Update foundation numbers * Update JS question based on Ivan's review Co-authored-by: Benjie Gillam <[email protected]> Co-authored-by: Benjie Gillam <[email protected]>

Replace 7/10 cupcakes with answers

6c8749b

carolstran added ✏️ Editorial 🚧 In progress labels Oct 14, 2020

carolstran self-assigned this Oct 14, 2020

carolstran added 💬 FAQ Related to the FAQ project for Google Season of Docs. and removed ✏️ Editorial labels Oct 14, 2020

Add database answer

0daace0

IvanGoncharov reviewed Oct 19, 2020

View reviewed changes

src/content/faq/General.md Outdated Show resolved Hide resolved

IvanGoncharov reviewed Oct 19, 2020

View reviewed changes

src/content/faq/General.md Outdated Show resolved Hide resolved

carolstran added 4 commits October 19, 2020 23:16

Applied first round of Ivan's feedback

f639006

Add answer about GraphQL clients

5d0b0c8

Update client answer

4ed4004

Add why GraphQL answer (finally)

42d7f00

carolstran added ✏️ Editorial and removed 🚧 In progress labels Oct 20, 2020

carolstran marked this pull request as ready for review October 20, 2020 19:43

carolstran commented Oct 20, 2020

View reviewed changes

src/content/faq/General.md Show resolved Hide resolved

carolstran commented Oct 20, 2020

View reviewed changes

src/content/faq/General.md Show resolved Hide resolved

carolstran commented Oct 20, 2020

View reviewed changes

src/content/faq/General.md Show resolved Hide resolved

carolstran commented Oct 20, 2020

View reviewed changes

src/content/faq/General.md Show resolved Hide resolved

Urigo reviewed Oct 21, 2020

View reviewed changes

Update based on Uri's review

87b08de

carolstran requested a review from IvanGoncharov October 25, 2020 11:49

IvanGoncharov reviewed Oct 29, 2020

View reviewed changes

src/content/faq/General.md Outdated Show resolved Hide resolved

IvanGoncharov reviewed Oct 29, 2020

View reviewed changes

carolstran added 2 commits November 3, 2020 00:01

Another round of reviews

28e29fd

Update frontmatter for new Gatsby layout

c327ca7

carolstran changed the base branch from faq to faq-v2 November 2, 2020 23:06

carolstran changed the base branch from faq-v2 to faq November 2, 2020 23:07

carolstran closed this Nov 2, 2020

carolstran deleted the faq-general-questions branch November 2, 2020 23:10

carolstran added a commit that referenced this pull request Nov 2, 2020

Initial commit following Gatsby migration and review from #930

b9f8309

carolstran mentioned this pull request Nov 2, 2020

Add answers for initial FAQ #943

Merged

10 tasks


		Jelly-o cupcake marshmallow marshmallow. Lemon drops cake caramels donut halvah cupcake topping tootsie roll. Jelly cotton candy candy cheesecake danish [jelly-o icing bonbon]().
		GraphQL and REST can actually co-exist in your stack. For example, you can abstract REST APIs behind a [GraphQL server](https://www.howtographql.com/advanced/1-server/). This can be done by masking your REST endpoint into a GraphQL endpoint using [root resolvers](/learn/execution/#root-fields-resolvers).

Add answers for general FAQ questions #930

Add answers for general FAQ questions #930

Uh oh!

Conversation

carolstran commented Oct 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

carolstran commented Oct 20, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

carolstran Oct 20, 2020

Choose a reason for hiding this comment

Uh oh!

Urigo Oct 21, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Urigo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Urigo Oct 21, 2020

Choose a reason for hiding this comment

Uh oh!

carolstran Nov 2, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Urigo Oct 21, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

carolstran commented Oct 21, 2020

Uh oh!

Uh oh!

IvanGoncharov Oct 29, 2020

Choose a reason for hiding this comment

Uh oh!

carolstran Nov 2, 2020

Choose a reason for hiding this comment

Uh oh!

carolstran commented Nov 2, 2020

Uh oh!

Uh oh!

carolstran commented Oct 14, 2020 •

edited

Loading