-
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
22 changed files
with
461 additions
and
15 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,13 @@ | ||
--- | ||
lang: en | ||
title: 'Migrating built-in authentication and authorization' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-auth-built-in.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3719](https://github.com/strongloop/loopback-next/issues/3719) | ||
" %} |
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 OAuth2 provider' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-auth-oauth2.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3959](https://github.com/strongloop/loopback-next/issues/3959) | ||
" %} |
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,28 @@ | ||
--- | ||
lang: en | ||
title: 'Migrating authentication and authorization' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-auth-overview.html | ||
--- | ||
|
||
LoopBack version 3 provides several options for adding authentication and | ||
authorization to secure the applications: | ||
|
||
- A set of built-in models like `User`, `AccessToken` and `ACL` makes it easy to | ||
store your user credentials locally and define custom access control checks. | ||
The migration path is described in | ||
[Migrating built-in authentication and authorization](./built-in.md). | ||
|
||
- [loopback-component-passport](https://github.com/strongloop/loopback-component-passport) | ||
provides integration between LoopBack 3 and | ||
[Passport](http://www.passportjs.org) to support third-party login and account | ||
linking for LoopBack applications. The migration path is described in | ||
[Migrating Passport-based authentication](./passport.md). | ||
|
||
- [loopback-component-oauth2](https://github.com/strongloop/loopback-component-oauth2) | ||
provides full integration between OAuth 2.0 and LoopBack. It enables LoopBack | ||
applications to function as an oAuth 2.0 provider to authenticate and | ||
authorize client applications and/or resource owners (i.e. users) to access | ||
protected API endpoints. The migration path is described in | ||
[Migrating OAuth2 provider](./oauth2.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,13 @@ | ||
--- | ||
lang: en | ||
title: 'Migrating Passport-based authentication' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-auth-passport.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3958](https://github.com/strongloop/loopback-next/issues/3958) | ||
" %} |
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 boot scripts' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-boot-scripts.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3957](https://github.com/strongloop/loopback-next/issues/3957) | ||
" %} |
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 CLI usage patterns' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-cli.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3953](https://github.com/strongloop/loopback-next/issues/3953) | ||
" %} |
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 clients' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-clients.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3954](https://github.com/strongloop/loopback-next/issues/3954) | ||
" %} |
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 datasources' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-datasources.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3946](https://github.com/strongloop/loopback-next/issues/3946). | ||
" %} |
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 Express middleware' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-express-middleware.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3947](https://github.com/strongloop/loopback-next/issues/3947) | ||
" %} |
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 components and extensions' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-extensions.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3955](https://github.com/strongloop/loopback-next/issues/3955) | ||
" %} |
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 definitions and built-in APIs' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-models-core.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3718](https://github.com/strongloop/loopback-next/issues/3718). | ||
" %} |
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 custom model methods' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-models-methods.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3949](https://github.com/strongloop/loopback-next/issues/3949). | ||
" %} |
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 mixins' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-models-mixins.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3951](https://github.com/strongloop/loopback-next/issues/3951) | ||
" %} |
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 CRUD operation hooks' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-models-operation-hooks.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3952](https://github.com/strongloop/loopback-next/issues/3952) | ||
" %} |
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,45 @@ | ||
--- | ||
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 | ||
--- | ||
|
||
**FIXME:** Explain at high level how to migrate models from a LB3 app to a LB4 | ||
project. Refer to sub-sections for model details. | ||
|
||
In LoopBack 3, models are the cornerstone. They describe shape of data (schema), | ||
provide persistence-related behavior and implement public (REST) API. Besides | ||
this core functionality, there are many ways how to extend the built-in | ||
behavior. | ||
|
||
In LoopBack 4, many things changed but some remain the same. A model class is no | ||
longer responsible for everything. We have Models to describe shape of data, | ||
Repositories to provide persistence-related behavior and finally Controllers to | ||
implement public APIs. Under the hood, repositories are re-using a lot of the | ||
same persistence implementation you may know from LoopBack 3, therefore some | ||
concepts remain unchanged. | ||
|
||
To make the migration guide easier to navigate, we split model-related | ||
instructions into several sub-sections. | ||
|
||
1. [Migrating model definitions and built-in APIs](./core.md) describes how to | ||
migrate the core of your Models - the model definition, persistence behavior | ||
and public API provided by the framework itself. | ||
|
||
2. [Migrating model relations](./relations.md) explains how to migrate | ||
relations, from the definition of a relation to its public APIs. | ||
|
||
3. [Migrating custom model methods](./methods.md) show how to bring over custom | ||
methods that are enhancing models with new functionality, adding to the | ||
features provided by the framework. | ||
|
||
4. [Migrating remoting hooks](./remoting-hooks.md) explains how to migrate hooks | ||
that are executed by the REST API layer. | ||
|
||
5. [Migrating CRUD operation hooks'](./operation-hooks.md) shows how to migrate | ||
hooks (observers) that are executed by the persistence layer. | ||
|
||
6. [Migrating model mixins](./mixins.md) provides instructions for migrating | ||
mixins - small components that can enhance Model schema, behavior, or both. |
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 | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3948](https://github.com/strongloop/loopback-next/issues/3948). | ||
" %} |
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 remoting hooks' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-models-remoting-hooks.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3950](https://github.com/strongloop/loopback-next/issues/3950). | ||
" %} |
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,13 @@ | ||
--- | ||
lang: en | ||
title: 'LoopBack 3 features not planned in LoopBack 4' | ||
keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/migration-not-planned.html | ||
--- | ||
|
||
{% include note.html content=" | ||
This is a placeholder page, the task of adding content is tracked by the | ||
following GitHub issue: | ||
[loopback-next#3956](https://github.com/strongloop/loopback-next/issues/3956) | ||
" %} |
Oops, something went wrong.