From 689d71e07843b0ae82b656fadee2c5e29f41e55d Mon Sep 17 00:00:00 2001 From: sh4shankk Date: Tue, 12 Nov 2024 17:30:13 +0530 Subject: [PATCH 1/4] Update README to improve clarity and add missing sections --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 43 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 2a1c4c1556..022df1d67d 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,59 @@ -# 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. +- The ability for clients to ask for exactly what they need. +- Powerful developer tools. + +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/) -- [Frequently Asked Questions (FAQ)](https://graphql.org/faq/) -- [Community resources](https://graphql.org/community/) +- [GraphQL Website](https://graphql.org/) +- [Reference Documentation](https://graphql.org/learn/) - Detailed guides and tutorials. +- [Language Support, Tools, and Services](https://graphql.org/code/) - Available tools and libraries for different languages. +- [Frequently Asked Questions (FAQ)](https://graphql.org/faq/) - Answers to common questions. +- [Community Resources](https://graphql.org/community/) - Community-driven resources. ## 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` +2. Install dependencies: + `npm install` +3. Run the site locally: + `npm start` + +## 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. -## How to contribute +### CLA Process -Check out our [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to make changes to the GraphQL website 🎉. +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: +- [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. +## Financial Support -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). From bb4ee0d1e14bfec83b5089cf09916c5f50f39f92 Mon Sep 17 00:00:00 2001 From: Benjie Date: Thu, 21 Nov 2024 14:20:53 +0000 Subject: [PATCH 2/4] Apply suggestions from code review --- README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 022df1d67d..53473d988e 100644 --- a/README.md +++ b/README.md @@ -16,29 +16,35 @@ You can find more discussions on the [#website channel on the GraphQL Slack](htt ## 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. -- The ability for clients to ask for exactly what they need. -- Powerful developer tools. + +- 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 - [GraphQL Website](https://graphql.org/) -- [Reference Documentation](https://graphql.org/learn/) - Detailed guides and tutorials. -- [Language Support, Tools, and Services](https://graphql.org/code/) - Available tools and libraries for different languages. -- [Frequently Asked Questions (FAQ)](https://graphql.org/faq/) - Answers to common questions. -- [Community Resources](https://graphql.org/community/) - Community-driven resources. +- [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/) ## Deployment 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` + `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 start` + `npm run dev` ## How to Contribute @@ -47,6 +53,7 @@ We welcome contributions! 🎉 Please refer to our [contributing guide](./CONTRI ### CLA Process 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: + - [Individual contributors](http://individual-spec-membership.graphql.org/) - [Employers](http://corporate-spec-membership.graphql.org/) @@ -54,6 +61,6 @@ To initiate the signature process, please open a PR against this repository. The 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). -## Financial Support +## 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 consider becoming a member of the [GraphQL Foundation](https://foundation.graphql.org/join). From 1e7bb60ec11b87b849f97ab4d14c92627b8e7be2 Mon Sep 17 00:00:00 2001 From: Benjie Date: Thu, 21 Nov 2024 14:24:11 +0000 Subject: [PATCH 3/4] Send through Prettier Playground --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 53473d988e..bd02ffddf2 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,10 @@ You can find more discussions on the [#website channel on the GraphQL Slack](htt - 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. +- 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/). From 7721c3a46a9683369de3d11d47918706fb489859 Mon Sep 17 00:00:00 2001 From: Benjie Date: Thu, 21 Nov 2024 14:25:19 +0000 Subject: [PATCH 4/4] Prettier again --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bd02ffddf2..2da4335f60 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,9 @@ You can find more discussions on the [#website channel on the GraphQL Slack](htt - 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. + - 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/).