You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-14
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ GO Feature Flag is a lightweight and open-source solution that provides a simple
53
53
54
54
The solution has been built to facilitate the usage of feature flags in your code with the easiest setup possible.
55
55
56
-
Originally, **GO Feature Flag** was designed as a solution exclusively for the `GO` language. With the new standardization of feature flags by the [Openfeature](https://openfeature.dev/) project, the solution is now available for multiple languages _([list of supported languages](https://gofeatureflag.org/docs/openfeature_sdk/sdk))_ through a simple API server called the relay proxy, which can be hosted.
56
+
Originally, **GO Feature Flag** was designed as a solution exclusively for the `GO` language. With the new standardization of feature flags by the [Openfeature](https://openfeature.dev/) project, the solution is now available for multiple languages _([list of supported languages](https://gofeatureflag.org/docs/sdk))_ through a simple API server called the relay proxy, which can be hosted.
57
57
58
58
> [!TIP]
59
59
> If you are not familiar with feature flags, I've written an [article](https://medium.com/better-programming/feature-flags-and-how-to-iterate-quickly-7e3371b9986) which explains why feature flags can fasten your iteration cycle.
@@ -64,10 +64,10 @@ Originally, **GO Feature Flag** was designed as a solution exclusively for the `
64
64
- Configuring your flags in various [format](https://gofeatureflag.org/docs/configure_flag/flag_format) (`JSON`, `TOML` and `YAML`).
65
65
- Adding complex [rules](https://gofeatureflag.org/docs/configure_flag/flag_format#rule-format) to target your users.
-[Progressively rollout a feature](https://gofeatureflag.org/docs/configure_flag/rollout/progressive).
69
-
-[Schedule your flag updates](https://gofeatureflag.org/docs/configure_flag/rollout/scheduled).
70
-
- Exporting your flags usage data to various destinations such as _(`S3`, `Google cloud storage`, `file`, see the [_full list_](https://gofeatureflag.org/docs/configure_flag/export_flags_usage))_.
-[Progressively rollout a feature](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/progressive).
69
+
-[Schedule your flag updates](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/scheduled).
70
+
- Exporting your flags usage data to various destinations such as _(`S3`, `Google cloud storage`, `file`, `kubernetes`, see the [_full list_](https://gofeatureflag.org/docs/docs/integrations/store-flags-configuration#available-retrievers))_.
71
71
- Getting notified when a flag has been changed _(`webhook` and `slack`)_.
72
72
- Use **GO Feature Flag** in several languages with **Open Feature SDKs**.
73
73
- Support your full stack, from the backend to the frontend including your mobile apps.
@@ -141,11 +141,11 @@ docker run \
141
141
142
142
```
143
143
144
-
_If you don't want to use docker to install the **relay proxy** you can follow other ways to install it in the [documentation](https://gofeatureflag.org/docs/relay_proxy/install_relay_proxy)._
144
+
_If you don't want to use docker to install the **relay proxy** you can follow other ways to install it in the [documentation](https://gofeatureflag.org/docs/docs/relay-proxy/install_relay_proxy)._
145
145
146
146
### Use Open Feature SDK
147
147
148
-
_In this example, we are using the **nodejs SDK**, but you can check other languages [here](https://gofeatureflag.org/docs/openfeature_sdk/sdk)._
148
+
_In this example, we are using the **nodejs SDK**, but you can check other languages [here](https://gofeatureflag.org/docs/sdk)._
149
149
150
150
151
151
#### Install dependencies
@@ -241,7 +241,7 @@ PollingInterval, the default value is 60 seconds).*
241
241
242
242
> ℹ info
243
243
This is a basic configuration to test locally, in production it is better to use a remote place to store your feature flag configuration file.
244
-
Look at the list of available options in the [**Store your feature flag file** page](https://gofeatureflag.org/docs/go_module/store_file/).
244
+
Look at the list of available options in the [**Store your feature flag file** page](https://gofeatureflag.org/docs/docs/integrations/store-flags-configuration#available-retrievers).
245
245
246
246
### Evaluate your flags
247
247
Now you can evaluate your flags anywhere in your code.
@@ -302,7 +302,7 @@ The available retrievers are:
302
302
- **AzBlobStorage**
303
303
- ...
304
304
305
-
_[See the full list and more information.](https://gofeatureflag.org/docs/configure_flag/store_your_flags)_
305
+
_[See the full list and more information.](https://gofeatureflag.org/docs/docs/integrations/store-flags-configuration#available-retrievers)_
306
306
307
307
## Flags file format
308
308
**GO Feature Flag** core feature is to centralize all your feature flags in a single file and to avoid hosting and maintaining a backend server to manage them.
@@ -449,7 +449,7 @@ end = 2021-03-21T05:00:00.100Z
449
449
450
450
</details>
451
451
452
-
For detailed information on the fields required to create a flag, please refer to the [documentation](https://gofeatureflag.org/docs/configure_flag/flag_format).
452
+
For detailed information on the fields required to create a flag, please refer to the [documentation](https://gofeatureflag.org/docs/docs/configure_flag/target-with-flags).
453
453
454
454
## Rule format
455
455
@@ -532,10 +532,10 @@ But it does not have to, having a complex **rollout** strategy allows you to hav
532
532
533
533
### Complex rollout strategy available
534
534
535
-
- [Canary releases](https://gofeatureflag.org/docs/configure_flag/rollout/canary) - impact randomly a subset of your users.
536
-
- [Progressive rollout](https://gofeatureflag.org/docs/configure_flag/rollout/progressive) - increase the percentage of your flag over time.
537
-
- [Scheduled rollout](https://gofeatureflag.org/docs/configure_flag/rollout/scheduled/) - update your flag over time.
538
-
- [Experimentation rollout](https://gofeatureflag.org/docs/configure_flag/rollout/experimentation) - serve your feature only for a determined time *(perfect for A/B testing)*.
535
+
- [Percentages rollout](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/percentage) - impact randomly a subset of your users.
536
+
- [Progressive rollout](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/progressive) - increase the percentage of your flag over time.
537
+
- [Scheduled rollout](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/scheduled) - update your flag over time.
538
+
- [Experimentation rollout](https://gofeatureflag.org/docs/docs/configure_flag/rollout-strategies/experimentation) - serve your feature only for a determined time *(perfect for A/B testing)*.
539
539
540
540
## Notifiers
541
541
If you want to be informed when a flag has changed, you can configure a [**notifier**](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag#NotifierConfig).
0 commit comments