From d9d3c0a96757d02f44b9c5f8f3cbd3d044119b34 Mon Sep 17 00:00:00 2001 From: Xiao Yijun Date: Mon, 20 Nov 2023 14:27:01 +0800 Subject: [PATCH] chore: update tenant type doc (#513) --- docs/docs/recipes/environment-tags/README.mdx | 40 ---------------- docs/docs/recipes/tenant-type/README.mdx | 46 +++++++++++++++++++ 2 files changed, 46 insertions(+), 40 deletions(-) delete mode 100644 docs/docs/recipes/environment-tags/README.mdx create mode 100644 docs/docs/recipes/tenant-type/README.mdx diff --git a/docs/docs/recipes/environment-tags/README.mdx b/docs/docs/recipes/environment-tags/README.mdx deleted file mode 100644 index 2648912fab8..00000000000 --- a/docs/docs/recipes/environment-tags/README.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 13 ---- - -import CloudOnlyNotification from '../../fragments/_cloud_only_notification.mdx'; - -# 🏷️ Environment Tags - - - -Logto just enhanced the current environment tag features and introduced a new type of tenant: the Development tenant. - -## Type of tenants - -There are two types of tenants in Logto Cloud. - -### Development - -The dev environment is mainly used for testing and should not be used in the production environment. Similar to the Pro plan, it's free forever with some limitations and no subscription required. - -### Production - -Production is where end-users access the live software and might need a paid subscription. To access a production tenant, you can subscribe to the free, hobby, or pro plan. - -:::note -Please be aware that you can only specify your tenant types during creation; it is not possible to modify the tenant type once it has been created. -::: - -With the new type of tenant differentiation, you can better manage your projects across different environments for efficiency and, at the same time, enjoy the full value of Logto. - -## Legacy migration - -- Users on the free plan with environment tags "dev" or "prod" will remain unaffected. -- The "staging" environment tag will be sunset, so free plan tenants with environment tags set as "staging" will be automatically changed to “production”. -- If you are on the paid plan, regardless of your previous environment tags, all paid tenants will transition to the production category. - -## Development tenant limitation - -1. The development tenant mirrors a Pro plan production tenant, except for the sign-in experience displaying a banner stating that this sign-in experience is only intended for a development environment. -2. The development tenant doesn’t have a bill or billing history section. It offers unlimited access and free usage of all features. diff --git a/docs/docs/recipes/tenant-type/README.mdx b/docs/docs/recipes/tenant-type/README.mdx new file mode 100644 index 00000000000..dba886244d5 --- /dev/null +++ b/docs/docs/recipes/tenant-type/README.mdx @@ -0,0 +1,46 @@ +--- +sidebar_position: 13 +--- + +import CloudOnlyNotification from '../../fragments/_cloud_only_notification.mdx'; + +# 🏷️ Tenant type + + + +## Type of tenants + +There are two types of tenants in Logto Cloud. + +### Development + +The dev environment is mainly used for testing and should not be used in the production environment. It has all the premium and paid features of the Pro plan, it's free forever to test but has some [limitations](#limitation), and no subscription is required. + +### Production + +Production is where end-users access the live software and might need a paid subscription. You can subscribe to the free, hobby, or pro plan to access a production tenant. + +:::note +Please be aware that you can only specify your tenant types during creation; it is not possible to modify the tenant type once it has been created. +::: + +With the new type of tenant differentiation, you can better manage your projects across different environments for efficiency and, at the same time, enjoy the full value of Logto. + +## Legacy migration + +For existing users who use the “environment tag” feature, we will be phasing out these tags and introducing a more robust system for differentiating between tenants. + +Moving forward, we will have two distinct tenant types: **Development** and **Production**. The development tenant offers enhanced features for testing and exploring different values of Logto. However, please note that there may be some restrictions on this type of tenant (Please refer to the following section). + +To ensure a seamless transition and uninterrupted functionality, all early-created tenants will be migrated to the Production tenant type along with your previous subscription. + +## Development tenant privilege and limitation + +### Privilege + +1. The development tenant includes all Pro plan features, no paywall, and no feature quota limitation. +2. The development tenant doesn’t have a bill or billing history section. It offers unlimited access and free usage of all features. + +### Limitation + +- When signing in, you will see a banner indicating that this sign-in experience is specifically meant for development purposes.