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

[Doc] graphql tutorial #2432

Merged
merged 8 commits into from
May 27, 2020
Merged

Conversation

jcalcaben
Copy link
Contributor

Description

This topic creates a tutorial about using GraphQL in PWA Studio.

Related Issue

Closes PWA-307

Acceptance

Any developer

Verification Stakeholders

Any developer

Specification

Verification Steps

  1. Navigate to the pwa-devdocs directory: cd pwa-devdocs
  2. Run the linter: yarn lint src/tutorials/pwa-studio-fundamentals/work-with-graphql
  3. Verify no linting issues
  4. Start the preview server: yarn develop
  5. Navigate to the tutorials section
  6. Verify topic is listed on the left navigation and linked to the correct page

Screenshots / Screen Captures (if appropriate)

Checklist

  • I have updated the documentation accordingly, if necessary.
    [ ] I have added tests to cover my changes, if necessary.

@jcalcaben jcalcaben added pkg:pwa-devdocs documentation This pertains to documentation. docs documentation labels May 26, 2020
@m2-community-project m2-community-project bot added this to Ready for Review in Pull Request Progress May 26, 2020
@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented May 26, 2020

Fails
🚫 A version label is required. A maintainer must add one.
Messages
📖

Access a deployed version of this PR here. Make sure to wait for the "pwa-pull-request-deploy" job to complete.

📖 DangerCI Failures related to missing labels/description/linked issues/etc will persist until the next push or next nightly build run (assuming they are fixed).
📖

Associated JIRA tickets: PWA-307.

Generated by 🚫 dangerJS against 79f2281

@devops-pwa-codebuild
Copy link
Collaborator

devops-pwa-codebuild commented May 26, 2020

Performance Test Results

The following fails have been reported by WebpageTest. These numbers indicates a possible performance issue with the PR which requires further manual testing to validate.

https://pr-2432.pwa-venia.com : LH Performance Expected 0.85 Actual 0.52, LH Best Practices Expected 1 Actual 0.92, WPT Cache Expected 90 Actual 88
https://pr-2432.pwa-venia.com/venia-tops.html : LH Performance Expected 0.75 Actual 0.35, LH Best Practices Expected 1 Actual 0.92
https://pr-2432.pwa-venia.com/valeria-two-layer-tank.html : LH Performance Expected 0.8 Actual 0.51, LH Accessibility Expected 0.9 Actual 0.89, LH Best Practices Expected 1 Actual 0.92

supernova-at
supernova-at previously approved these changes May 26, 2020
Copy link
Contributor

@supernova-at supernova-at 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! We have started to export objects from our .gql.js files in the shape of

{
  queries: {}
  mutations: {}
}

but I don't think that's too important to capture here.

Likewise, there's some stylistic differences around checking for and displaying Loading. Instead of doing Loading at the end, we usually explicitly check for loading and "early out" render a Loading state.

Again, I'm not sure that makes much difference here.

@m2-community-project m2-community-project bot moved this from Ready for Review to Reviewer Approved in Pull Request Progress May 26, 2020
supernova-at
supernova-at previously approved these changes May 27, 2020
Copy link
Contributor

@supernova-at supernova-at left a comment

Choose a reason for hiding this comment

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

Quick typo fix then 👍

…aphql/index.md

Co-authored-by: Andy Terranova <13182778+supernova-at@users.noreply.github.com>
@dpatil-magento dpatil-magento merged commit 5665e5c into develop May 27, 2020
@dpatil-magento dpatil-magento deleted the jimothy/pwa-307_graphql-tutorial branch May 27, 2020 22:39
@m2-community-project m2-community-project bot moved this from Reviewer Approved to Done in Pull Request Progress May 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation documentation This pertains to documentation. pkg:pwa-devdocs
Development

Successfully merging this pull request may close these issues.

None yet

5 participants