From 1272fe7177376bcea36e7ad37b1a843fa2482cfe Mon Sep 17 00:00:00 2001 From: James Calcaben Date: Mon, 25 Mar 2019 12:27:39 -0500 Subject: [PATCH] Add compatibility explanation to Magento compatibility table (#1059) --- .../magento-compatibility/index.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/pwa-devdocs/src/technologies/magento-compatibility/index.md b/pwa-devdocs/src/technologies/magento-compatibility/index.md index 9438065112..fee5103e80 100644 --- a/pwa-devdocs/src/technologies/magento-compatibility/index.md +++ b/pwa-devdocs/src/technologies/magento-compatibility/index.md @@ -7,4 +7,29 @@ This page lists PWA Studio versions and their compatible Magento core version. + {% include auto-generated/magento-compatibility.md %} + +## What compatibility means + +If you are working directly with the PWA Studio repository, make sure the version you are working with is compatible with your Magento backend. + +GraphQL queries in Venia are a main source of incompatibility between versions. +Breaking GraphQL schema changes in Magento require an update to the GraphQL queries used in the Venia storefront. + +## Incompatibility scenarios + +- A developer has the latest PWA Studio, such as **2.1.0** or greater, but the `MAGENTO_BACKEND_URL` still points to a Magento 2 instance running **2.3.0**. +- A developer is running an older version of PWA Studio, such as **2.0.0**, but the `MAGENTO_BACKEND_URL` points to a Magento 2 instance running **2.3.1**. + +## Compatibility checks + +Since **2.1.0**, PWA Studio includes a query validation step during the build process. +This step reports on any GraphQL incompatibility it encounters. + +## Solving compatibility issues + +Developers have two options for solving compatibility issues: + +- Upgrade or downgrade the PWA Studio version to match the Magento 2 backend version +- Upgrade or downgrade the backend Magento 2 version to match the PWA Studio version