-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add a skeleton of migration guide
Signed-off-by: Miroslav Bajtoš <[email protected]>
- Loading branch information
Showing
17 changed files
with
235 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating from LoopBack 3' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/Migrating-from-LoopBack-3.html | ||
| --- | ||
|
|
||
| The migration guide was moved to a new place: | ||
| [Migration guide](./migration-overview.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating authentication and authorization' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-authentication-authorization.html | ||
| --- | ||
|
|
||
| TODO: explain how to migrate: | ||
|
|
||
| - authentication | ||
| - authorization | ||
| - built-in models (User, AccessToken, ACL) | ||
| - loopback-component-oauth2 | ||
| - loopback-component-passport |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating boot scripts' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-boot-scripts.html | ||
| --- | ||
|
|
||
| TODO: Explain how to migrate LB3 boot scripts to LB4 LifeCycle observers. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating clients' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-clients.html | ||
| --- | ||
|
|
||
| Explain how to migrate client code using one of LB3 client SDKs: | ||
|
|
||
| - AngularJS (1.x) | ||
| - Angular (2+) (see loopback-sdk-builder) | ||
| - Android | ||
| - iOS | ||
| - Xamarin | ||
| - Isomorphic JavaScript |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating datasources' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-datasources.html | ||
| --- | ||
|
|
||
| TODO: show how to migrate a datasource from a LB3 app to LB4. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating Express middleware' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-express-middleware.html | ||
| --- | ||
|
|
||
| TODO: show how to migrate a Express middleware from a LB3 app mounted inside LB4 | ||
| to top-level, so that the middleware is executed for both LB3 and LB4 endpoints. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating components and extensions' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-extensions.html | ||
| --- | ||
|
|
||
| TODO: explain how to migrate custom LB3 components/extensions written by our | ||
| community to make them usable in LB4 projects. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating models' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-models-core.html | ||
| --- | ||
|
|
||
| TODO: Explain how to migrate core Model functionality: | ||
|
|
||
| - Model definition | ||
| - Persistence (via LB4 repositories) | ||
| - REST API (via LB4 controllers) | ||
|
|
||
| Show how to use `lb4 import-model`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating custom model methods' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-models-methods.html | ||
| --- | ||
|
|
||
| TODO: Explain how to migrate custom model methods: | ||
|
|
||
| - Methods related to persistence go to LB4 Repository | ||
| - Remote methods (public API) go to Controller class |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating model mixins' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-models-mixins.html | ||
| --- | ||
|
|
||
| TODO: Explain how to migrate model mixins. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating CRUD operation hooks' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-models-operation-hooks.html | ||
| --- | ||
|
|
||
| TODO: Explain how to migrate CRUD Operation Hooks. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating models' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-models-overview.html | ||
| --- | ||
|
|
||
| TODO: Explain at high level how to migrate models from a LB3 app to a LB4 | ||
| project. Refer to sub-sections for model details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating model relations' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-models-relations.html | ||
| --- | ||
|
|
||
| TODO: Explain how to migrate model relations: | ||
|
|
||
| - Relation definition to LB4 model class | ||
| - Persistence (via LB4 Repositories), including inclusion resolver | ||
| - REST API (via LB4 Controllers) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migrating remoting hooks' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-models-remoting-hooks.html | ||
| --- | ||
|
|
||
| TODO: Explain how to migrate remoting hooks to LB4 interceptors. | ||
|
|
||
| - Global hooks, e.g. `app.beforeRemote('**', handlerFn)` | ||
| - Model-level hooks, e.g. `app.beforeRemote('User.**', handlerFn)` | ||
| - Method-level hooks, e.g. `User.beforeRemote('create', handlerFn)` | ||
|
|
||
| Explain how to map properties provided by LB3 remoting context to LB4 concepts | ||
| and how to access those data via Dependency Injection. |
6 changes: 3 additions & 3 deletions
6
docs/site/Migrating-from-LoopBack-3.md → docs/site/migration/mounting-lb3app.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| lang: en | ||
| title: 'Migration guide' | ||
| keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
| sidebar: lb4_sidebar | ||
| permalink: /doc/en/lb4/migration-overview.html | ||
| --- | ||
|
|
||
| Migration guide from LoopBack 3 to LoopBack 4. | ||
|
|
||
| TODO: explain the high-level plan for upgrading in incremental steps, point to | ||
| sub-chapters for more details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters