graphql / graphql/graphql.github.io

[Discussion] Getting Started experience on graphql.org

Open
#1,620 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
889
Forks
1.5k
Avg merge
4d 12h
Merged PRs (30d)
21

Description

Hey all,

Creating this issue to discuss small but important changes to the GraphQL Getting Started Experience.

When you visit [graphql.org](https://graphql.org) landing page, you land on this hero banner.

![image1](https://github.com/graphql/graphql.github.io/assets/14110316/b9ed4407-8365-43da-8eb6-002742a02b48)

The top banner here speaks to a client audience (mostly frontend focussed) where benefits of GraphQL for consumption is highlighted.

- Describe your data
- Ask for what you want vs Expose what data you want
- Get predictable results

This needs to address both the frontend and backend audience where the highlights need to balance out what is beneficial for the backend producer.

When you click on Get Started here, it takes you to [graphql.org/code](https://graphql.org/code).

The hero banner here talks about `Code using GraphQL`

![image2](https://github.com/graphql/graphql.github.io/assets/14110316/a3ed68de-a6f2-4172-a532-2e48abe733d2)

GraphQL tooling has evolved to allow a different pattern of building GraphQL servers by introspecting a data source (a database or an existing API like an OpenAPI spec) and auto-generating a GraphQL API without writing any boilerplate CRUD code, essentially acting as a compiler. Some examples of such projects are PostGraphile, Hasura, Tuql, Neo4j GraphQL, IBM’s OpenAPI to GraphQL, Mesh’s source handlers, etc.

In summary, two broad approaches to building a GraphQL API have emerged,
- DIY GraphQL: define a GraphQL schema and write resolvers
- Use tools that introspect the underlying source to generate the GraphQL API/schema.

We need to represent these two broad approaches to developers who are looking to get started with GraphQL on the backend.

Happy to start a PR on this, but would love to get more thoughts before I do that.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.