Skip to content

Update README to improve clarity and add missing sections #1823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 49 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,66 @@
# Source Repository for graphql.org
# Source Repository for GraphQL.org

This repository contains the source code for the [GraphQL website](https://graphql.org).

> 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/)
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/).

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/).
## Table of Contents

- [Overview](#overview)
- [Documentation](#documentation)
- [Deployment](#deployment)
- [How to Contribute](#how-to-contribute)
- [CLA Process](#cla-process)
- [Financial Support](#financial-support)

## 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,
- support for powerful developer tooling, and
- precise querying, which offers several benefits:
- clients request only the data they need, improving efficiency;
- new fields and features can be added without impacting existing clients; and
- field-level usage can be tracked and monitored for insights and optimization.

The [GraphQL Specification](https://spec.graphql.org/) is open source and governed by the [GraphQL Foundation](https://foundation.graphql.org/).

## Documentation

- [Site](https://graphql.org/)
- [Reference documentation](https://graphql.org/learn/)
- [Language support, tools, and services](https://graphql.org/code/)
- [GraphQL Website](https://graphql.org/)
- [Reference Documentation](https://graphql.org/learn/)
- [Language Support, Tools, and Services](https://graphql.org/code/)
- [Frequently Asked Questions (FAQ)](https://graphql.org/faq/)
- [Community resources](https://graphql.org/community/)
- [Community Resources](https://graphql.org/community/)

## Deployment

The site is deployed via Vercel on merges to the `source` branch.
The website is deployed via [Vercel](https://vercel.com) on merges to the `source` branch. To preview changes locally, follow these steps:

1. Clone the repository:
`git clone https://github.com/graphql/graphql.github.io.git`
`cd graphql.github.io`
2. Install dependencies:
`npm install`
3. Run the site locally:
`npm run dev`

## How to Contribute

We welcome contributions! 🎉 Please refer to our [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to make changes to the GraphQL website.

### CLA Process

## How to contribute
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:

Check out our [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to make changes to the GraphQL website 🎉.
- [Individual contributors](http://individual-spec-membership.graphql.org/)
- [Employers](http://corporate-spec-membership.graphql.org/)

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/).
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.

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.
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 [operations@graphql.org](mailto:operations@graphql.org).

You can find [detailed information here](https://github.com/graphql/graphql-wg/tree/main/membership). If you have issues, please email operations@graphql.org.
## Join the Foundation!

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).
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).