Skip to content

Commit db439d2

Browse files
author
Marcin Kwiatkowski
committed
docs: added 1.0.0-rc.9 migration guide
1 parent e62ac09 commit db439d2

File tree

6 files changed

+105
-4
lines changed

6 files changed

+105
-4
lines changed

docs/.vuepress/config.js

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,17 @@ module.exports = {
44
title: 'Vue Storefront 2 for Magento',
55
base: '/',
66
description: 'Documentation for the Magento connector for Vue Storefront 2',
7-
head: [['link', { rel: 'icon', href: '/favicon.png' }]],
7+
head: [
8+
['link', { rel: 'icon', href: '/favicon.png' }],
9+
// Google Tag Manager
10+
['script', {}, [`
11+
(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
12+
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
13+
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
14+
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
15+
})(window,document,'script','dataLayer','${GTM_TAG}');
16+
`]],
17+
],
818

919
/**
1020
* Ref:https://v1.vuepress.vuejs.org/config/#configurewebpack
@@ -54,6 +64,7 @@ module.exports = {
5464
'@vuepress/search',
5565
],
5666
themeConfig: {
67+
GTM_TAG,
5768
sidebarDepth: 0,
5869
repo: 'https://github.com/vuestorefront/magento2/',
5970
editLinks: true,
@@ -64,10 +75,13 @@ module.exports = {
6475
nav: [
6576
{ text: 'Vue Storefront', link: 'https://vuestorefront.io/' },
6677
{ text: 'Core Documentation', link: 'https://docs.vuestorefront.io/v2/' },
78+
{ text: 'Demo', link: 'https://demo-magento2.europe-west1.gcp.storefrontcloud.io/' },
79+
{ text: 'GitHub', link: 'https://github.com/vuestorefront/magento2' },
80+
{ text: 'Environments', link: 'https://docs.vuestorefront.io/magento/guide/environments.html' },
6781
],
6882
sidebar: [
6983
{
70-
title: '',
84+
title: 'Essentials',
7185
collapsable: false,
7286
children: [
7387
['/', 'Introduction'],
@@ -132,6 +146,7 @@ module.exports = {
132146
children: [
133147
['/plugins/', 'Plugins'],
134148
['/api-reference/', 'API Reference'],
149+
['/migration-guides/', 'Migration Guides'],
135150
],
136151
},
137152
{

docs/guide/supported-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This page shows the Magento 2 features supported by this integration. If the fea
3030
| Grid/list mode ||
3131
| Adding product to cart ||
3232
| Adding product to wishlist ||
33-
| Configurable product swatches | |
33+
| Configurable product swatches | |
3434
| Filtering ||
3535
| Sorting ||
3636
| Breadcrumb ||

docs/migration-guides/1.0.0-rc.8/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Vue Storefront for Magento 1.0.0.rc.8 contains backward-incompatible changes. To review these backward-incompatible changes, see
44

5-
[1.0.0-rc.7 **Backward incompatible changes reference**](./rc.8-bic.md)
5+
[1.0.0-rc.8 **Backward incompatible changes reference**](./rc.8-bic.md)
66

77
## Vue Storefront for Magento 1.0.0-rc.8 highlights
88

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Vue Storefront for Magento 1.0.0-rc.9 release notes
2+
3+
Vue Storefront for Magento 1.0.0.rc.9 contains backward-incompatible changes. To review these backward-incompatible changes, see
4+
5+
[1.0.0-rc.9 **Backward incompatible changes reference**](./rc.9-bic.md)
6+
7+
## Vue Storefront for Magento 1.0.0-rc.9 highlights
8+
9+
### New f**eatures**
10+
11+
- feat: added productSkeleton component [#1097](https://github.com/vuestorefront/magento2/pull/1097)
12+
- feat: add configurable filters [#1060](https://github.com/vuestorefront/magento2/pull/1060)
13+
14+
### **Bugfix**
15+
16+
- fix!: search bar not returning results [#1087](https://github.com/vuestorefront/magento2/pull/1087)
17+
- fix: total price and discount calculation [#1090](https://github.com/vuestorefront/magento2/pull/1090)
18+
- fix: removed filters skeleton on mobile devices [#1100](https://github.com/vuestorefront/magento2/pull/1100)
19+
- fix: category page filters are taken off after using pagination [#1093](https://github.com/vuestorefront/magento2/pull/1093)
20+
- fix: bundle product option change special price calculation
21+
- fix: grouped product special price calculation [#1069](https://github.com/vuestorefront/magento2/pull/1069)
22+
- fix: category page header invalid title
23+
- fix: disable body scroll lock [#1059](https://github.com/vuestorefront/magento2/pull/1059)
24+
- fix: fetch new orders on each orders history visit AND move order information to separate section [#1046](https://github.com/vuestorefront/magento2/pull/1046)
25+
26+
### Refactors
27+
28+
- refactor!: refactor the useApi composable [#1104](https://github.com/vuestorefront/magento2/pull/1107 https://github.com/vuestorefront/magento2/pull/1104)
29+
- refactor: make unit tests typing work even when theme is moved to template-magento [#1091](https://github.com/vuestorefront/magento2/pull/1091)
30+
- refactor: remove some instances of implicit any [#1066](https://github.com/vuestorefront/magento2/pull/1066)
31+
- refactor: double-check types in composables [#1085](https://github.com/vuestorefront/magento2/pull/1085)
32+
- refactor!: refactored useUrlResolver to use the route query [#1078](https://github.com/vuestorefront/magento2/pull/1078)
33+
- refactor!: break down login modal into separate components [#1095](https://github.com/vuestorefront/magento2/pull/1095)
34+
- refactor: use null instead of {} [#1068](https://github.com/vuestorefront/magento2/pull/1068)
35+
- refactor: improve typing of sorting in facetGetters/category.vue [#1080](https://github.com/vuestorefront/magento2/pull/1080)
36+
- refactor: add interface for useProductsWithCommonCardProps [#1086](https://github.com/vuestorefront/magento2/pull/1086)
37+
- refactor: remove a few more instances of implicit any [#1071](https://github.com/vuestorefront/magento2/pull/1071)
38+
- refactor: add types for HeaderNavigation*.vue components [#1079](https://github.com/vuestorefront/magento2/pull/1079)
39+
- refactor!: add typing for VsfPaymentProvider.vue [#1077](https://github.com/vuestorefront/magento2/pull/1077)
40+
- refactor: connection to api refactor [https://github.com/vuestorefront/magento2/pull/1101](https://github.com/vuestorefront/magento2/pull/1101)
41+
- refactor: remove useless function [#1083](https://github.com/vuestorefront/magento2/pull/1083)
42+
- refactor: fixed customer logging and authorization checking [#1081](https://github.com/vuestorefront/magento2/pull/1081)
43+
- refactor: resolve all todos [#1064](https://github.com/vuestorefront/magento2/pull/1064)
44+
45+
### Tests
46+
47+
- test: added tests for selectedfilters component [#1067](https://github.com/vuestorefront/magento2/pull/1067)
48+
- test: add tests for filter renderers [#1065](https://github.com/vuestorefront/magento2/pull/1065)
49+
- test: added tests for categoryfilters component [#1076](https://github.com/vuestorefront/magento2/pull/1076)
50+
- test: added tests for category sidebar component [#1028](https://github.com/vuestorefront/magento2/pull/1028)
51+
- test: add CategorySidebar tests [#1103](https://github.com/vuestorefront/magento2/pull/1103)
52+
53+
### Chore
54+
55+
- chore: fix all remaining .vue lang="ts" errors [#1043](https://github.com/vuestorefront/magento2/pull/1043)
56+
- chore: updated contributors list [#1074](https://github.com/vuestorefront/magento2/pull/1074)
57+
58+
### Documentation
59+
60+
- docs: added documentation about global state management [#1072](https://github.com/vuestorefront/magento2/pull/1072)
61+
- docs: add catalog module documentation [#1082](https://github.com/vuestorefront/magento2/pull/1082)
62+
- docs: fix typos in Composables document [#1102](https://github.com/vuestorefront/magento2/pull/1102)
63+
- docs: new Installation document and image optimization [#1084](https://github.com/vuestorefront/magento2/pull/1084)
64+
- docs: add composables docs [#1062](https://github.com/vuestorefront/magento2/pull/1062)
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# 1.0.0-rc.9 Backward incompatible changes reference
2+
3+
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)
4+
5+
## Theme
6+
7+
| File | what and how it changed |
8+
|------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
9+
| packages/theme/components/Checkout/VsfPaymentProvider.vue | names of variables have been changed |
10+
| packages/theme/components/LoginModal.vue | The file has been moved to packages/theme/modules/customer/components/LoginModal/LoginModal.vue |
11+
| packages/theme/components/NewProducts.vue | :is-added-to-cart event argument has been changed |
12+
| packages/theme/composables/useApi/index.ts | From now the useApi use methods from ApiClient (customQuery, customMutation) to communicate with Magento API |
13+
| packages/theme/composables/useUrlResolver/index.ts | changed GraphQL query to the route query |
14+
| packages/theme/modules/catalog/category/stores/category.ts | from now it uses API client to fetch data instead of graphql plugin |
15+
| packages/theme/modules/catalog/pages/category.vue | SfPagination is replaced by the new CategoryPagination components, values of props and variables have been changed |
16+
| All *.gql.ts files in the theme package | changed the `gql` dependency import from graphq-request to graphql-tag |
17+
| packages/theme/modules/catalog/product/components/ProductsCarousel.vue | :is-added-to-cart event argument has been changed |
18+
| packages/theme/modules/customer/getters/userShippingGetters.ts | getters names have been changed |
19+
| packages/theme/modules/customer/pages/MyAccount/MyWishlist.vue | :is-added-to-cart event argument has been changed |
20+
| packages/theme/nuxt.config.js | GraphQL plugin has been removed |
21+
| packages/theme/plugins/storeConfigPlugin.ts | from now it uses API client to fetch data instead of graphql plugin |

docs/migration-guides/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22

33
- [1.0.0-rc.7](./1.0.0-rc.7/)
44
- [1.0.0-rc.8](./1.0.0-rc.8/)
5+
- [1.0.0-rc.9](./1.0.0-rc.9/)

0 commit comments

Comments
 (0)