Skip to content
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

Curate new FAQ sections and add more answers #982

Merged
merged 12 commits into from Dec 21, 2020
Merged

Conversation

carolstran
Copy link
Member

@carolstran carolstran commented Nov 26, 2020

πŸ’“ This PR is part of Google Season of Docs πŸ’“

This PR breaks the existing questions into 5 sections:

  • Getting Started
  • General
  • Best Practices
  • Specification
  • Frontend

πŸ‘©πŸΌβ€πŸŽ¨ ⚠️ The final design will be implemented in a separate PR to this branch, so please focus on reviewing the content.

Here are the new questions and answers I've added, sorted by section:

General

  • Does GraphQL use HTTP?
  • How does GraphQL affect my product’s performance?
  • Does GraphQL replace ORMs?
  • Who is behind GraphQL?

Best Practices

  • Is GraphQL scalable?
  • Does GraphQL support offline usage?
  • What are the security concerns with GraphQL?
  • How can I set up authorization with GraphQL?
  • How does authentication work with GraphQL?
  • Is GraphQL the right fit for designing a microservice architecture?
  • How does versioning work in GraphQL?
  • How can I document my GraphQL API?

Specification

  • What is the best way to follow specification releases?
  • Where is the documentation for subscriptions?

Frontend

  • Does GraphQL replace Redux or other state management libraries?

@carolstran carolstran added the πŸ’¬ FAQ Related to the FAQ project for Google Season of Docs. label Nov 26, 2020
@carolstran carolstran self-assigned this Nov 26, 2020
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.

Looks good to me; couple suggestions but I approve πŸ‘

src/content/faq/General.md Outdated Show resolved Hide resolved
src/content/faq/General.md Outdated Show resolved Hide resolved
carolstran and others added 2 commits December 1, 2020 18:51
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.

amazing work as usual.
I'm very excited you highlighted the Authentication and Authorization parts!

@carolstran
Copy link
Member Author

Marking this as On hold until #985 is merged, then I'll do a big merge with all of the updates. If anyone wants to review that PR, I'd appreciate it πŸ™πŸΌ

@carolstran
Copy link
Member Author

@IvanGoncharov I noticed you approved #985 and since this PR was mostly for content review, would it be alright if I merged both later today? Then we can discuss any follow-up issues we want to address or open.

carolstran and others added 2 commits December 21, 2020 21:16
Co-authored-by: Ivan Goncharov <ivan.goncharov.ua@gmail.com>
carolstran added a commit that referenced this pull request Dec 21, 2020
@carolstran carolstran merged commit ddd32ac into source Dec 21, 2020
@carolstran carolstran deleted the faq-new-sections branch December 21, 2020 20:54
carolstran added a commit that referenced this pull request Dec 21, 2020
carolstran added a commit that referenced this pull request Dec 21, 2020
* Initial commit new FAQ design

* Finally something rendering

* Add sidebar

* Jk remove the sidebar again

* Add useAccordion hook

* Move FAQ specific CSS into its own less file

* Fix scrolling issue and keyboard accessibility

* Workaround for gatsby build error

* Remove broken transitions

* Update based on code review in #982
Urigo pushed a commit that referenced this pull request Jan 26, 2021
* Initial design - not pretty

* Add missing answers

* Fix sentence structure

* Apply suggestions from Benjie's code review

Co-authored-by: Benjie Gillam <benjie@jemjie.com>

* Apply suggestions from Ivan's code review

Co-authored-by: Ivan Goncharov <ivan.goncharov.ua@gmail.com>
Urigo pushed a commit that referenced this pull request Jan 26, 2021
* Initial commit new FAQ design

* Finally something rendering

* Add sidebar

* Jk remove the sidebar again

* Add useAccordion hook

* Move FAQ specific CSS into its own less file

* Fix scrolling issue and keyboard accessibility

* Workaround for gatsby build error

* Remove broken transitions

* Update based on code review in #982
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
πŸ’¬ FAQ Related to the FAQ project for Google Season of Docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants