graphql / graphql/graphql.github.io

[Discussion] Getting Started experience on graphql.org

オープン
#1,620 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
TypeScript
スター
889
フォーク
1.5k
平均マージ
4日 12時間
マージ済み PR(30日)
21

説明

Hey all,

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

When you visit graphql.org landing page, you land on this hero banner.

image1

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.

The hero banner here talks about Code using GraphQL

image2

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.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、ディスカッションでリンクされているランディングページと graphql.org/code ページ、およびウェブサイトのチャンネルについての CONTRIBUTING.md を確認してください。Issue にはファイルやテストへの参照がありません。両方のバックエンドアプローチについて、メッセージングとスコープの合意が得られるまで、作業は完了したものとはみなされません。

索引モデルが issue の本文から書いたものです。

評価

領域
content, documentation, web-dev
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。