https://github.com/graphql/faq

GraphQL FAQ
https://github.com/graphql/faq

Last synced: about 1 month ago
JSON representation

GraphQL FAQ

• Host: GitHub
• URL: https://github.com/graphql/faq
• Owner: graphql
• License: mit
• Created: 2019-06-06T18:08:09.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-02-04T22:21:24.000Z (almost 4 years ago)
• Last Synced: 2024-09-27T21:21:03.849Z (about 1 month ago)
• Size: 6.84 KB
• Stars: 37
• Watchers: 29
• Forks: 6
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GraphQL FAQ

This project hopes to collect common questions and answers into peer reviewed

and easily digestable form.

## Phase 1:

Collect FAQ proposals into the [/proposals](/proposals) dir as minimal markdown files

collecting links to relevant discussion, issues, comments.

All contributions should be merged quickly.

## Phase 2:

Draft content by taking interesting or high-impact questions from [/proposals](/proposals)

and writing a first draft answer and moving into [/drafts](/drafts). This can be derived by copy-pasting from

existing discussion or synthesizing into a new form.

Some review may happen to these PRs, but they should be merged promptly.

## Phase 3:

Review and edit drafts by technical writers or native speakers and move to [/published](/published).

Peer review should be done before merging, though edits and improvements are welcome.

## Phase 4 (can be done earlier):

Build Gatsby site which exposes published FAQs as google-crawlable pages along with

a top level page showing all/featured FAQ and a search bar. Use algolia or similar

to search across all FAQ.

# Contributing to this repo

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 repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.

You can find [detailed information here](https://github.com/graphql/graphql-wg/tree/main/membership). If you have issues, please email [[email protected]](mailto:[email protected]).

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