added risks of using experimental functions with links back

pull/469/head
Scott Anderson 2019-09-17 15:27:17 -06:00
parent dfabc6fdba
commit 71d8297506
11 changed files with 32 additions and 1 deletions

View File

@ -15,11 +15,29 @@ v2.0/tags: [functions, experimental, package]
The Flux Experimental package includes experimental functions that perform various tasks. The Flux Experimental package includes experimental functions that perform various tasks.
{{% warn %}} {{% warn %}}
Experimental functions are subject to change at any time and are not recommended for production use. ### Use experimental functions at your own risk
Experimental functions are subject to change and are **not recommended for production use**.
At any time, experimental functions and packages may:
- be moved or promoted to a permanent location
- undergo API changes
- stop working with no planned fixes
- be removed without warning nor published explanation
**By using experimental functions and packages, you agree to these risks.**
{{% /warn %}} {{% /warn %}}
## Experimental functions ## Experimental functions
The following functions are part of the base experimental package.
To use them, import the `experimental` package.
```js
import "experimental"
```
{{< children type="functions" show="pages" >}} {{< children type="functions" show="pages" >}}
## Experimental packages ## Experimental packages
Experimental packages require different import paths than base experimental functions.
{{< children show="sections" >}} {{< children show="sections" >}}

View File

@ -19,6 +19,8 @@ _**Function type:** Transformation_
{{% warn %}} {{% warn %}}
The `experimental.addDuration()` function is subject to change at any time. The `experimental.addDuration()` function is subject to change at any time.
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
This specific function will be removed once duration vectors are implemented. This specific function will be removed once duration vectors are implemented.
See [influxdata/flux#413](https://github.com/influxdata/flux/issues/413). See [influxdata/flux#413](https://github.com/influxdata/flux/issues/413).
{{% /warn %}} {{% /warn %}}

View File

@ -17,6 +17,7 @@ The Flux Bigtable package provides tools for working with data in
{{% warn %}} {{% warn %}}
The Bigtable package is currently experimental and is subject to change at any time. The Bigtable package is currently experimental and is subject to change at any time.
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
{{% /warn %}} {{% /warn %}}
Import the `experimental/bigtable` package: Import the `experimental/bigtable` package:

View File

@ -16,6 +16,7 @@ _**Function type:** Input_
{{% warn %}} {{% warn %}}
The `bigtable.from()` function is currently experimental and is subject to change at any time. The `bigtable.from()` function is currently experimental and is subject to change at any time.
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
{{% /warn %}} {{% /warn %}}
```js ```js

View File

@ -19,6 +19,8 @@ _**Function type:** Transformation_
{{% warn %}} {{% warn %}}
The `experimental.group()` function is subject to change at any time. The `experimental.group()` function is subject to change at any time.
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
This specific function will be removed once the proposed `extend` mode is sufficiently vetted. This specific function will be removed once the proposed `extend` mode is sufficiently vetted.
{{% /warn %}} {{% /warn %}}

View File

@ -16,6 +16,7 @@ Flux MQTT functions provide tools for working with Message Queuing Telemetry Tra
{{% warn %}} {{% warn %}}
The MQTT package is currently experimental and is subject to change at any time. The MQTT package is currently experimental and is subject to change at any time.
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
{{% /warn %}} {{% /warn %}}
Import the `experimental/mqtt` package: Import the `experimental/mqtt` package:

View File

@ -15,6 +15,7 @@ _**Function type:** Output_
{{% warn %}} {{% warn %}}
The `mqtt.to()` function is currently experimental and is subject to change at any time. The `mqtt.to()` function is currently experimental and is subject to change at any time.
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
{{% /warn %}} {{% /warn %}}
```js ```js

View File

@ -15,6 +15,7 @@ _**Function type:** Transformation_
{{% warn %}} {{% warn %}}
The `experimental.objectKeys()` function is subject to change at any time. The `experimental.objectKeys()` function is subject to change at any time.
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
{{% /warn %}} {{% /warn %}}
```js ```js

View File

@ -22,6 +22,7 @@ _**Function type:** Transformation_
{{% warn %}} {{% warn %}}
The `experimental.set()` function is subject to change at any time. The `experimental.set()` function is subject to change at any time.
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
{{% /warn %}} {{% /warn %}}
```js ```js

View File

@ -19,6 +19,8 @@ _**Function type:** Transformation_
{{% warn %}} {{% warn %}}
The `experimental.subDuration()` function is subject to change at any time. The `experimental.subDuration()` function is subject to change at any time.
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
This specific function will be removed once duration vectors are implemented. This specific function will be removed once duration vectors are implemented.
See [influxdata/flux#413](https://github.com/influxdata/flux/issues/413). See [influxdata/flux#413](https://github.com/influxdata/flux/issues/413).
{{% /warn %}} {{% /warn %}}

View File

@ -20,6 +20,7 @@ _**Function type:** Output_
{{% warn %}} {{% warn %}}
The `experimental.to()` function is subject to change at any time. The `experimental.to()` function is subject to change at any time.
By using it, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
{{% /warn %}} {{% /warn %}}
```js ```js