From 992da33d0ddf0c2ddb53be58d66cdfc5fbfaaa2e Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Thu, 27 May 2021 12:16:44 +0200 Subject: [PATCH 1/6] Added the experimental features page Signed-off-by: Francesco Guardiani --- docs/eventing/experimental-features.md | 60 ++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 docs/eventing/experimental-features.md diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md new file mode 100644 index 00000000000..482c16809dc --- /dev/null +++ b/docs/eventing/experimental-features.md @@ -0,0 +1,60 @@ +--- +title: "Experimental features" +weight: 99 +type: "docs" +--- + +# Experimental features + +In Knative Eventing we want to keep the innovation alive, experimenting and delivering new features without affecting the stability of the project. + +In order to do achieve that goal, we have a process to include new features. +This allows users like you to try out new features and provide feedback back to the project. + +This document explains how to enable experimental features and which ones are available today. + +For more details about the process, the feature phases, quality requirements and guarantees, check out the [Experimental features process documentation](https://github.com/knative/eventing/blob/main/docs/experimental-features.md). + +## Before you begin + +You must have a Knative cluster running with the Eventing component installed. [Learn more](../install/) + +## Experimental features configuration + +When installing Eventing, the `config-experimental-features` ConfigMap is added to your cluster in the `knative-eventing` namespace. +In order to enable a feature, you just need to add it to the config map and set its value to `"true"`. +For example, to enable `new-cool-feature`: + +```yaml +apiVersion: v1 +kind: ConfigMap +metadata: + name: config-experimental-features + namespace: knative-eventing + labels: + eventing.knative.dev/release: devel + knative.dev/config-propagation: original + knative.dev/config-category: eventing +data: + new-cool-feature: "true" +``` + +In order to disable it, you can either remove the flag or set it to `"false"`: + +```yaml +apiVersion: v1 +kind: ConfigMap +metadata: + name: config-experimental-features + namespace: knative-eventing + labels: + eventing.knative.dev/release: devel + knative.dev/config-propagation: original + knative.dev/config-category: eventing +data: + new-cool-feature: "false" +``` + +## Features list + + From 844cfa4792f389244f7814afc1513e6894076bc1 Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Thu, 27 May 2021 12:20:15 +0200 Subject: [PATCH 2/6] Trailing whitespaces Signed-off-by: Francesco Guardiani --- docs/eventing/experimental-features.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md index 482c16809dc..10e0deb3afd 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -8,7 +8,7 @@ type: "docs" In Knative Eventing we want to keep the innovation alive, experimenting and delivering new features without affecting the stability of the project. -In order to do achieve that goal, we have a process to include new features. +In order to achieve that goal, we have a process to include new features. This allows users like you to try out new features and provide feedback back to the project. This document explains how to enable experimental features and which ones are available today. @@ -21,7 +21,7 @@ You must have a Knative cluster running with the Eventing component installed. [ ## Experimental features configuration -When installing Eventing, the `config-experimental-features` ConfigMap is added to your cluster in the `knative-eventing` namespace. +When installing Eventing, the `config-experimental-features` ConfigMap is added to your cluster in the `knative-eventing` namespace. In order to enable a feature, you just need to add it to the config map and set its value to `"true"`. For example, to enable `new-cool-feature`: From 47f78a8c0d1abeca58ff99b6fb18b357c6c4ce57 Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Thu, 27 May 2021 12:24:24 +0200 Subject: [PATCH 3/6] Added to the index Signed-off-by: Francesco Guardiani --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index bf10cb1348a..2746cb09f1c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -187,6 +187,7 @@ nav: - Debugging: eventing/debugging/index.md - Accessing CloudEvent traces: eventing/accessing-traces.md - Metrics API: eventing/metrics.md + - Experimental Features: eventing/experimental-features.md - Code samples: - Overview: eventing/samples/README.md - Container source: eventing/sources/container-source/README.md From 8730426c93ea7a485a64b671c51cd59210bc4186 Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Thu, 27 May 2021 13:37:53 +0200 Subject: [PATCH 4/6] suggestion by julz Signed-off-by: Francesco Guardiani --- docs/eventing/experimental-features.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md index 10e0deb3afd..82087b7ccb7 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -6,9 +6,9 @@ type: "docs" # Experimental features -In Knative Eventing we want to keep the innovation alive, experimenting and delivering new features without affecting the stability of the project. +In Knative we want to keep the innovation alive, experimenting and delivering new features without affecting the stability of the project. -In order to achieve that goal, we have a process to include new features. +In order to achieve that goal in Knative Eventing, we have a process to include new features. This allows users like you to try out new features and provide feedback back to the project. This document explains how to enable experimental features and which ones are available today. From 87616afc3fef286b6fba0c5afd67c696c7971572 Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Thu, 27 May 2021 15:32:29 +0200 Subject: [PATCH 5/6] suggestion by ashleigh Signed-off-by: Francesco Guardiani --- docs/eventing/experimental-features.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md index 82087b7ccb7..d0fac5e8410 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -1,9 +1,3 @@ ---- -title: "Experimental features" -weight: 99 -type: "docs" ---- - # Experimental features In Knative we want to keep the innovation alive, experimenting and delivering new features without affecting the stability of the project. From ac99766ff2171c80a73fd3a197425a5f6550ed76 Mon Sep 17 00:00:00 2001 From: slinkydeveloper Date: Tue, 1 Jun 2021 09:30:15 +0200 Subject: [PATCH 6/6] Reflected changes of https://github.com/knative/eventing/pull/5459 Signed-off-by: Francesco Guardiani --- docs/eventing/experimental-features.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md index d0fac5e8410..9d42911d516 100644 --- a/docs/eventing/experimental-features.md +++ b/docs/eventing/experimental-features.md @@ -15,38 +15,38 @@ You must have a Knative cluster running with the Eventing component installed. [ ## Experimental features configuration -When installing Eventing, the `config-experimental-features` ConfigMap is added to your cluster in the `knative-eventing` namespace. -In order to enable a feature, you just need to add it to the config map and set its value to `"true"`. +When installing Eventing, the `config-features` ConfigMap is added to your cluster in the `knative-eventing` namespace. +In order to enable a feature, you just need to add it to the config map and set its value to `"enabled"`. For example, to enable `new-cool-feature`: ```yaml apiVersion: v1 kind: ConfigMap metadata: - name: config-experimental-features + name: config-features namespace: knative-eventing labels: eventing.knative.dev/release: devel knative.dev/config-propagation: original knative.dev/config-category: eventing data: - new-cool-feature: "true" + new-cool-feature: "enabled" ``` -In order to disable it, you can either remove the flag or set it to `"false"`: +In order to disable it, you can either remove the flag or set it to `"disabled"`: ```yaml apiVersion: v1 kind: ConfigMap metadata: - name: config-experimental-features + name: config-features namespace: knative-eventing labels: eventing.knative.dev/release: devel knative.dev/config-propagation: original knative.dev/config-category: eventing data: - new-cool-feature: "false" + new-cool-feature: "disabled" ``` ## Features list