From ab51a495aae4371077356b332eef9ac3d010663a Mon Sep 17 00:00:00 2001 From: Drew Gorton Date: Mon, 2 Oct 2023 12:37:53 -0500 Subject: [PATCH] Update more instances of "toggle" with "flag" (#4821) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Landing page + sidebar nav + main 'How to create flags' page Co-authored-by: Gastón Fournier --- website/docs/about-the-docs.md | 2 +- .../how-to/how-to-create-feature-toggles.md | 18 ++++++++++++------ website/sidebars.js | 2 +- 3 files changed, 14 insertions(+), 8 deletions(-) diff --git a/website/docs/about-the-docs.md b/website/docs/about-the-docs.md index 4ced12d815..da6f5ba992 100644 --- a/website/docs/about-the-docs.md +++ b/website/docs/about-the-docs.md @@ -34,7 +34,7 @@ Our how-to guides show you how to perform a number of common tasks that you'll w The guides are organized into the following categories: - [API how-tos](./how-to/api) -- [Feature toggles, strategies, context, and general how-tos](./how-to/misc) +- [Feature flags, strategies, context, and general how-tos](./how-to/misc) - [Users and permissions how-tos](./how-to/users-and-permissions) - [Single Sign-On (SSO) how-tos](./how-to/sso) - [Troubleshooting how-tos](./how-to/troubleshooting) diff --git a/website/docs/how-to/how-to-create-feature-toggles.md b/website/docs/how-to/how-to-create-feature-toggles.md index 5ebf8076f4..e127f31016 100644 --- a/website/docs/how-to/how-to-create-feature-toggles.md +++ b/website/docs/how-to/how-to-create-feature-toggles.md @@ -1,23 +1,29 @@ --- -title: How to create a feature toggle +title: How to create a feature flag --- -[Feature toggles](../reference/feature-toggles.mdx) are the foundation of Unleash. They are at the core of everything we do and are a fundamental building block in any feature management system. This guide shows you how to create feature toggles in Unleash and how to add any optional constraints, segments, variants, and more. Links to learn more about these concepts will be scattered throughout the text. +:::info Feature flags or feature toggles? + +This document uses **feature flags** and **feature toggles** interchangeably. Some people prefer flag; others prefer toggle. We use both - they are synonyms for us. + +::: + +Feature Flags (or [Feature toggles](../reference/feature-toggles.mdx) in the UI) are the foundation of Unleash. They are at the core of everything we do and are a fundamental building block in any feature management system. This guide shows you how to create feature flags in Unleash and how to add any optional constraints, segments, variants, and more. Links to learn more about these concepts will be scattered throughout the text. You can perform every action both via the UI and the admin API. This guide includes screenshots to highlight the relevant UI controls and links to the relevant API methods for each step. This guide is split into three sections: -1. [Prerequisites](#prerequisites): you need these before you can create a toggle. -2. [Required steps](#required-steps): all the required steps to create a toggle and activate it in production. -3. [Optional steps](#optional-steps): optional steps you can take to further target and configure your feature toggle and its audience. +1. [Prerequisites](#prerequisites): you need these before you can create a flag. +2. [Required steps](#required-steps): all the required steps to create a flag and activate it in production. +3. [Optional steps](#optional-steps): optional steps you can take to further target and configure your feature flag and its audience. ## Prerequisites To perform all the steps in this guide, you will need: - A running Unleash instance -- A project to hold the toggle +- A project to hold the flag - A user with an **editor** or **admin** role OR a user with the following permissions inside the target project: - **[project-level permissions](../reference/rbac.md#project-permissions)** - create feature toggles diff --git a/website/sidebars.js b/website/sidebars.js index 5795144fa6..9ad29ca24c 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -125,7 +125,7 @@ module.exports = { items: ['how-to/how-to-run-the-unleash-proxy'], }, { - label: 'Feature toggles, strategies, context', + label: 'Feature flags, strategies, context', items: [ 'how-to/how-to-add-strategy-constraints', 'how-to/how-to-add-feature-flag-naming-patterns',