graphql / graphql/graphql.github.io

[Discussion] Getting Started experience on graphql.org

Offen
#1,620 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TypeScript
Sterne
889
Forks
1.5k
Ø Merge
4 T. 12 Std.
Gemergte PRs (30 T.)
21

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start by reviewing the landing page and graphql.org/code page linked in the discussion, along with CONTRIBUTING.md for the website channel. The issue has no file or test references; work is not defined as done until the messaging and scope for both backend approaches are agreed.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
content, documentation, web-dev
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.