Skip to content

Commit 45f7feb

Browse files
docs(updating): clean up verbiage and broken links on migration guides (#2842)
1 parent 8c65f1a commit 45f7feb

File tree

4 files changed

+43
-31
lines changed

4 files changed

+43
-31
lines changed

docs/updating/4-0.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
---
2-
title: Updating to 4.0
2+
title: Updating to v4
33
---
44

5-
# Updating from Ionic 1-3 to Ionic 4
5+
# Updating to Ionic 4
66

7-
## Migrating from Ionic 3.0 to Ionic 4.0
7+
## Updating from Ionic 3 to 4
88

99
:::note
10-
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.
10+
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.
11+
:::
12+
13+
:::info Breaking Changes
14+
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.
1115
:::
1216

1317
We suggest the following general process when migrating an existing application from Ionic 3 to 4:
@@ -32,7 +36,7 @@ In Ionic 4, the package name is `@ionic/angular`. Uninstall Ionic 3 and install
3236

3337
```shell
3438
$ npm uninstall ionic-angular
35-
$ npm install @ionic/angular
39+
$ npm install @ionic/angular@v4-lts
3640
```
3741

3842
While migrating an app, update the imports from `ionic-angular` to `@ionic/angular`.
@@ -243,11 +247,11 @@ Since v4 moved to Custom Elements, there's been a significant change to the mark
243247

244248
To help with these markup changes, we've released a TSLint-based <a href="https://github.com/ionic-team/v4-migration-tslint" target="_blank">Migration Tool</a>, which detects issues and can even fix some of them automatically.
245249

246-
## Migrating from Ionic 1.0 to Ionic 4.0
250+
## Updating from Ionic 1 to 4
247251

248-
### Ionic 1.0 to Ionic 4.0: What’s Involved?
252+
### Ionic 1 to Ionic 4: What’s Involved?
249253

250-
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.
254+
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.
251255

252256
One upside is that for the most part, the Ionic UI components you know and love from V1 haven’t changed much.
253257

@@ -261,18 +265,18 @@ Here are some considerations to review before beginning the upgrade:
261265

262266
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.
263267

264-
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.
268+
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.
265269

266-
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.
270+
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.
267271

268272
### Moving From AngularJS to Angular
269273

270274
Please reference official [Angular upgrade guide](https://angular.io/guide/upgrade) information.
271275

272276
### Ionic Changes
273277

274-
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!
278+
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!
275279

276280
### Need Assistance?
277281

278-
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.
282+
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.

docs/updating/5-0.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
---
2-
title: Updating to 5.0
2+
title: Updating to v5
33
---
44

5-
# Updating from Ionic 4 to Ionic 5
5+
# Updating from Ionic 4 to 5
66

7-
Migrating an app from 4.x to 5.x requires a few updates to the API properties, CSS utilities, and the installed package dependencies.
7+
Migrating an app from Ionic 4 to 5 requires a few updates to the API properties, CSS utilities, and the installed package dependencies.
88

99
:::note
10-
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.
10+
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.
1111
:::
1212

13-
### API and CSS Updates
14-
15-
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.
13+
:::info Breaking Changes
14+
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.
15+
:::
1616

1717
### Packages and Dependencies
1818

1919
For Angular based projects, you can simply run:
2020

2121
```shell
22-
npm install @ionic/angular@latest @ionic/angular-toolkit@latest --save
22+
npm install @ionic/angular@v5-lts @ionic/angular-toolkit@4.0.0 --save
2323
```
2424

2525
For React projects, you can run:
2626

2727
```shell
28-
npm install @ionic/react@latest @ionic/react-router@latest ionicons@latest
28+
npm install @ionic/react@v5-lts @ionic/react-router@v5-lts ionicons@5.5.3
2929
```
3030

3131
For Stencil / vanilla JS projects, you can run:
3232

3333
```shell
34-
npm i @ionic/core@latest --save
34+
npm i @ionic/core@v5-lts --save
3535
```
3636

37-
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.
37+
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.

docs/updating/6-0.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
---
2-
title: Updating to 6.0
2+
title: Updating to v6
33
---
44

5-
# Updating from Ionic 5 to Ionic 6
5+
# Updating from Ionic 5 to 6
66

77
:::note
8-
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.
8+
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.
9+
:::
10+
11+
:::info Breaking Changes
12+
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.
913
:::
1014

1115
## Getting Started
@@ -190,7 +194,7 @@ This applies to `ion-action-sheet`, `ion-alert`, `ion-loading`, `ion-modal`, `io
190194
<script>
191195
import { IonTabs, IonTabBar } from '@ionic/vue';
192196
import { defineComponent } from 'vue';
193-
197+
194198
export default defineComponent({
195199
components: { IonTabs, IonTabBar }
196200
});
@@ -209,7 +213,7 @@ This applies to `ion-action-sheet`, `ion-alert`, `ion-loading`, `ion-modal`, `io
209213
<script>
210214
import { IonTabs, IonTabBar, IonRouterOutlet } from '@ionic/vue';
211215
import { defineComponent } from 'vue';
212-
216+
213217
export default defineComponent({
214218
components: { IonTabs, IonTabBar, IonRouterOutlet }
215219
});

docs/updating/7-0.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
---
2-
title: Updating to 7.0
2+
title: Updating to v7
33
---
44

5-
# Updating from Ionic 6 to Ionic 7
5+
# Updating from Ionic 6 to 7
66

77
:::note
88
Ionic 7 is in beta. Please report any issues on [the Ionic Framework GitHub Repo](https://github.com/ionic-team/ionic-framework).
99
:::
1010

1111
:::note
12-
This guide assumes that you have already updated your app to the latest version of Ionic 6. Make sure you have followed the [Upgrading to Ionic 6 Guide](./6-0) before starting this guide.
12+
This guide assumes that you have already updated your app to the latest version of Ionic 6. Make sure you have followed the [Updating to Ionic 6 Guide](./6-0) before starting this guide.
13+
:::
14+
15+
:::info Breaking Changes
16+
For a **complete list of breaking changes** from Ionic 6 to Ionic 7, please refer to [the breaking changes document](https://github.com/ionic-team/ionic-framework/blob/feature-7.0/BREAKING.md#version-7x) in the Ionic Framework repository.
1317
:::
1418

1519
## Getting Started

0 commit comments

Comments
 (0)