Skip to content

Commit 628aa6d

Browse files
authored
docs: add experimental features maturity (hetznercloud#557)
Add the API upstream maturity to our experimental features release process.
1 parent 2134cb8 commit 628aa6d

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,17 @@ Experimental features are published as part of our regular releases (e.g. a prod
6666
public beta). During an experimental phase, breaking changes on those features may occur
6767
within minor releases.
6868

69+
The stability of experimental features is not related to the stability of its upstream API.
70+
71+
Experimental features have different levels of maturity (e.g. experimental, alpha, beta)
72+
based on the maturity of the upstream API.
73+
6974
While experimental features will be announced in the release notes, you can also find
7075
whether a python class or function is experimental in its docstring:
7176

7277
```
7378
Experimental:
74-
$PRODUCT is experimental, breaking changes may occur within minor releases.
79+
$PRODUCT is $MATURITY, breaking changes may occur within minor releases.
7580
See https://docs.hetzner.cloud/changelog#$SLUG for more details.
7681
```
7782

@@ -151,7 +156,7 @@ To publish experimental features as part of regular releases:
151156
```py
152157
"""
153158
Experimental:
154-
$PRODUCT is experimental, breaking changes may occur within minor releases.
159+
$PRODUCT is $MATURITY, breaking changes may occur within minor releases.
155160
See https://docs.hetzner.cloud/changelog#$SLUG for more details.
156161
"""
157162
```

0 commit comments

Comments
 (0)