fix(docs): Update migration guide

lowdefy · Oct 4, 2023 · 9c1e6c0 · 9c1e6c0
1 parent 8a2af0c
commit 9c1e6c0
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 347 deletions.
diff --git a/packages/docs/actions/Throw.yaml b/packages/docs/actions/Throw.yaml
@@ -27,8 +27,6 @@ _ref:
       }): void
       ```
     description: |
-      ##### TODO: This page needs to be updated.
-
       The `Throw` action is used throw an error to the user and log to the console. If `throw: true`, the `Throw`
       action will throw an error, and this will stop the execution of actions that are defined after it. If the action does not thrown, the `Throw` action will do nothing and the actions defined after it will be executed.
 

diff --git a/packages/docs/howto/v4Migration/v4-migration.md b/packages/docs/howto/v4Migration/v4-migration.md
diff --git a/packages/docs/migration/v3-to-v4.yaml b/packages/docs/migration/v3-to-v4.yaml
@@ -280,36 +280,32 @@ _ref:
 
                 ## Authentication Changes
 
-                #### TODO: Update once new auth has been documented
-
-                In version 4, authentication has been reworked to use [NextAuth.js](https://next-auth.js.org), which offers a lot more flexibility and additional features.
-
-                - `auth` is now a root level property.
-                - remove `openId` fields.
-                - add providers:
+                In version 4, authentication has been reworked to use [NextAuth.js](https://next-auth.js.org), which offers a lot more flexibility and additional features - read more [here](/users-introduction).
 
+                To migrate V3 authentication:
+                - The `config.auth` property has moved to the `auth` root level property.
+                - The `config.auth.openId` properties have been removed, replace them with configuration for your provider:
                 ```yaml
-                providers:
-                  - id: auth0
-                    type: Auth0Provider
-                    properties:
-                      clientId:
-                        _secret: AUTH0_CLIENT_ID
-                      clientSecret:
-                        _secret: AUTH0_CLIENT_SECRET
-                      issuer:
-                        _secret: AUTH0_ISSUER
+                auth:
+                  providers:
+                    - id: auth0
+                      type: Auth0Provider
+                      properties:
+                        clientId:
+                          _secret: AUTH0_CLIENT_ID
+                        clientSecret:
+                          _secret: AUTH0_CLIENT_SECRET
+                        issuer:
+                          _secret: AUTH0_ISSUER
                 ```
 
-                - Add env vars `NEXTAUTH_URL` and `NEXTAUTH_SECRET`.
-                - Add new callback urls to auth0 `{{ protocol }}{{ host }}/api/auth/callback/{{ providerId }}`.
-                - convert login params (`callbackUrl`, `authUrl.urlQuery`)
+                - The `NEXTAUTH_SECRET` environment variable needs to be set to a secure secret value (replacing `LOWDEFY_SECRET_JWT_SECRET`).
+                - The callback URLs configured with the provider change from `{{ protocol }}{{ host }}/auth/openid-callback` to `{{ protocol }}{{ host }}/api/auth/callback/{{ providerId }}`.
+                - The `Login` and `Logout` action params have changed between V3 and V4.
 
                 ## Custom Blocks, Actions and Operators
 
-                #### TODO: Add link to plugins guide
-
-                Custom blocks, the `JsAction` action and the `_js` operator have been replaced by the new Lowdefy plugin system which is an easier, more powerful and standardized way to extend actions, blocks, connections, operators and the authentication system with custom JavaScript. See the plugin guide for more information on how to use and develop plugins.
+                Custom blocks, the `JsAction` action and the `_js` operator have been replaced by the new Lowdefy plugin system which is an easier, more powerful and standardized way to extend actions, blocks, connections, operators and the authentication system with custom JavaScript. See the [plugin documentation](/plugins-introduction) for more information on how to use and develop plugins.
 
                 The [AgGrid](https://github.com/lowdefy/blocks-aggrid) custom blocks have been added as default Lowdefy blocks, so these blocks can now be used without any additional configuration.