Skip to content

Add answers for initial FAQ #943

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 13 commits into from
Nov 13, 2020
Merged

Add answers for initial FAQ #943

merged 13 commits into from
Nov 13, 2020

Conversation

carolstran
Copy link
Member

@carolstran carolstran commented Nov 2, 2020 •
edited
Loading

💓 This PR is part of Google Season of Docs 💓

We decided on the first 10 questions for the FAQ page would be the following:

  • Why should I use GraphQL?
  • Is GraphQL a database language like SQL?
  • Does GraphQL replace REST?
  • How can I learn GraphQL?
  • Is GraphQL frontend or backend?
  • Is GraphQL only for React or JavaScript developers?
  • What is a GraphQL client and why would I use one?
  • Is GraphQL owned by Facebook?
  • What is the GraphQL Foundation?
  • How can I contribute to the GraphQL specification?

This PR includes the latest draft of the answers (previous iteration on #930). Once approved, it'll be merged into the faq branch.

@carolstran carolstran added the 💬 FAQ Related to the FAQ project for Google Season of Docs. label Nov 2, 2020
@carolstran carolstran self-assigned this Nov 2, 2020
@carolstran carolstran changed the title Add answers for general FAQ questions Add answers for initial FAQ Nov 2, 2020
@carolstran carolstran mentioned this pull request Nov 2, 2020
Closed
11 tasks
Urigo
Urigo approved these changes Nov 4, 2020
View reviewed changes
Copy link
Contributor

@Urigo Urigo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome!
Can't wait to have it up!

andimarek
andimarek suggested changes Nov 5, 2020
View reviewed changes
Copy link
Contributor

@andimarek andimarek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great FAQ. Thanks a lot!
See my comments for specific details.

One question I would highly recommend to add very soon is "Is GraphQL owned by Facebook" / "What is the relationship between GraphQL and Facebook" or variations of it.

@carolstran
Copy link
Member Author

Thank you for the feedback @andimarek, super valuable! I updated the PR based on your initial feedback (including a new Is GraphQL owned by Facebook question) and left some clarifying questions for you in return 😊

benjie
benjie reviewed Nov 8, 2020
View reviewed changes
Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work @carolstran, this is going to be a huge boon for GraphQL 🙌

Would it make sense to merge this work with https://github.com/graphql/faq or deprecate that repository? It may also be worth checking out the issues and PRs on that repo.

@carolstran
Copy link
Member Author

Hey @benjie, thank you so much for the thoughtful review! I'll be working on your suggestions today and ping you with any questions 😊

As for the existing FAQ repository: I believe we should depreciate it and opt for all FAQ-related work to live in this repo. As part of my initial research for this project, I compiled a list of nearly 100 potential questions from various resources (that repo included), and these PRs I'm opening are a result of prioritizing together with @IvanGoncharov which would be the most valuable. I know this isn't super transparent at the moment, but I'm hoping that by the end of the month I'll have a way to communicate this so that it's documented, available, and could help people contribute to the FAQ in the future. So maybe we can wait to depreciate the other repo until then!

If you have any questions about this, please let me know! I'm still figuring out the best way to document all of this, so hopefully that will be sorted within the next couple of weeks.

@benjie
Copy link
Member

benjie commented Nov 9, 2020 •
edited
Loading

You're welcome; thanks for all your hard work on this! I agree with your proposed course of action; to archive the old repository we should raise it at the next WG. Would you be interested in adding that topic to the agenda?

Edit: I just re-read this and realised it has two semi-colons in... sorry 😳 😆

@carolstran
Copy link
Member Author

Alright I did another sweep with all of the notes in mind, if you all could take another look - I'd really appreciate it 😇 @IvanGoncharov @benjie @andimarek

Also, if you have opinions about the order of the questions, please let me know! I've been shuffling them around the past hour and can't decide... 😅

@carolstran
Copy link
Member Author

@benjie LOL please don't apologize! I don't mind when people use semicolons generally... I just don't want to commit any myself 😆

Would you be interested in adding that topic to the agenda?

Oooooooh good idea! I'll ping @IvanGoncharov about it because I'm not sure if that's better for him to do (as the GSoD mentor) or if I could do it myself.

carolstran
carolstran commented Nov 9, 2020
View reviewed changes
benjie
benjie reviewed Nov 10, 2020
View reviewed changes
benjie
benjie reviewed Nov 10, 2020
View reviewed changes
benjie
benjie approved these changes Nov 10, 2020
View reviewed changes
Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added some comments because I'm picky, but honestly I'd be happy if this was merged as-is - excellent work 🙌

@carolstran
Copy link
Member Author

@benjie Alright, I tweaked a couple of the answers based on your comments. If you have any more notes, please let me know!

benjie
benjie approved these changes Nov 11, 2020
View reviewed changes
Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🙌

@benjie benjie mentioned this pull request Nov 11, 2020
Merged
IvanGoncharov
IvanGoncharov reviewed Nov 13, 2020
View reviewed changes
IvanGoncharov
IvanGoncharov reviewed Nov 13, 2020
View reviewed changes
IvanGoncharov
IvanGoncharov approved these changes Nov 13, 2020
View reviewed changes
Copy link
Member

@IvanGoncharov IvanGoncharov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few suggestions, everything else looks greats 🎉

@carolstran carolstran merged commit be708be into faq Nov 13, 2020
@carolstran carolstran deleted the faq-general branch November 13, 2020 13:50
@carolstran carolstran mentioned this pull request Nov 13, 2020
Merged
carolstran added a commit that referenced this pull request Nov 13, 2020
@carolstran @benjie
Create Frequently Asked Questions (FAQ) Page (#942)
6339243 
* Initial commit of FAQ page

* Add answers for initial FAQ (#943)

* Initial commit following Gatsby migration and review from #930

* Update FAQ based on feedback from Andreas

* Apply suggestions from Benjie's code review

Co-authored-by: Benjie Gillam <[email protected]>

* Update license attribution

Co-authored-by: Benjie Gillam <[email protected]>

* Add prereq note to learn question

* Update foundation numbers

* Update JS question based on Ivan's review

Co-authored-by: Benjie Gillam <[email protected]>

Co-authored-by: Benjie Gillam <[email protected]>
Urigo pushed a commit that referenced this pull request Jan 26, 2021
@carolstran @benjie @Urigo
Create Frequently Asked Questions (FAQ) Page (#942)
b9e47a4 
* Initial commit of FAQ page

* Add answers for initial FAQ (#943)

* Initial commit following Gatsby migration and review from #930

* Update FAQ based on feedback from Andreas

* Apply suggestions from Benjie's code review

Co-authored-by: Benjie Gillam <[email protected]>

* Update license attribution

Co-authored-by: Benjie Gillam <[email protected]>

* Add prereq note to learn question

* Update foundation numbers

* Update JS question based on Ivan's review

Co-authored-by: Benjie Gillam <[email protected]>

Co-authored-by: Benjie Gillam <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benjie benjie benjie approved these changes

@Urigo Urigo Urigo approved these changes

@IvanGoncharov IvanGoncharov IvanGoncharov approved these changes

@leebyron leebyron Awaiting requested review from leebyron

@brianwarner brianwarner Awaiting requested review from brianwarner

@dschafer dschafer Awaiting requested review from dschafer

@caniszczyk caniszczyk Awaiting requested review from caniszczyk

@schrockn schrockn Awaiting requested review from schrockn

@andimarek andimarek Awaiting requested review from andimarek

Assignees

@carolstran carolstran

Labels
💬 FAQ Related to the FAQ project for Google Season of Docs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@carolstran @benjie @Urigo @andimarek @IvanGoncharov