Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare the doc to be compatible with docusaurus #273

Merged
merged 1 commit into from
Jul 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions docs/data_collection/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 8,
"collapsible": true,
"collapsed": true,
"link": {"type": "doc", "id": "sdk/data_collection/index"}
}
4 changes: 4 additions & 0 deletions docs/data_collection/custom.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 4 additions & 0 deletions docs/data_collection/file.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/data_collection/google_cloud_storage.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 5 additions & 1 deletion docs/data_collection/index.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 4 additions & 0 deletions docs/data_collection/log.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/data_collection/s3.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/data_collection/webhook.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
9 changes: 9 additions & 0 deletions docs/flag_file/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"position": 5,
"collapsible": true,
"collapsed": false,
"link": {"type": "doc", "id": "sdk/flag_file/index"}
}



4 changes: 4 additions & 0 deletions docs/flag_file/custom.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/flag_file/file.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 4 additions & 0 deletions docs/flag_file/github.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 6
---

# Github

The [**Github Retriever**](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/retriever/githubretriever/#Retriever)
Expand Down
4 changes: 4 additions & 0 deletions docs/flag_file/google_cloud_storage.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
4 changes: 4 additions & 0 deletions docs/flag_file/http.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
4 changes: 4 additions & 0 deletions docs/flag_file/index.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 4 additions & 0 deletions docs/flag_file/kubernetes_configmaps.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
4 changes: 4 additions & 0 deletions docs/flag_file/s3.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 4 additions & 0 deletions docs/flag_format.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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
---

<p align="center">
Expand Down
6 changes: 6 additions & 0 deletions docs/notifier/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 9,
"collapsible": true,
"collapsed": true,
"link": {"type": "doc", "id": "sdk/notifier/index"}
}
4 changes: 4 additions & 0 deletions docs/notifier/custom.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 4
---

# Custom Notifier

To create a custom notifier you must have a `struct` that implements the
Expand Down
6 changes: 5 additions & 1 deletion docs/notifier/index.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
4 changes: 4 additions & 0 deletions docs/notifier/slack.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/notifier/webhook.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
5 changes: 5 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_position: 2
---


# Getting started

## Installation
Expand Down
6 changes: 6 additions & 0 deletions docs/rollout/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 7,
"collapsible": true,
"collapsed": true,
"link": {"type": "doc", "id": "sdk/rollout/index"}
}
4 changes: 4 additions & 0 deletions docs/rollout/canary.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/rollout/experimentation.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
6 changes: 5 additions & 1 deletion docs/rollout/index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/rollout/progressive.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 4
---

# Progressive rollout

A **progressive rollout** allows you to increase the percentage of your flag over time.
Expand Down
4 changes: 4 additions & 0 deletions docs/rollout/scheduled.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 5
---

# Scheduled rollout

Scheduling introduces the ability for users to changes their flags for future points in time.
Expand Down
4 changes: 4 additions & 0 deletions docs/users.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 6
---

# Targeting users with flags

## Users
Expand Down