Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-04 00:18:01 +01:00
Code Issues Projects Releases Wiki Activity

docs: touch up the section on deprecating feature toggles.

Browse Source
This commit is contained in:
Thomas Heartman 2021-11-23 13:36:08 +01:00
parent 6962f39cc1
commit c7c4ad9963
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
website/docs/advanced/feature-toggle-types.md
View File

@ -29,12 +29,14 @@ Here's the list of the feature toggle types that Unleash supports together with
- **Kill switch** - Gracefully degrade system functionality. _(permanent)_
- **Permission** - Change the features or product experience that certain users receive. _(permanent)_
## Deprecating a feature toggle {#deprecate-a-feature-toggle}
## Deprecating feature toggles {#deprecate-a-feature-toggle}
You can mark feature toggles as `stale`. This is a way to deprecate a feature toggle without removing the active configuration for connected applications. Use this to signal that you should stop using the feature in your applications. Stale toggles will show as stale in the ["technical debt dashboard"](../user_guide/technical_debt).
The `stale` property can utilized to help us manage in various ways:
When you mark a toggle as stale, Unleash will emit an event. You can use [an addon](https://docs.getunleash.io/addons/index) to integrate this with your systems, by for instance posting a message in a Slack channel.
- Inform the developer working locally when we detect usage of a stale feature toggle.
- Use it to break the build if the code contains stale feature toggles.
- Send automatic PR to remove usage of completed toggles.
Additionally, with some extra work, you can also use the `stale` property to:
- Inform a developers that a toggle is stale _while_ they're developing.
- Break a project build if the code contains stale feature toggles.
- Send automatic PRs to remove usage of toggles that have served their purpose.