From 173bcd9bc16f732cd09079caf89ab9984d0124c3 Mon Sep 17 00:00:00 2001 From: ivaosthu Date: Fri, 2 Dec 2016 17:58:27 +0100 Subject: [PATCH] Docs wip --- docs/activation-strategies.md | 14 ++++++++++++++ docs/client-spec.md | 11 +++++++++++ docs/index.md | 0 3 files changed, 25 insertions(+) create mode 100644 docs/activation-strategies.md create mode 100644 docs/client-spec.md create mode 100644 docs/index.md diff --git a/docs/activation-strategies.md b/docs/activation-strategies.md new file mode 100644 index 0000000000..bcbb0521cf --- /dev/null +++ b/docs/activation-strategies.md @@ -0,0 +1,14 @@ +# Activation Strategies + +Activation strategies is a crutial part of Unleash. + +TODO! +- Definition lives in unleash-server +- Implementation lives in the client implementations +- Configuration is assiated with a feature toggle +- Document common strategies, and how to implement them + - gradual rollout (sticky vs. random) + - active for user with id + - active for host + - active for remote host + - totally custom \ No newline at end of file diff --git a/docs/client-spec.md b/docs/client-spec.md new file mode 100644 index 0000000000..87f8585aa0 --- /dev/null +++ b/docs/client-spec.md @@ -0,0 +1,11 @@ +# Client Specification 1.0 + +This document describes the client contract. + +**TODO:** +- fetch and cache toggles (etag headers etc) +- provide strategies implementations +- evaluate if a feature toggle is enabled or not with the given activation strategies and configurations. +- backup features +- registration +- send metrics \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000..e69de29bb2