From 94bfb757d6575acd5f2a5dab1b2466c6693537d4 Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Fri, 24 Feb 2023 13:48:45 +0100 Subject: [PATCH] docs: slight update to environment docs (#3187) ## What & why This update does three things: 1. Adjusts the environment cloning feature availability notice: because this has been released. 2. Updates the availability notice for environments (to conform with the standard docusaurus way of doing things): for consistency 3. Add a brief explanation of environment types: because this isn't documented anywhere ## Sources The note about how environment types work is sourced from this old [slack thread (internal to the team)](https://unleash-community.slack.com/archives/G01MU2Q49QC/p1659600175175769) --- .../docs/how-to/how-to-clone-environments.mdx | 2 +- website/docs/reference/environments.md | 25 +++++++++++++++---- 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/website/docs/how-to/how-to-clone-environments.mdx b/website/docs/how-to/how-to-clone-environments.mdx index bbd71a0216..c0037a6fdf 100644 --- a/website/docs/how-to/how-to-clone-environments.mdx +++ b/website/docs/how-to/how-to-clone-environments.mdx @@ -4,7 +4,7 @@ title: How to clone environments :::info availability -Environment cloning is an upcoming feature, and is scheduled to become available in one of the next few releases. +Environment cloning was made available in Unleash 4.19. ::: diff --git a/website/docs/reference/environments.md b/website/docs/reference/environments.md index cd3441f154..11e568e9a9 100644 --- a/website/docs/reference/environments.md +++ b/website/docs/reference/environments.md @@ -3,10 +3,11 @@ id: environments title: Environments --- -
- Environments are available in Unleash v4.3.x and later. They can also be enabled from Unleash v4.2.x with a feature toggle. -
-
+:::info Availability + +Environments were released in Unleash v4.3.0. + +:::
@@ -24,6 +25,20 @@ Despite this being a shift in how Unleash works, everything will continue to wor ![A graph showing how environments work. Each project can have multiple features, and each feature can have different activation strategies in each of its environments.](/img/environments_overview.svg 'A feature toggle exists across all environments, but take different activation strategies per environment.') +## Environment types + +All environments in Unleash have a **type**. When you create a new environment, you must also assign it a type. + +The built-in environment types are: +- Development +- Test +- Pre-production +- Production + +The **production** environment type is special: Unleash will show additional confirmation prompts when you change something that could impact users in environments of this type. The built-in "production" environment is a production-type environment. + +The other environment types do not currently have any functionality associated with them. This may change in the future. + ## Global and project-level environments Environments exist on a global level, so they are available to all projects within Unleash. However, every [project](./projects.md) might not need to use every environment. That's why you can also choose which of the global environments should be available within a project. @@ -60,7 +75,7 @@ In order for the SDK to download the feature toggle configuration for the correc :::note Availability -Environment cloning is an upcoming feature, and is scheduled to become available in one of the next few releases. +Environment cloning was made available in Unleash 4.19. :::