diff --git a/docs/configuration.md b/docs/configuration.md index 02bd4755143..da3d375a813 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 3 +--- + # Configuration `go-feature-flag` needs to be initialized to be used. During the initialization you must give a [`ffclient.Config{}`](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag#Config) configuration object. diff --git a/docs/data_collection/_category_.json b/docs/data_collection/_category_.json new file mode 100644 index 00000000000..519ac62d22c --- /dev/null +++ b/docs/data_collection/_category_.json @@ -0,0 +1,6 @@ +{ + "position": 8, + "collapsible": true, + "collapsed": true, + "link": {"type": "doc", "id": "sdk/data_collection/index"} +} diff --git a/docs/data_collection/custom.md b/docs/data_collection/custom.md index 7d076054cf0..c7adb37bfad 100644 --- a/docs/data_collection/custom.md +++ b/docs/data_collection/custom.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 7 +--- + # Custom exporter To create a custom exporter you must have a `struct` that implements the [`exporter.Exporter`](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/internal/exporter#Exporter) interface. diff --git a/docs/data_collection/file.md b/docs/data_collection/file.md index 86625081fc0..ec0f92d06f9 100644 --- a/docs/data_collection/file.md +++ b/docs/data_collection/file.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +--- + # File Exporter The file exporter will collect the data and create a new file in a specific folder everytime we send the data. This file should be in the local instance. diff --git a/docs/data_collection/google_cloud_storage.md b/docs/data_collection/google_cloud_storage.md index 7d660affbf6..1f142fe1bda 100644 --- a/docs/data_collection/google_cloud_storage.md +++ b/docs/data_collection/google_cloud_storage.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 4 +--- + # Google Cloud Storage Exporter The **Google Cloud Storage exporter** will collect the data and create a new file in a specific folder everytime we send the data. diff --git a/docs/data_collection/index.md b/docs/data_collection/index.md index f32558ff121..9f716d010bc 100644 --- a/docs/data_collection/index.md +++ b/docs/data_collection/index.md @@ -1,4 +1,8 @@ -# Data format / Export data +--- +sidebar_position: 1 +--- + +# Export data If you want to export data about how your flag are used, you can use the **`DataExporter`**. It collects all the variations events and can save these events on several locations: diff --git a/docs/data_collection/log.md b/docs/data_collection/log.md index 30c0205c9b4..c0b8bfdd56c 100644 --- a/docs/data_collection/log.md +++ b/docs/data_collection/log.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 7 +--- + # Log Exporter The log exporter is here mostly for backward compatibility *(originally every variation were logged, but it can be a lot of data for a default configuration)*. It will use your logger `ffclient.Config.Logger` to log every variation changes. diff --git a/docs/data_collection/s3.md b/docs/data_collection/s3.md index f74ba5bb34d..24f7a89b7bb 100644 --- a/docs/data_collection/s3.md +++ b/docs/data_collection/s3.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 3 +--- + # S3 Exporter The **S3 exporter** will collect the data and create a new file in a specific folder everytime we send the data. diff --git a/docs/data_collection/webhook.md b/docs/data_collection/webhook.md index 9f769ac65d7..5f094f52f58 100644 --- a/docs/data_collection/webhook.md +++ b/docs/data_collection/webhook.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 6 +--- + # Webhook Exporter The **Webhook exporter** will collect the data and send them via an HTTP POST request to the specified endpoint. diff --git a/docs/flag_file/_category_.json b/docs/flag_file/_category_.json new file mode 100644 index 00000000000..474b9be688e --- /dev/null +++ b/docs/flag_file/_category_.json @@ -0,0 +1,9 @@ +{ + "position": 5, + "collapsible": true, + "collapsed": false, + "link": {"type": "doc", "id": "sdk/flag_file/index"} +} + + + diff --git a/docs/flag_file/custom.md b/docs/flag_file/custom.md index acf43efa7b2..dd20ba701d4 100644 --- a/docs/flag_file/custom.md +++ b/docs/flag_file/custom.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 8 +--- + # Custom Retriever To create a custom retriever you must have a `struct` that implements the [`Retriever`](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/retriever/#Retriever) interface. diff --git a/docs/flag_file/file.md b/docs/flag_file/file.md index 18b80ec7249..4ed4f62d0c9 100644 --- a/docs/flag_file/file.md +++ b/docs/flag_file/file.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 4 +--- + # File The [**File Retriever**](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/retriever/fileretriever/#Retriever) will read a local file to get your flags. diff --git a/docs/flag_file/github.md b/docs/flag_file/github.md index 8ef6d3a1d8a..d405d6eb982 100644 --- a/docs/flag_file/github.md +++ b/docs/flag_file/github.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 6 +--- + # Github The [**Github Retriever**](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/retriever/githubretriever/#Retriever) diff --git a/docs/flag_file/google_cloud_storage.md b/docs/flag_file/google_cloud_storage.md index e92f2c9c4c1..3094584fbd6 100644 --- a/docs/flag_file/google_cloud_storage.md +++ b/docs/flag_file/google_cloud_storage.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +--- + # Google Cloud Storage The [**Google Cloud Storage Retriever**](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/retriever/gcstorageretriever/#Retriever) diff --git a/docs/flag_file/http.md b/docs/flag_file/http.md index e47bf1125a2..aa778caf06f 100644 --- a/docs/flag_file/http.md +++ b/docs/flag_file/http.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 7 +--- + # HTTP endpoint The [__HTTP Retriever__](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/retriever/httpretriever/#Retriever) diff --git a/docs/flag_file/index.md b/docs/flag_file/index.md index 2e7ed43ca66..a01c0055cc0 100644 --- a/docs/flag_file/index.md +++ b/docs/flag_file/index.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 1 +--- + # Where to store my file? The module supports different ways of retrieving the flag file. Available retriever are: diff --git a/docs/flag_file/kubernetes_configmaps.md b/docs/flag_file/kubernetes_configmaps.md index 30107832bbf..0b9d7626d94 100644 --- a/docs/flag_file/kubernetes_configmaps.md +++ b/docs/flag_file/kubernetes_configmaps.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 3 +--- + # Kubernetes configmaps The [**Kubernetes Retriever**](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/retriever/k8sretriever/#Retriever) will access flags in a Kubernetes ConfigMap via the [Kubernetes Go client](https://github.com/kubernetes/client-go) diff --git a/docs/flag_file/s3.md b/docs/flag_file/s3.md index f8551cd073d..97be051359f 100644 --- a/docs/flag_file/s3.md +++ b/docs/flag_file/s3.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +--- + # S3 Bucket The [**S3Retriever**](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/retriever/s3retriever/#Retriever) will use the [aws-sdk](https://github.com/aws/aws-sdk-go) to access your flag in an S3 bucket. diff --git a/docs/flag_format.md b/docs/flag_format.md index e9c6bdb4232..33f85daa39b 100644 --- a/docs/flag_format.md +++ b/docs/flag_format.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 4 +--- + # Configure a flag `go-feature-flag` core feature is to centralize all your feature flags in a source file, and to avoid hosting and maintaining a backend server to manage them. diff --git a/docs/index.md b/docs/index.md index 73c96451d97..f034363885d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,7 @@ --- title: GO Feature flags with no complex system to maintain! description: go-feature-flag is a simple and complete feature flag solution, without any complex backend system to install. You need only a file as your backend. +sidebar_position: 1 ---

