From bbd6ff7d7a31558049b65d0bfae85c2a91554d72 Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Tue, 21 Mar 2023 15:41:18 -0400 Subject: [PATCH 1/3] docs(updating): clean up verbiage on updating documents --- docs/updating/4-0.md | 26 +++++++++++++++----------- docs/updating/5-0.md | 16 ++++++++-------- docs/updating/6-0.md | 14 +++++++++----- docs/updating/7-0.md | 10 +++++++--- 4 files changed, 39 insertions(+), 27 deletions(-) diff --git a/docs/updating/4-0.md b/docs/updating/4-0.md index 26013aecfeb..66d8541d916 100644 --- a/docs/updating/4-0.md +++ b/docs/updating/4-0.md @@ -1,13 +1,17 @@ --- -title: Updating to 4.0 +title: Updating to v4 --- -# Updating from Ionic 1-3 to Ionic 4 +# Updating to Ionic 4 -## Migrating from Ionic 3.0 to Ionic 4.0 +## Updating from Ionic 3 to 4 :::note -For a **complete list of breaking changes** from Ionic 3 to Ionic 4, please refer to [the breaking changes document](https://github.com/ionic-team/ionic/blob/master/angular/BREAKING.md) in the Ionic core repo. +This guide assumes that you have already updated your app to the latest version of Ionic 3. If you are using Ionic 1 or 2, Make sure to follow the [Updating from Ionic 1 to 4 Guide](#updating-from-ionic-1-to-4) instead. +::: + +:::caution Breaking Changes +For a **complete list of breaking changes** from Ionic 3 to Ionic 4, please refer to [the breaking changes document](https://github.com/ionic-team/ionic-framework/blob/main/BREAKING_ARCHIVE/v4.md) in the Ionic Framework repository. ::: We suggest the following general process when migrating an existing application from Ionic 3 to 4: @@ -243,11 +247,11 @@ Since v4 moved to Custom Elements, there's been a significant change to the mark To help with these markup changes, we've released a TSLint-based Migration Tool, which detects issues and can even fix some of them automatically. -## Migrating from Ionic 1.0 to Ionic 4.0 +## Updating from Ionic 1 to 4 -### Ionic 1.0 to Ionic 4.0: What’s Involved? +### Ionic 1 to Ionic 4: What’s Involved? -Migrating from Ionic 1 to Ionic 4.0 involves moving from AngularJS (aka Angular 1) to Angular 7+. There are many architectural differences between these versions, so some of the app code will have to be rewritten. The amount of work involved depends on the complexity and size of your app. +Migrating from Ionic 1 to Ionic 4 involves moving from AngularJS (aka Angular 1) to Angular 7+. There are many architectural differences between these versions, so some of the app code will have to be rewritten. The amount of work involved depends on the complexity and size of your app. One upside is that for the most part, the Ionic UI components you know and love from V1 haven’t changed much. @@ -261,9 +265,9 @@ Here are some considerations to review before beginning the upgrade: Once your development team has identified a good time frame for beginning the migration, Ionic recommends feature-freezing the Ionic 1 application and getting the code in order: Fix any major bugs, eliminate tech debt, and reorganize as you see fit. Then, identify which features to migrate over and which to abandon. -Once the Ionic 1 app is stable, create a new Ionic 4.0 project. The majority of the dev team’s attention should be given to the new project; only bugs should be fixed in the Ionic 1 app to ensure that the transition happens as quickly and smoothly as possible. +Once the Ionic 1 app is stable, create a new Ionic 4 project. The majority of the dev team’s attention should be given to the new project; only bugs should be fixed in the Ionic 1 app to ensure that the transition happens as quickly and smoothly as possible. -Once the team is comfortable that the Ionic 4.0 app has become stable and has fulfilled a core set of features, you can then shut down the Ionic 1 app. +Once the team is comfortable that the Ionic 4 app has become stable and has fulfilled a core set of features, you can then shut down the Ionic 1 app. ### Moving From AngularJS to Angular @@ -271,8 +275,8 @@ Please reference official [Angular upgrade guide](https://angular.io/guide/upgra ### Ionic Changes -Our Ionic 3.0 to Ionic 4.0 migration sections above may prove to be a useful reference. Generate a new Ionic 4.0 project using the blank starter (see [Starting an App](../developing/starting.md)). Spend time getting familiar with Ionic 4.0 components. Happy building! +Our Ionic 3 to Ionic 4 migration sections above may prove to be a useful reference. Generate a new Ionic 4 project using the blank starter (see [Starting an App](../developing/starting.md)). Spend time getting familiar with Ionic 4 components. Happy building! ### Need Assistance? -If your team would like assistance with the migration, please [reach out to us](https://ionicframework.com/enterprise-engine)! Ionic offers Advisory Services, which includes Ionic 4.0 training, architecture reviews, and migration assistance. +If your team would like assistance with the migration, please [reach out to us](https://ionicframework.com/enterprise-engine)! Ionic offers Advisory Services, which includes Ionic 4 training, architecture reviews, and migration assistance. diff --git a/docs/updating/5-0.md b/docs/updating/5-0.md index eecf8e47fd8..ad98c2a611e 100644 --- a/docs/updating/5-0.md +++ b/docs/updating/5-0.md @@ -1,18 +1,18 @@ --- -title: Updating to 5.0 +title: Updating to v5 --- -# Updating from Ionic 4 to Ionic 5 +# Updating from Ionic 4 to 5 -Migrating an app from 4.x to 5.x requires a few updates to the API properties, CSS utilities, and the installed package dependencies. +Migrating an app from Ionic 4 to 5 requires a few updates to the API properties, CSS utilities, and the installed package dependencies. :::note -This guide assumes that you have already updated your app to the latest version of Ionic 4. Make sure you have followed the [Upgrading to Ionic 4 Guide](./4-0) before starting this guide. +This guide assumes that you have already updated your app to the latest version of Ionic 4. Make sure you have followed the [Updating to Ionic 4 Guide](./4-0) before starting this guide. ::: -### API and CSS Updates - -For a complete list of breaking changes from 4.x to 5.x, please refer to [the breaking changes document](https://github.com/ionic-team/ionic/blob/master/BREAKING.md#version-5x) in the Ionic core repo. +:::caution Breaking Changes +For a **complete list of breaking changes** from Ionic 4 to Ionic 5, please refer to [the breaking changes document](https://github.com/ionic-team/ionic-framework/blob/main/BREAKING_ARCHIVE/v5.md) in the Ionic Framework repository. +::: ### Packages and Dependencies @@ -34,4 +34,4 @@ For Stencil / vanilla JS projects, you can run: npm i @ionic/core@latest --save ``` -If you would like a fresh project starter, a new project base can be created from the CLI and an existing app can be migrated over manually. \ No newline at end of file +If you would like a fresh project starter, a new project base can be created from the CLI and an existing app can be migrated over manually. diff --git a/docs/updating/6-0.md b/docs/updating/6-0.md index 3ef03a1a1ca..46b2ebf55b4 100644 --- a/docs/updating/6-0.md +++ b/docs/updating/6-0.md @@ -1,11 +1,15 @@ --- -title: Updating to 6.0 +title: Updating to v6 --- -# Updating from Ionic 5 to Ionic 6 +# Updating from Ionic 5 to 6 :::note -This guide assumes that you have already updated your app to the latest version of Ionic 5. Make sure you have followed the [Upgrading to Ionic 5 Guide](./5-0) before starting this guide. +This guide assumes that you have already updated your app to the latest version of Ionic 5. Make sure you have followed the [Updating to Ionic 5 Guide](./5-0) before starting this guide. +::: + +:::caution Breaking Changes +For a **complete list of breaking changes** from Ionic 5 to Ionic 6, please refer to [the breaking changes document](https://github.com/ionic-team/ionic-framework/blob/main/BREAKING.md) in the Ionic Framework repository. ::: ## Getting Started @@ -190,7 +194,7 @@ This applies to `ion-action-sheet`, `ion-alert`, `ion-loading`, `ion-modal`, `io