mirror of
https://github.com/go-task/task.git
synced 2025-08-10 22:42:19 +02:00
add experiment template
This commit is contained in:
37
website/src/docs/experiments/template.md
Normal file
37
website/src/docs/experiments/template.md
Normal file
@@ -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
|
||||||
|
|
Reference in New Issue
Block a user