Create a new documentation version v1.28.1 (#1907)

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: thomaspoignant <[email protected]> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
thomaspoignant · May 21, 2024 · 5a00adc · 5a00adc
1 parent 99d2c07
commit 5a00adc
Show file tree

Hide file tree

Showing 76 changed files with 4,649 additions and 5 deletions.
diff --git a/website/versioned_docs/version-v1.28.1/_category_.json b/website/versioned_docs/version-v1.28.1/_category_.json
@@ -0,0 +1,5 @@
+{
+  "position": 0,
+  "collapsible": true,
+  "collapsed": false
+}
diff --git a/website/versioned_docs/version-v1.28.1/configure_flag/_category_.json b/website/versioned_docs/version-v1.28.1/configure_flag/_category_.json
@@ -0,0 +1,10 @@
+{
+  "position": 20,
+  "collapsible": true,
+  "collapsed": true,
+  "label": "Configure your feature flags",
+  "link": {
+    "type": "generated-index",
+    "title": "Configure your feature flags"
+  }
+}
diff --git a/website/versioned_docs/version-v1.28.1/configure_flag/export_flags_usage.mdx b/website/versioned_docs/version-v1.28.1/configure_flag/export_flags_usage.mdx
@@ -0,0 +1,102 @@
+---
+sidebar_position: 40
+description: How to export evaluation data?
+---
+import {Cards} from '@site/src/components/doc/cardv2';
+import { ConfigCardContent } from "@site/src/components/doc/configCardContent";
+import customlogo from '@site/static/docs/collectors/custom.png';
+import filelogo from '@site/static/docs/collectors/file.png';
+import googlelogo from '@site/static/docs/collectors/google.png';
+import loglogo from '@site/static/docs/collectors/log.png';
+import s3logo from '@site/static/docs/collectors/s3.png';
+import webhooklogo from '@site/static/docs/collectors/webhook.png';
+import sqslogo from '@site/static/docs/collectors/sqs.png';
+import kafkalogo from '@site/static/docs/collectors/kafka.png';
+import pubsublogo from '@site/static/docs/collectors/pubsub.png';
+
+
+# How to export evaluation data
+GO Feature Flag allows for the collection of flag usage data.
+During flag evaluation, the key, flag variation and other non-sensitive information used are collected and cached for a
+configurable period of time.
+
+The usage data is then written to a file in a chosen format (`parquet`, `JSON` or `CSV`) at a specified interval and
+exported to your desired location. This provides a single source for easy processing of the data. The feature can be
+configured with options for file format, flush interval, and file location.
+
+To use, simply configure and use the feature flag as normal, and analyze the collected usage data.
+
+## Available exporters
+<Cards cards={[
+  {
+    logoImg: s3logo,
+    title:"AWS S3",
+    content: <ConfigCardContent
+      relayproxyLink={'../relay_proxy/configure_relay_proxy#s3-1'}
+      goModuleLink={'../go_module/data_collection/s3'}
+    />
+  },
+  {
+    logoImg: sqslogo,
+    title:"AWS SQS",
+    content: <ConfigCardContent
+      relayproxyLink={'../relay_proxy/configure_relay_proxy#sqs'}
+      goModuleLink={'../go_module/data_collection/sqs'}
+    />
+  },
+  {
+    logoImg: kafkalogo,
+    title:"Kafka",
+    content: <ConfigCardContent
+      relayproxyLink={'../relay_proxy/configure_relay_proxy#kafka'}
+      goModuleLink={'../go_module/data_collection/kafka'}
+    />
+  },
+  {
+    logoImg: googlelogo,
+    title:"Google Storage",
+    content: <ConfigCardContent
+      relayproxyLink={'../relay_proxy/configure_relay_proxy#google-storage-1'}
+      goModuleLink={'../go_module/data_collection/google_cloud_storage'}
+    />
+  },
+  {
+    logoImg: pubsublogo,
+    title:"Google PubSub",
+    content: <ConfigCardContent
+      relayproxyLink={'../relay_proxy/configure_relay_proxy#google-pubsub'}
+      goModuleLink={'../go_module/data_collection/google_pubsub'}
+    />
+  },
+  {
+    logoImg: webhooklogo,
+    title:"Webhook",
+    content: <ConfigCardContent
+      relayproxyLink={'../relay_proxy/configure_relay_proxy#webhook'}
+      goModuleLink={'../go_module/data_collection/webhook'}
+    />
+  },
+  {
+    logoImg: filelogo,
+    title:"Local File",
+    content: <ConfigCardContent
+      relayproxyLink={'../relay_proxy/configure_relay_proxy#file-1'}
+      goModuleLink={'../go_module/data_collection/file'}
+    />
+  },
+  {
+    logoImg: loglogo,
+    title:"Webhook",
+    content: <ConfigCardContent
+      relayproxyLink={'../relay_proxy/configure_relay_proxy#log'}
+      goModuleLink={'../go_module/data_collection/log'}
+    />
+  },
+  {
+    logoImg: customlogo,
+    title:"Custom ...",
+    content: <ConfigCardContent
+      goModuleLink={'../go_module/data_collection/custom'}
+    />
+  },
+]} />