From 5027cd6d082ceee12d560e01d558485eb08f4bd2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miroslav=20Bajto=C5=A1?= Date: Tue, 15 Oct 2019 14:01:52 +0200 Subject: [PATCH] fixup! split auth into 3 pages, improve sidebar MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Miroslav Bajtoš --- .../built-in.md} | 8 +++---- docs/site/migration/auth/oauth2.md | 9 ++++++++ docs/site/migration/auth/overview.md | 13 ++++++++++++ docs/site/migration/auth/passport.md | 9 ++++++++ docs/site/migration/models/remoting-hooks.md | 2 +- docs/site/migration/overview.md | 2 ++ docs/site/sidebars/lb4_sidebar.yml | 21 +++++++++++++++---- 7 files changed, 54 insertions(+), 10 deletions(-) rename docs/site/migration/{authentication-authorization.md => auth/built-in.md} (53%) create mode 100644 docs/site/migration/auth/oauth2.md create mode 100644 docs/site/migration/auth/overview.md create mode 100644 docs/site/migration/auth/passport.md diff --git a/docs/site/migration/authentication-authorization.md b/docs/site/migration/auth/built-in.md similarity index 53% rename from docs/site/migration/authentication-authorization.md rename to docs/site/migration/auth/built-in.md index 3ebc1ff3de0e..dd8203363e81 100644 --- a/docs/site/migration/authentication-authorization.md +++ b/docs/site/migration/auth/built-in.md @@ -1,15 +1,13 @@ --- lang: en -title: 'Migrating authentication and authorization' +title: 'Migrating built-in authentication and authorization' keywords: LoopBack 4.0, LoopBack 4, LoopBack 3, Migration sidebar: lb4_sidebar -permalink: /doc/en/lb4/migration-authentication-authorization.html +permalink: /doc/en/lb4/migration-auth-built-in.html --- TODO: explain how to migrate: +- built-in models (User, AccessToken, ACL) - authentication - authorization -- built-in models (User, AccessToken, ACL) -- loopback-component-oauth2 -- loopback-component-passport diff --git a/docs/site/migration/auth/oauth2.md b/docs/site/migration/auth/oauth2.md new file mode 100644 index 000000000000..4bab68ebaa29 --- /dev/null +++ b/docs/site/migration/auth/oauth2.md @@ -0,0 +1,9 @@ +--- +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 +--- + +TODO: explain how to migrate apps using loopback-component-oauth2 diff --git a/docs/site/migration/auth/overview.md b/docs/site/migration/auth/overview.md new file mode 100644 index 000000000000..6936e6fff054 --- /dev/null +++ b/docs/site/migration/auth/overview.md @@ -0,0 +1,13 @@ +--- +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 +--- + +TODO: High-level description of the following migration steps: + +- built-in models (User, AccessToken, ACL), authentication & authorization +- apps using loopback-component-passport +- apps using loopback-component-oauth2 diff --git a/docs/site/migration/auth/passport.md b/docs/site/migration/auth/passport.md new file mode 100644 index 000000000000..d47016a8a541 --- /dev/null +++ b/docs/site/migration/auth/passport.md @@ -0,0 +1,9 @@ +--- +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 +--- + +TODO: explain how to migrate apps using loopback-component-passport diff --git a/docs/site/migration/models/remoting-hooks.md b/docs/site/migration/models/remoting-hooks.md index dc803d2d9fd8..b03998bc2cf1 100644 --- a/docs/site/migration/models/remoting-hooks.md +++ b/docs/site/migration/models/remoting-hooks.md @@ -13,4 +13,4 @@ TODO: Explain how to migrate remoting hooks to LB4 interceptors. - 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. +and how to access that data via Dependency Injection. diff --git a/docs/site/migration/overview.md b/docs/site/migration/overview.md index 0e702d0a9e33..fa0c90b94515 100644 --- a/docs/site/migration/overview.md +++ b/docs/site/migration/overview.md @@ -10,3 +10,5 @@ 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. + +List components & feature that are not planned for LB4. diff --git a/docs/site/sidebars/lb4_sidebar.yml b/docs/site/sidebars/lb4_sidebar.yml index 7a5b7b57a658..915cf013cd09 100644 --- a/docs/site/sidebars/lb4_sidebar.yml +++ b/docs/site/sidebars/lb4_sidebar.yml @@ -625,7 +625,7 @@ children: output: 'web, pdf' children: - - title: 'Understanding the differences between LoopBack 3 and LoopBack 4' + - title: 'Understanding the differences' url: Understanding-the-differences.html output: 'web, pdf' @@ -633,11 +633,11 @@ children: url: migration-mounting-lb3app.html output: 'web, pdf' - - title: 'Migrating datasources' + - title: 'Datasources' url: migration-datasources.html output: 'web, pdf' - - title: 'Migrating Express middleware' + - title: 'Express middleware' url: migration-express-middleware.html output: 'web, pdf' @@ -675,8 +675,21 @@ children: output: 'web, pdf' - title: 'Authentication & authorization' - url: migration-authentication-authorization.html + url: migration-auth-overview.html output: 'web, pdf' + children: + + - title: 'Built-in models' + url: migration-auth-built-in.html + output: 'web, pdf' + + - title: 'Passport' + url: migration-auth-passport.html + output: 'web, pdf' + + - title: 'OAuth2 Provider' + url: migration-auth-oauth2.html + output: 'web, pdf' - title: 'Components and extensions' url: migration-extensions.html