Updated Feature toggles (markdown)

Lynne
2022-08-02 08:35:27 +01:00
parent 8c074a6714
commit 6d2e3bcec1

@@ -1,4 +1,3 @@
# Feature Toggles
## What are Feature Toggles
Feature Toggles allows code paths can be enabled for certain users and/or environments such as staging, production, or development. Its a technique in software development that attempts to provide an alternative to maintaining multiple branches in source code (known as feature branches), such that a software feature can be tested on production even before it is completed and ready for release. It also means that code can be merged faster on bigger features without impacting existing users.
@@ -6,11 +5,11 @@ Feature Toggles allows code paths can be enabled for certain users and/or enviro
## Feature Toggles are not a tool to customize features.
Period
# How to use OFN Feature Toggles
## How to use OFN Feature Toggles
[Wiki on using Feature Toggles in OFN](https://github.com/openfoodfoundation/openfoodnetwork/wiki/Feature-toggle-with-Flipper)
# Current Active Feature Toggles
## Current Active Feature Toggles
As with everything in our community, if you notice this list is out of date, please update it :)
@@ -18,6 +17,6 @@ As with everything in our community, if you notice this list is out of date, ple
- [Reports via the API](https://github.com/openfoodfoundation/openfoodnetwork/pull/9032): 'api_reports' (can only be enabled over the whole instance)
- [V1 API Endpoint](https://github.com/openfoodfoundation/openfoodnetwork/issues/8787): 'api_v1' (can be enabled per user)
# Other useful bits
## Other useful bits
Notes of the retro we did on 2021-03-29 about the use of toggles while implementing [Unit Prices](https://github.com/openfoodfoundation/openfoodnetwork/issues/6449).