Skip to content

Commit

Permalink
Merge pull request #2182 from spryker/feature/cc-31334-chart-module-m…
Browse files Browse the repository at this point in the history
…igration-guide

CC-31334 Migration guide: Chart module.
  • Loading branch information
lenadoc authored Oct 11, 2023
2 parents 272f1cc + 68bb646 commit 58b66ea
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 3 deletions.
6 changes: 6 additions & 0 deletions _data/sidebars/pbc_all_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ entries:
nested:
- title: View Dashboard
url: /docs/pbc/all/back-office/manage-in-the-back-office/view-dashboard.html
- title: Install and upgrade
nested:
- title: Upgrade modules
nested:
- title: Chart
url: /docs/pbc/all/back-office/install-and-upgrade/upgrade-modules/upgrade-the-chart-module.html
- title: Carrier Management
url: /docs/pbc/all/carrier-management/carrier-management.html
nested:
Expand Down
39 changes: 39 additions & 0 deletions _includes/pbc/all/upgrade-modules/upgrade-the-chart-module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## Upgrading from version 1.4.0 to version 1.5.0

In version 1.5.0 of the Chart module, we've updated the `plotly.js` dependency from version 1.54.5 to 2.26.0. For more details about the changes, see the [Chart module release page](https://github.com/spryker/chart/releases).

Upgrade to the latest major version to incorporate the latest improvements and optimize both runtime and processing performance.


*Estimated migration time: 15 min*

To upgrade to the new version of the module, do the following:

1. Upgrade the Chart module to the new version:

```bash
composer update spryker/chart:"^1.5.0" --update-with-dependencies
```

2. The 1.5.0 module version requires an update of the `@spryker/oryx-for-zed` dependency to version 3.1 or later, as well as an update of the `webpack` dependency to version 5.88 or later at the project level.
To perform the updates, in the root `package.json` file, update the dependencies to the following versions or newer:

```json
{
"@spryker/oryx-for-zed": "^3.1.0",
"webpack": "^5.88.2"
}
```

3. Run and build the Back Office frontend:

```bash
docker/sdk cli npm install
docker/sdk up --assets
```

or

```bash
npm install && npm run zed
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Upgrade the Chart module
description: Use the guide to learn how to update the Chart module to a newer version.
last_updated: Sep 18, 2023
template: module-migration-guide-template
---

{% include pbc/all/upgrade-modules/upgrade-the-chart-module.md %} <!-- To edit, see /_includes/pbc/all/upgrade-modules/upgrade-the-chart-module.md -->
8 changes: 5 additions & 3 deletions docs/scos/dev/migration-concepts/upgrade-to-angular-15.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ Our current version of Angular is v12 with v9 compatibility.
Angular v12 was deprecated on 2022-11-12, according to the [policy](https://angular.io/guide/releases#support-policy-and-schedule).
The current stable version of Angular is v15.

We need to upgrade to the latest major to get the latest bug fixes and security fixes, as well as performance in runtime and tooling.
We can't maintain compatibility with older versions of Angular when updating Angular v15.
So the update requires a major release for these modules:

Upgrade to the latest major version of Angular to get the most recent bug fixes and security updates. Additionally, this will lead to optimization in both runtime performance and tooling.

Keep in mind that updating to Angular v15 results in incompatibility with older versions of Angular. Therefore, a major release is necessary for these modules:

- `ZedUi`
- `DashboardMerchantPortalGui`
- `GuiTable`
Expand Down

0 comments on commit 58b66ea

Please sign in to comment.