diff --git a/docs/notifier/_category_.json b/docs/notifier/_category_.json new file mode 100644 index 00000000000..de7f73c4efb --- /dev/null +++ b/docs/notifier/_category_.json @@ -0,0 +1,6 @@ +{ + "position": 9, + "collapsible": true, + "collapsed": true, + "link": {"type": "doc", "id": "sdk/notifier/index"} +} diff --git a/docs/notifier/custom.md b/docs/notifier/custom.md index 70e26dc6bac..1c509eddfb0 100644 --- a/docs/notifier/custom.md +++ b/docs/notifier/custom.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 4 +--- + # Custom Notifier To create a custom notifier you must have a `struct` that implements the diff --git a/docs/notifier/index.md b/docs/notifier/index.md index b4261ec557b..70d8a53b41c 100644 --- a/docs/notifier/index.md +++ b/docs/notifier/index.md @@ -1,4 +1,8 @@ -# Notifiers +--- +sidebar_position: 1 +--- + +# Notify flag changes 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). diff --git a/docs/notifier/slack.md b/docs/notifier/slack.md index eb4a39050e3..97195bc0817 100644 --- a/docs/notifier/slack.md +++ b/docs/notifier/slack.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +--- + # Slack Notifier The **Slack** notifier allows you to get notification on your favorite slack channel when an instance of diff --git a/docs/notifier/webhook.md b/docs/notifier/webhook.md index b679af08173..ede7e75fd4b 100644 --- a/docs/notifier/webhook.md +++ b/docs/notifier/webhook.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 3 +--- + # Webhook Notifier The **Webhook notifier** will perform an HTTP POST request to the specified endpoint everytime that a change in the flags is detected. diff --git a/docs/quickstart.md b/docs/quickstart.md index 7777f824428..f00aa35f6ca 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -1,3 +1,8 @@ +--- +sidebar_position: 2 +--- + + # Getting started ## Installation diff --git a/docs/rollout/_category_.json b/docs/rollout/_category_.json new file mode 100644 index 00000000000..18c8a8eaa8a --- /dev/null +++ b/docs/rollout/_category_.json @@ -0,0 +1,6 @@ +{ + "position": 7, + "collapsible": true, + "collapsed": true, + "link": {"type": "doc", "id": "sdk/rollout/index"} +} diff --git a/docs/rollout/canary.md b/docs/rollout/canary.md index 6e71159975b..96884ec6984 100644 --- a/docs/rollout/canary.md +++ b/docs/rollout/canary.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +--- + # Canary Release **Canary release** is a technique to reduce the risk of introducing a new software version in production by slowly rolling out the change to a small subset of users before rolling it out to the entire infrastructure and making it available to everybody. diff --git a/docs/rollout/experimentation.md b/docs/rollout/experimentation.md index 2328b3f60eb..e22566733ae 100644 --- a/docs/rollout/experimentation.md +++ b/docs/rollout/experimentation.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 3 +--- + # Experimentation rollout / A/B Testing An **experimentation rollout** is when your flag is configured to be served only for a determined time. diff --git a/docs/rollout/index.md b/docs/rollout/index.md index 708fb1297a2..5be63f746b3 100644 --- a/docs/rollout/index.md +++ b/docs/rollout/index.md @@ -1,4 +1,8 @@ -# Available rollout strategies +--- +sidebar_position: 1 +--- + +# Rollout strategies A critical part of every new feature release is orchestrating the actual launch schedule between Product, Engineering, and Marketing teams. Delivering powerful user experiences typically requires software teams to manage complex releases and make manual updates at inconvenient times. diff --git a/docs/rollout/progressive.md b/docs/rollout/progressive.md index e45b10ff8eb..0a56c50006a 100644 --- a/docs/rollout/progressive.md +++ b/docs/rollout/progressive.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 4 +--- + # Progressive rollout A **progressive rollout** allows you to increase the percentage of your flag over time. diff --git a/docs/rollout/scheduled.md b/docs/rollout/scheduled.md index 70d68e100f4..3daa45ad93f 100644 --- a/docs/rollout/scheduled.md +++ b/docs/rollout/scheduled.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 5 +--- + # Scheduled rollout Scheduling introduces the ability for users to changes their flags for future points in time. diff --git a/docs/users.md b/docs/users.md index 25bc60a9dae..f5c75ad0fe6 100644 --- a/docs/users.md +++ b/docs/users.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 6 +--- + # Targeting users with flags ## Users