From f93922123f1ab4df2b9f3c1dbb59d1b7fcfd62cf Mon Sep 17 00:00:00 2001 From: Valentin Maerten Date: Fri, 8 Aug 2025 12:44:13 +0200 Subject: [PATCH] add experiment template --- website/src/docs/experiments/template.md | 37 ++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 website/src/docs/experiments/template.md diff --git a/website/src/docs/experiments/template.md b/website/src/docs/experiments/template.md new file mode 100644 index 00000000..81437ebc --- /dev/null +++ b/website/src/docs/experiments/template.md @@ -0,0 +1,37 @@ +--- +title: '--- Template ---' +--- + +# \{Name of Experiment\} (#\{Issue\}) + +::: warning + +All experimental features are subject to breaking changes and/or removal _at any +time_. We strongly recommend that you do not use these features in a production +environment. They are intended for testing and feedback only. + +::: + +::: warning + +This experiment breaks the following functionality: + +- \{list any existing functionality that will be broken by this experiment\} +- \{if there are no breaking changes, remove this admonition\} + +::: + +:::info + +To enable this experiment, set the environment variable: `TASK_X_{feature}=1`. +Check out [our guide to enabling experiments ][enabling-experiments] for more +information. + +::: + +\{Short description of the feature\} + +\{Short explanation of how users should migrate to the new behavior\} + +[enabling-experiments]: /experiments#enabling-experiments +