Merge pull request #828 from ConzorKingKong/add-supertokens-migration

Add Supertokens migration page.
supertokens · Aug 21, 2024 · f4b8d83 · f4b8d83
2 parents 4c5fbd6 + 2dd25c6
commit f4b8d83
Show file tree

Hide file tree

Showing 20 changed files with 495 additions and 6 deletions.
diff --git a/v2/community/sdks.mdx b/v2/community/sdks.mdx
@@ -60,6 +60,10 @@ import GuidesLink from "/src/components/guidesLink"
 - SuperTokens provides React based pre-built UI components, for other frontend frameworks you will need to build custom UI and use the `supertokens-web-js` SDK to communicate with the APIs exposed by the SuperTokens backend SDK.
 - For other backend frameworks, you can follow our [guide on how to spin up a separate server configured with the SuperTokens backend SDK](/docs/community/other-frameworks) to authenticate requests and issue session tokens.
 
+## SDK Migration
+
+See the [updating SuperTokens](./updating-supertokens) page for steps on how to migrate SDKs.
+
 :::info
 Visit the [API reference page](./apis) to learn more.
 :::
diff --git a/v2/community/updating-supertokens.mdx b/v2/community/updating-supertokens.mdx
@@ -0,0 +1,65 @@
+---
+id: updating-supertokens
+title: Updating Supertokens core and SDKs
+hide_title: true
+---
+
+<!-- COPY DOCS -->
+<!-- ./community/updating-supertokens.mdx -->
+
+# Updating SuperTokens core and SDKs
+
+:::important
+You need to follow these steps in order to properly update supertokens
+:::
+
+In order to maintain compatibility and keep up on new features, we recommend updating your core and SDKs whenever possible.
+
+## 1. Updating your core
+
+You will need to shut down your core in order to update it. After it's off, run the migration scripts for all versions inbetween
+your starting version and the latest version. You may then bring your core back online.
+
+In the rare occasion that the supertokens core version you have updated to shows as incompatible with your current front-end and
+back-end sdk's in the [compatibility table](./compatibility-table), then refrain from running your back-end and front-end SDKs until after you update them.
+
+- ### Self-hosted core
+See the migration sections in the [supertokens-core changelog](https://github.com/supertokens/supertokens-core/blob/master/CHANGELOG.md).
+
+- ### Managed core
+If you're using the managed core service, please email us at [email protected] from your registered email to request a core update.
+
+## 2. Update your back-end SDK
+
+Follow the steps in the migration sections of the linked changelog from your current version up to the latest version.
+
+- ### NodeJS
+See the migration sections in the [supertokens-node changelog](https://github.com/supertokens/supertokens-node/blob/master/CHANGELOG.md).
+
+- ### GoLang
+See the migration sections in the [supertokens-golang changelog](https://github.com/supertokens/supertokens-golang/blob/master/CHANGELOG.md).
+
+- ### Python
+See the migration sections in the [supertokens-python changelog](https://github.com/supertokens/supertokens-python/blob/master/CHANGELOG.md).
+
+## 3. Update your front-end SDK
+
+Follow the steps in the migration sections of the linked changelog from your current version up to the latest version.
+
+- ### ReactJS
+See the migration sections in the [supertokens-auth-react changelog](https://github.com/supertokens/supertokens-auth-react/blob/master/CHANGELOG.md).
+
+- ### Vanilla JS
+See the migration sections in the [supertokens-web-js changelog](https://github.com/supertokens/supertokens-web-js/blob/master/CHANGELOG.md).
+
+- ### React Native
+See the migration sections in the [supertokens-react-native changelog](https://github.com/supertokens/supertokens-react-native/blob/master/CHANGELOG.md).
+
+- ### iOS
+See the migration sections in the [supertokens-ios changelog](https://github.com/supertokens/supertokens-ios/blob/master/CHANGELOG.md).
+
+- ### Flutter
+See the migration sections in the [supertokens-flutter changelog](https://github.com/supertokens/supertokens-flutter/blob/master/CHANGELOG.md).
+
+- ### Android
+See the migration sections in the [supertokens-android changelog](https://github.com/supertokens/supertokens-android/blob/master/CHANGELOG.md).
diff --git a/v2/emailpassword/sdks.mdx b/v2/emailpassword/sdks.mdx
@@ -60,6 +60,10 @@ import GuidesLink from "/src/components/guidesLink"
 - SuperTokens provides React based pre-built UI components, for other frontend frameworks you will need to build custom UI and use the `supertokens-web-js` SDK to communicate with the APIs exposed by the SuperTokens backend SDK.
 - For other backend frameworks, you can follow our [guide on how to spin up a separate server configured with the SuperTokens backend SDK](/docs/community/other-frameworks) to authenticate requests and issue session tokens.
 
+## SDK Migration
+
+See the [updating SuperTokens](./updating-supertokens) page for steps on how to migrate SDKs.
+
 :::info
 Visit the [API reference page](./apis) to learn more.
 :::
diff --git a/v2/emailpassword/sidebars.js b/v2/emailpassword/sidebars.js
@@ -719,7 +719,7 @@ module.exports = {
     },
     {
       type: 'category',
-      label: 'Migration',
+      label: 'Migrating to Supertokens',
       items: [
         "migration/about",
         {
@@ -737,6 +737,7 @@ module.exports = {
         "migration/mfa-migration"
       ],
     },
+    "updating-supertokens",
     {
       type: "category",
       label: "References",

diff --git a/v2/emailpassword/updating-supertokens.mdx b/v2/emailpassword/updating-supertokens.mdx
@@ -0,0 +1,65 @@
+---
+id: updating-supertokens
+title: Updating Supertokens core and SDKs
+hide_title: true
+---
+
+<!-- COPY DOCS -->
+<!-- ./community/updating-supertokens.mdx -->
+
+# Updating SuperTokens core and SDKs
+
+:::important
+You need to follow these steps in order to properly update supertokens
+:::
+
+In order to maintain compatibility and keep up on new features, we recommend updating your core and SDKs whenever possible.
+
+## 1. Updating your core
+
+You will need to shut down your core in order to update it. After it's off, run the migration scripts for all versions inbetween
+your starting version and the latest version. You may then bring your core back online.
+
+In the rare occasion that the supertokens core version you have updated to shows as incompatible with your current front-end and
+back-end sdk's in the [compatibility table](./compatibility-table), then refrain from running your back-end and front-end SDKs until after you update them.
+
+- ### Self-hosted core
+See the migration sections in the [supertokens-core changelog](https://github.com/supertokens/supertokens-core/blob/master/CHANGELOG.md).
+
+- ### Managed core
+If you're using the managed core service, please email us at [email protected] from your registered email to request a core update.
+
+## 2. Update your back-end SDK
+
+Follow the steps in the migration sections of the linked changelog from your current version up to the latest version.
+
+- ### NodeJS
+See the migration sections in the [supertokens-node changelog](https://github.com/supertokens/supertokens-node/blob/master/CHANGELOG.md).
+
+- ### GoLang
+See the migration sections in the [supertokens-golang changelog](https://github.com/supertokens/supertokens-golang/blob/master/CHANGELOG.md).
+
+- ### Python
+See the migration sections in the [supertokens-python changelog](https://github.com/supertokens/supertokens-python/blob/master/CHANGELOG.md).
+
+## 3. Update your front-end SDK
+
+Follow the steps in the migration sections of the linked changelog from your current version up to the latest version.
+
+- ### ReactJS
+See the migration sections in the [supertokens-auth-react changelog](https://github.com/supertokens/supertokens-auth-react/blob/master/CHANGELOG.md).
+
+- ### Vanilla JS
+See the migration sections in the [supertokens-web-js changelog](https://github.com/supertokens/supertokens-web-js/blob/master/CHANGELOG.md).
+
+- ### React Native
+See the migration sections in the [supertokens-react-native changelog](https://github.com/supertokens/supertokens-react-native/blob/master/CHANGELOG.md).
+
+- ### iOS
+See the migration sections in the [supertokens-ios changelog](https://github.com/supertokens/supertokens-ios/blob/master/CHANGELOG.md).
+
+- ### Flutter
+See the migration sections in the [supertokens-flutter changelog](https://github.com/supertokens/supertokens-flutter/blob/master/CHANGELOG.md).
+
+- ### Android
+See the migration sections in the [supertokens-android changelog](https://github.com/supertokens/supertokens-android/blob/master/CHANGELOG.md).
diff --git a/v2/passwordless/sdks.mdx b/v2/passwordless/sdks.mdx
@@ -60,6 +60,10 @@ import GuidesLink from "/src/components/guidesLink"
 - SuperTokens provides React based pre-built UI components, for other frontend frameworks you will need to build custom UI and use the `supertokens-web-js` SDK to communicate with the APIs exposed by the SuperTokens backend SDK.
 - For other backend frameworks, you can follow our [guide on how to spin up a separate server configured with the SuperTokens backend SDK](/docs/community/other-frameworks) to authenticate requests and issue session tokens.
 
+## SDK Migration
+
+See the [updating SuperTokens](./updating-supertokens) page for steps on how to migrate SDKs.
+
 :::info
 Visit the [API reference page](./apis) to learn more.
 :::
diff --git a/v2/passwordless/sidebars.js b/v2/passwordless/sidebars.js
@@ -696,7 +696,7 @@ module.exports = {
     },
     {
       type: 'category',
-      label: 'Migration',
+      label: 'Migrating to Supertokens',
       items: [
         "migration/about",
         {
@@ -713,6 +713,7 @@ module.exports = {
         "migration/mfa-migration"
       ],
     },
+    "updating-supertokens",
     {
       type: "category",
       label: "References",

diff --git a/v2/passwordless/updating-supertokens.mdx b/v2/passwordless/updating-supertokens.mdx
@@ -0,0 +1,65 @@
+---
+id: updating-supertokens
+title: Updating Supertokens core and SDKs
+hide_title: true
+---
+
+<!-- COPY DOCS -->
+<!-- ./community/updating-supertokens.mdx -->
+
+# Updating SuperTokens core and SDKs
+
+:::important
+You need to follow these steps in order to properly update supertokens
+:::
+
+In order to maintain compatibility and keep up on new features, we recommend updating your core and SDKs whenever possible.
+
+## 1. Updating your core
+
+You will need to shut down your core in order to update it. After it's off, run the migration scripts for all versions inbetween
+your starting version and the latest version. You may then bring your core back online.
+
+In the rare occasion that the supertokens core version you have updated to shows as incompatible with your current front-end and
+back-end sdk's in the [compatibility table](./compatibility-table), then refrain from running your back-end and front-end SDKs until after you update them.
+
+- ### Self-hosted core
+See the migration sections in the [supertokens-core changelog](https://github.com/supertokens/supertokens-core/blob/master/CHANGELOG.md).
+
+- ### Managed core
+If you're using the managed core service, please email us at [email protected] from your registered email to request a core update.
+
+## 2. Update your back-end SDK
+
+Follow the steps in the migration sections of the linked changelog from your current version up to the latest version.
+
+- ### NodeJS
+See the migration sections in the [supertokens-node changelog](https://github.com/supertokens/supertokens-node/blob/master/CHANGELOG.md).
+
+- ### GoLang
+See the migration sections in the [supertokens-golang changelog](https://github.com/supertokens/supertokens-golang/blob/master/CHANGELOG.md).
+
+- ### Python
+See the migration sections in the [supertokens-python changelog](https://github.com/supertokens/supertokens-python/blob/master/CHANGELOG.md).
+
+## 3. Update your front-end SDK
+
+Follow the steps in the migration sections of the linked changelog from your current version up to the latest version.
+
+- ### ReactJS
+See the migration sections in the [supertokens-auth-react changelog](https://github.com/supertokens/supertokens-auth-react/blob/master/CHANGELOG.md).
+
+- ### Vanilla JS
+See the migration sections in the [supertokens-web-js changelog](https://github.com/supertokens/supertokens-web-js/blob/master/CHANGELOG.md).
+
+- ### React Native
+See the migration sections in the [supertokens-react-native changelog](https://github.com/supertokens/supertokens-react-native/blob/master/CHANGELOG.md).
+
+- ### iOS
+See the migration sections in the [supertokens-ios changelog](https://github.com/supertokens/supertokens-ios/blob/master/CHANGELOG.md).
+
+- ### Flutter
+See the migration sections in the [supertokens-flutter changelog](https://github.com/supertokens/supertokens-flutter/blob/master/CHANGELOG.md).
+
+- ### Android
+See the migration sections in the [supertokens-android changelog](https://github.com/supertokens/supertokens-android/blob/master/CHANGELOG.md).
diff --git a/v2/session/sdks.mdx b/v2/session/sdks.mdx
@@ -60,6 +60,10 @@ import GuidesLink from "/src/components/guidesLink"
 - SuperTokens provides React based pre-built UI components, for other frontend frameworks you will need to build custom UI and use the `supertokens-web-js` SDK to communicate with the APIs exposed by the SuperTokens backend SDK.
 - For other backend frameworks, you can follow our [guide on how to spin up a separate server configured with the SuperTokens backend SDK](/docs/community/other-frameworks) to authenticate requests and issue session tokens.
 
+## SDK Migration
+
+See the [updating SuperTokens](./updating-supertokens) page for steps on how to migrate SDKs.
+
 :::info
 Visit the [API reference page](./apis) to learn more.
 :::
diff --git a/v2/session/sidebars.js b/v2/session/sidebars.js
@@ -315,11 +315,12 @@ module.exports = {
     },
     {
       type: 'category',
-      label: 'Migration',
+      label: 'Migrating to SuperTokens',
       items: [
         "migration/session-migration",
       ],
     },
+    "updating-supertokens",
     {
       type: "category",
       label: "References",

diff --git a/v2/session/updating-supertokens.mdx b/v2/session/updating-supertokens.mdx
@@ -0,0 +1,65 @@
+---
+id: updating-supertokens
+title: Updating Supertokens core and SDKs
+hide_title: true
+---
+
+<!-- COPY DOCS -->
+<!-- ./community/updating-supertokens.mdx -->
+
+# Updating SuperTokens core and SDKs
+
+:::important
+You need to follow these steps in order to properly update supertokens
+:::
+
+In order to maintain compatibility and keep up on new features, we recommend updating your core and SDKs whenever possible.
+
+## 1. Updating your core
+
+You will need to shut down your core in order to update it. After it's off, run the migration scripts for all versions inbetween
+your starting version and the latest version. You may then bring your core back online.
+
+In the rare occasion that the supertokens core version you have updated to shows as incompatible with your current front-end and
+back-end sdk's in the [compatibility table](./compatibility-table), then refrain from running your back-end and front-end SDKs until after you update them.
+
+- ### Self-hosted core
+See the migration sections in the [supertokens-core changelog](https://github.com/supertokens/supertokens-core/blob/master/CHANGELOG.md).
+
+- ### Managed core
+If you're using the managed core service, please email us at [email protected] from your registered email to request a core update.
+
+## 2. Update your back-end SDK
+
+Follow the steps in the migration sections of the linked changelog from your current version up to the latest version.
+
+- ### NodeJS
+See the migration sections in the [supertokens-node changelog](https://github.com/supertokens/supertokens-node/blob/master/CHANGELOG.md).
+
+- ### GoLang
+See the migration sections in the [supertokens-golang changelog](https://github.com/supertokens/supertokens-golang/blob/master/CHANGELOG.md).
+
+- ### Python
+See the migration sections in the [supertokens-python changelog](https://github.com/supertokens/supertokens-python/blob/master/CHANGELOG.md).
+
+## 3. Update your front-end SDK
+
+Follow the steps in the migration sections of the linked changelog from your current version up to the latest version.
+
+- ### ReactJS
+See the migration sections in the [supertokens-auth-react changelog](https://github.com/supertokens/supertokens-auth-react/blob/master/CHANGELOG.md).
+
+- ### Vanilla JS
+See the migration sections in the [supertokens-web-js changelog](https://github.com/supertokens/supertokens-web-js/blob/master/CHANGELOG.md).
+
+- ### React Native
+See the migration sections in the [supertokens-react-native changelog](https://github.com/supertokens/supertokens-react-native/blob/master/CHANGELOG.md).
+
+- ### iOS
+See the migration sections in the [supertokens-ios changelog](https://github.com/supertokens/supertokens-ios/blob/master/CHANGELOG.md).
+
+- ### Flutter
+See the migration sections in the [supertokens-flutter changelog](https://github.com/supertokens/supertokens-flutter/blob/master/CHANGELOG.md).
+
+- ### Android
+See the migration sections in the [supertokens-android changelog](https://github.com/supertokens/supertokens-android/blob/master/CHANGELOG.md).
diff --git a/v2/thirdparty/sdks.mdx b/v2/thirdparty/sdks.mdx
@@ -60,6 +60,10 @@ import GuidesLink from "/src/components/guidesLink"
 - SuperTokens provides React based pre-built UI components, for other frontend frameworks you will need to build custom UI and use the `supertokens-web-js` SDK to communicate with the APIs exposed by the SuperTokens backend SDK.
 - For other backend frameworks, you can follow our [guide on how to spin up a separate server configured with the SuperTokens backend SDK](/docs/community/other-frameworks) to authenticate requests and issue session tokens.
 
+## SDK Migration
+
+See the [updating SuperTokens](./updating-supertokens) page for steps on how to migrate SDKs.
+
 :::info
 Visit the [API reference page](./apis) to learn more.
 :::
diff --git a/v2/thirdparty/sidebars.js b/v2/thirdparty/sidebars.js
@@ -708,7 +708,7 @@ module.exports = {
     },
     {
       type: 'category',
-      label: 'Migration',
+      label: 'Migrating to Supertokens',
       items: [
         "migration/about",
         {
@@ -725,6 +725,7 @@ module.exports = {
         "migration/mfa-migration"
       ],
     },
+    "updating-supertokens",
     {
       type: "category",
       label: "References",