Skip to content

Commit

Permalink
Update more instances of "toggle" with "flag" (#4821)
Browse files Browse the repository at this point in the history
Landing page + sidebar nav + main 'How to create flags' page

Co-authored-by: Gastón Fournier <[email protected]>
  • Loading branch information
dgorton and gastonfournier authored Oct 2, 2023
1 parent 328a0e4 commit ab51a49
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 8 deletions.
2 changes: 1 addition & 1 deletion website/docs/about-the-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
18 changes: 12 additions & 6 deletions website/docs/how-to/how-to-create-feature-toggles.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

0 comments on commit ab51a49

Please sign in to comment.