Skip to content

Instantly share code, notes, and snippets.

@carolstran
Last active December 21, 2020 21:39
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save carolstran/639d370f0d6292a5d56d1501d7b3383e to your computer and use it in GitHub Desktop.
Save carolstran/639d370f0d6292a5d56d1501d7b3383e to your computer and use it in GitHub Desktop.
Final Project Report for Google Season of Docs (GSoD)

Google Season of Docs (GSoD) Project Report

This document outlines the work that I've done for the GraphQL Foundation during GSoD.

📝 Original project proposal

💓 Blog post on the GraphQL Foundation site about my project

Create FAQ resource

That was the title of my project and that was exactly what I did throughout my time participating in GSoD.

🔗 Current version of the deployed FAQ resource: https://graphql.org/faq/

These were the top 25 questions out of over 150 potential questions that I scraped from various resources. These resources included online sites like StackOverflow and Reddit, issues filed in the GraphQL organization repositories, as well as speaking with prominent teachers in the GraphQL community.

Once the initial version of the page was launched, I gathered feedback from all types of GraphQL learners to see if the page was clear, useful, and what could be added to improve it in the future. In total, I've spoken with over 30 people.

There are still a few pull requests under review.

Project goals

There were two main goals behind this FAQ page:

  1. Build a centralized resource for everyone - The FAQ content will be framework agnostic and vendor-neutral.
  2. Become a truly community-owned resource - This should be a resource that everyone is welcome to contribute to and the community feels empowered to change and grow.

✅ Goal 1 was accomplished by extensive research, working closely with my mentor, rigorous review of the content by the GraphQL TSC, and gathering community feedback.

✅ Goal 2 is ever-evolving, but steps were taken to ensure that people know how to contribute and share their ideas. This was done by adding and updating internal documentation:

What's left

There are still a few pull requests that are either in progress or under review. Here's an overview.

I'm actively working on these and plan to finish within the next couple of weeks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment