-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
benjie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## 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` | ||
benjie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
2. Install dependencies: | ||
`npm install` | ||
3. Run the site locally: | ||
`npm start` | ||
benjie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## 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/) | ||
benjie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- [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 | ||
benjie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.