From db439d24b04f205b8f6f9450ebce05df5edcac24 Mon Sep 17 00:00:00 2001 From: Marcin Kwiatkowski Date: Fri, 10 Jun 2022 13:54:58 +0200 Subject: [PATCH] docs: added 1.0.0-rc.9 migration guide --- docs/.vuepress/config.js | 19 +++++- docs/guide/supported-features.md | 2 +- docs/migration-guides/1.0.0-rc.8/index.md | 2 +- docs/migration-guides/1.0.0-rc.9/index.md | 64 ++++++++++++++++++++ docs/migration-guides/1.0.0-rc.9/rc.9-bic.md | 21 +++++++ docs/migration-guides/index.md | 1 + 6 files changed, 105 insertions(+), 4 deletions(-) create mode 100644 docs/migration-guides/1.0.0-rc.9/index.md create mode 100644 docs/migration-guides/1.0.0-rc.9/rc.9-bic.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 46b41dffb..8d0efcddc 100755 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -4,7 +4,17 @@ module.exports = { title: 'Vue Storefront 2 for Magento', base: '/', description: 'Documentation for the Magento connector for Vue Storefront 2', - head: [['link', { rel: 'icon', href: '/favicon.png' }]], + head: [ + ['link', { rel: 'icon', href: '/favicon.png' }], + // Google Tag Manager + ['script', {}, [` + (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': + new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], + j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= + 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); + })(window,document,'script','dataLayer','${GTM_TAG}'); + `]], + ], /** * Ref：https://v1.vuepress.vuejs.org/config/#configurewebpack @@ -54,6 +64,7 @@ module.exports = { '@vuepress/search', ], themeConfig: { + GTM_TAG, sidebarDepth: 0, repo: 'https://github.com/vuestorefront/magento2/', editLinks: true, @@ -64,10 +75,13 @@ module.exports = { nav: [ { text: 'Vue Storefront', link: 'https://vuestorefront.io/' }, { text: 'Core Documentation', link: 'https://docs.vuestorefront.io/v2/' }, + { text: 'Demo', link: 'https://demo-magento2.europe-west1.gcp.storefrontcloud.io/' }, + { text: 'GitHub', link: 'https://github.com/vuestorefront/magento2' }, + { text: 'Environments', link: 'https://docs.vuestorefront.io/magento/guide/environments.html' }, ], sidebar: [ { - title: '', + title: 'Essentials', collapsable: false, children: [ ['/', 'Introduction'], @@ -132,6 +146,7 @@ module.exports = { children: [ ['/plugins/', 'Plugins'], ['/api-reference/', 'API Reference'], + ['/migration-guides/', 'Migration Guides'], ], }, { diff --git a/docs/guide/supported-features.md b/docs/guide/supported-features.md index bb4feaf67..d5336e64a 100644 --- a/docs/guide/supported-features.md +++ b/docs/guide/supported-features.md @@ -30,7 +30,7 @@ This page shows the Magento 2 features supported by this integration. If the fea | Grid/list mode | ✅ | | Adding product to cart | ✅ | | Adding product to wishlist | ✅ | -| Configurable product swatches | ✅ | +| Configurable product swatches | ❌ | | Filtering | ✅ | | Sorting | ✅ | | Breadcrumb | ✅ | diff --git a/docs/migration-guides/1.0.0-rc.8/index.md b/docs/migration-guides/1.0.0-rc.8/index.md index d2b59374e..4f318e915 100644 --- a/docs/migration-guides/1.0.0-rc.8/index.md +++ b/docs/migration-guides/1.0.0-rc.8/index.md @@ -2,7 +2,7 @@ Vue Storefront for Magento 1.0.0.rc.8 contains backward-incompatible changes. To review these backward-incompatible changes, see -[1.0.0-rc.7 **Backward incompatible changes reference**](./rc.8-bic.md) +[1.0.0-rc.8 **Backward incompatible changes reference**](./rc.8-bic.md) ## Vue Storefront for Magento 1.0.0-rc.8 highlights diff --git a/docs/migration-guides/1.0.0-rc.9/index.md b/docs/migration-guides/1.0.0-rc.9/index.md new file mode 100644 index 000000000..ddae70a2c --- /dev/null +++ b/docs/migration-guides/1.0.0-rc.9/index.md @@ -0,0 +1,64 @@ +# Vue Storefront for Magento 1.0.0-rc.9 release notes + +Vue Storefront for Magento 1.0.0.rc.9 contains backward-incompatible changes. To review these backward-incompatible changes, see + +[1.0.0-rc.9 **Backward incompatible changes reference**](./rc.9-bic.md) + +## Vue Storefront for Magento 1.0.0-rc.9 highlights + +### New f**eatures** + +- feat: added productSkeleton component [#1097](https://github.com/vuestorefront/magento2/pull/1097) +- feat: add configurable filters [#1060](https://github.com/vuestorefront/magento2/pull/1060) + +### **Bugfix** + +- fix!: search bar not returning results [#1087](https://github.com/vuestorefront/magento2/pull/1087) +- fix: total price and discount calculation [#1090](https://github.com/vuestorefront/magento2/pull/1090) +- fix: removed filters skeleton on mobile devices [#1100](https://github.com/vuestorefront/magento2/pull/1100) +- fix: category page filters are taken off after using pagination [#1093](https://github.com/vuestorefront/magento2/pull/1093) +- fix: bundle product option change special price calculation +- fix: grouped product special price calculation [#1069](https://github.com/vuestorefront/magento2/pull/1069) +- fix: category page header invalid title +- fix: disable body scroll lock [#1059](https://github.com/vuestorefront/magento2/pull/1059) +- fix: fetch new orders on each orders history visit AND move order information to separate section [#1046](https://github.com/vuestorefront/magento2/pull/1046) + +### Refactors + +- refactor!: refactor the useApi composable [#1104](https://github.com/vuestorefront/magento2/pull/1107 https://github.com/vuestorefront/magento2/pull/1104) +- refactor: make unit tests typing work even when theme is moved to template-magento [#1091](https://github.com/vuestorefront/magento2/pull/1091) +- refactor: remove some instances of implicit any [#1066](https://github.com/vuestorefront/magento2/pull/1066) +- refactor: double-check types in composables [#1085](https://github.com/vuestorefront/magento2/pull/1085) +- refactor!: refactored useUrlResolver to use the route query [#1078](https://github.com/vuestorefront/magento2/pull/1078) +- refactor!: break down login modal into separate components [#1095](https://github.com/vuestorefront/magento2/pull/1095) +- refactor: use null instead of {} [#1068](https://github.com/vuestorefront/magento2/pull/1068) +- refactor: improve typing of sorting in facetGetters/category.vue [#1080](https://github.com/vuestorefront/magento2/pull/1080) +- refactor: add interface for useProductsWithCommonCardProps [#1086](https://github.com/vuestorefront/magento2/pull/1086) +- refactor: remove a few more instances of implicit any [#1071](https://github.com/vuestorefront/magento2/pull/1071) +- refactor: add types for HeaderNavigation*.vue components [#1079](https://github.com/vuestorefront/magento2/pull/1079) +- refactor!: add typing for VsfPaymentProvider.vue [#1077](https://github.com/vuestorefront/magento2/pull/1077) +- refactor: connection to api refactor [https://github.com/vuestorefront/magento2/pull/1101](https://github.com/vuestorefront/magento2/pull/1101) +- refactor: remove useless function [#1083](https://github.com/vuestorefront/magento2/pull/1083) +- refactor: fixed customer logging and authorization checking [#1081](https://github.com/vuestorefront/magento2/pull/1081) +- refactor: resolve all todos [#1064](https://github.com/vuestorefront/magento2/pull/1064) + +### Tests + +- test: added tests for selectedfilters component [#1067](https://github.com/vuestorefront/magento2/pull/1067) +- test: add tests for filter renderers [#1065](https://github.com/vuestorefront/magento2/pull/1065) +- test: added tests for categoryfilters component [#1076](https://github.com/vuestorefront/magento2/pull/1076) +- test: added tests for category sidebar component [#1028](https://github.com/vuestorefront/magento2/pull/1028) +- test: add CategorySidebar tests [#1103](https://github.com/vuestorefront/magento2/pull/1103) + +### Chore + +- chore: fix all remaining .vue lang="ts" errors [#1043](https://github.com/vuestorefront/magento2/pull/1043) +- chore: updated contributors list [#1074](https://github.com/vuestorefront/magento2/pull/1074) + +### Documentation + +- docs: added documentation about global state management [#1072](https://github.com/vuestorefront/magento2/pull/1072) +- docs: add catalog module documentation [#1082](https://github.com/vuestorefront/magento2/pull/1082) +- docs: fix typos in Composables document [#1102](https://github.com/vuestorefront/magento2/pull/1102) +- docs: new Installation document and image optimization [#1084](https://github.com/vuestorefront/magento2/pull/1084) +- docs: add composables docs [#1062](https://github.com/vuestorefront/magento2/pull/1062) diff --git a/docs/migration-guides/1.0.0-rc.9/rc.9-bic.md b/docs/migration-guides/1.0.0-rc.9/rc.9-bic.md new file mode 100644 index 000000000..4042f89ed --- /dev/null +++ b/docs/migration-guides/1.0.0-rc.9/rc.9-bic.md @@ -0,0 +1,21 @@ +# 1.0.0-rc.9 Backward incompatible changes reference + +In this document, you can see crucial breaking changes in the `1.0.0-rc.9` comparing to `1.0.0-rc.8` release. To see all changes, please take a look at the [release pull request](https://github.com/vuestorefront/magento2/pull/1110) + +## Theme + +| File | what and how it changed | +|------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------| +| packages/theme/components/Checkout/VsfPaymentProvider.vue | names of variables have been changed | +| packages/theme/components/LoginModal.vue | The file has been moved to packages/theme/modules/customer/components/LoginModal/LoginModal.vue | +| packages/theme/components/NewProducts.vue | :is-added-to-cart event argument has been changed | +| packages/theme/composables/useApi/index.ts | From now the useApi use methods from ApiClient (customQuery, customMutation) to communicate with Magento API | +| packages/theme/composables/useUrlResolver/index.ts | changed GraphQL query to the route query | +| packages/theme/modules/catalog/category/stores/category.ts | from now it uses API client to fetch data instead of graphql plugin | +| packages/theme/modules/catalog/pages/category.vue | SfPagination is replaced by the new CategoryPagination components, values of props and variables have been changed | +| All *.gql.ts files in the theme package | changed the `gql` dependency import from graphq-request to graphql-tag | +| packages/theme/modules/catalog/product/components/ProductsCarousel.vue | :is-added-to-cart event argument has been changed | +| packages/theme/modules/customer/getters/userShippingGetters.ts | getters names have been changed | +| packages/theme/modules/customer/pages/MyAccount/MyWishlist.vue | :is-added-to-cart event argument has been changed | +| packages/theme/nuxt.config.js | GraphQL plugin has been removed | +| packages/theme/plugins/storeConfigPlugin.ts | from now it uses API client to fetch data instead of graphql plugin | diff --git a/docs/migration-guides/index.md b/docs/migration-guides/index.md index ffd32ebb3..af51b5602 100644 --- a/docs/migration-guides/index.md +++ b/docs/migration-guides/index.md @@ -2,3 +2,4 @@ - [1.0.0-rc.7](./1.0.0-rc.7/) - [1.0.0-rc.8](./1.0.0-rc.8/) +- [1.0.0-rc.9](./1.0.0-rc.9/)