|
1 |
| -# Source Repository for graphql.org |
| 1 | +# Source Repository for GraphQL.org |
2 | 2 |
|
3 | 3 | This repository contains the source code for the [GraphQL website](https://graphql.org).
|
4 | 4 |
|
5 |
| -> You can find more discussions on the [#website channel on the GraphQL Slack](https://graphql.slack.com/messages/website/). [Get your invite here!](https://graphql-slack.herokuapp.com/) |
| 5 | +You can find more discussions on the [#website channel on the GraphQL Slack](https://graphql.slack.com/messages/website/). [Get your invite here!](https://graphql-slack.herokuapp.com/). |
6 | 6 |
|
7 |
| -A brief overview: **GraphQL** is a query language for APIs and a runtime for fulfilling those queries with your existing data. It provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need, and enables powerful developer tools. The [specification](https://spec.graphql.org/) is open source and governed by the [GraphQL Foundation](https://foundation.graphql.org/). |
| 7 | +## Table of Contents |
| 8 | + |
| 9 | +- [Overview](#overview) |
| 10 | +- [Documentation](#documentation) |
| 11 | +- [Deployment](#deployment) |
| 12 | +- [How to Contribute](#how-to-contribute) |
| 13 | +- [CLA Process](#cla-process) |
| 14 | +- [Financial Support](#financial-support) |
| 15 | + |
| 16 | +## Overview |
| 17 | + |
| 18 | +**GraphQL** is a query language for APIs and a runtime for fulfilling those queries with your existing data. It provides: |
| 19 | + |
| 20 | +- a complete and understandable description of the data in your API, |
| 21 | +- support for powerful developer tooling, and |
| 22 | +- precise querying, which offers several benefits: |
| 23 | + - clients request only the data they need, improving efficiency; |
| 24 | + - new fields and features can be added without impacting existing clients; and |
| 25 | + - field-level usage can be tracked and monitored for insights and optimization. |
| 26 | + |
| 27 | +The [GraphQL Specification](https://spec.graphql.org/) is open source and governed by the [GraphQL Foundation](https://foundation.graphql.org/). |
8 | 28 |
|
9 | 29 | ## Documentation
|
10 | 30 |
|
11 |
| -- [Site](https://graphql.org/) |
12 |
| -- [Reference documentation](https://graphql.org/learn/) |
13 |
| -- [Language support, tools, and services](https://graphql.org/code/) |
| 31 | +- [GraphQL Website](https://graphql.org/) |
| 32 | +- [Reference Documentation](https://graphql.org/learn/) |
| 33 | +- [Language Support, Tools, and Services](https://graphql.org/code/) |
14 | 34 | - [Frequently Asked Questions (FAQ)](https://graphql.org/faq/)
|
15 |
| -- [Community resources](https://graphql.org/community/) |
| 35 | +- [Community Resources](https://graphql.org/community/) |
16 | 36 |
|
17 | 37 | ## Deployment
|
18 | 38 |
|
19 |
| -The site is deployed via Vercel on merges to the `source` branch. |
| 39 | +The website is deployed via [Vercel](https://vercel.com) on merges to the `source` branch. To preview changes locally, follow these steps: |
| 40 | + |
| 41 | +1. Clone the repository: |
| 42 | + `git clone https://github.com/graphql/graphql.github.io.git` |
| 43 | + `cd graphql.github.io` |
| 44 | +2. Install dependencies: |
| 45 | + `npm install` |
| 46 | +3. Run the site locally: |
| 47 | + `npm run dev` |
| 48 | + |
| 49 | +## How to Contribute |
| 50 | + |
| 51 | +We welcome contributions! 🎉 Please refer to our [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to make changes to the GraphQL website. |
| 52 | + |
| 53 | +### CLA Process |
20 | 54 |
|
21 |
| -## How to contribute |
| 55 | +Before contributing, all participants must sign the free [GraphQL Specification Membership Agreement](https://preview-spec-membership.graphql.org). You only need to do this once, and it can be signed by: |
22 | 56 |
|
23 |
| -Check out our [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to make changes to the GraphQL website 🎉. |
| 57 | +- [Individual contributors](http://individual-spec-membership.graphql.org/) |
| 58 | +- [Employers](http://corporate-spec-membership.graphql.org/) |
24 | 59 |
|
25 |
| -This repository is managed by EasyCLA. Project participants must sign the free [GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org) before making a contribution. You only need to do this one time, and it can be signed by [individual contributors](http://individual-spec-membership.graphql.org/) or their [employers](http://corporate-spec-membership.graphql.org/). |
| 60 | +To initiate the signature process, please open a PR against this repository. The EasyCLA bot will block the merge if the membership agreement has not been signed. |
26 | 61 |
|
27 |
| -To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you. |
| 62 | +For more information on the CLA, check out the [detailed instructions here](https://github.com/graphql/graphql-wg/tree/main/membership). If you encounter any issues, please contact us at [[email protected]](mailto:[email protected]). |
28 | 63 |
|
29 |
| -You can find [detailed information here](https://github.com/graphql/graphql-wg/tree/main/membership). If you have issues, please email [email protected]. |
| 64 | +## Join the Foundation! |
30 | 65 |
|
31 |
| -If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the [GraphQL Foundation](https://foundation.graphql.org/join). |
| 66 | +If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please consider becoming a member of the [GraphQL Foundation](https://foundation.graphql.org/join). |
0 commit comments