From 0c7bd2a70824e6966451a39cacedbe29dece42b5 Mon Sep 17 00:00:00 2001 From: jo Date: Tue, 23 Sep 2025 17:09:14 +0200 Subject: [PATCH 1/2] docs: add experimental features maturity --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 066e2906..e6d87119 100644 --- a/README.md +++ b/README.md @@ -66,12 +66,15 @@ Experimental features are published as part of our regular releases (e.g. a prod public beta). During an experimental phase, breaking changes on those features may occur within minor releases. +Experimental features have different levels of maturity (e.g. experimental, alpha, beta) +based on the maturity of the upstream API. + While experimental features will be announced in the release notes, you can also find whether a python class or function is experimental in its docstring: ``` Experimental: - $PRODUCT is experimental, breaking changes may occur within minor releases. + $PRODUCT is $MATURITY, breaking changes may occur within minor releases. See https://docs.hetzner.cloud/changelog#$SLUG for more details. ``` @@ -151,7 +154,7 @@ To publish experimental features as part of regular releases: ```py """ Experimental: - $PRODUCT is experimental, breaking changes may occur within minor releases. + $PRODUCT is $MATURITY, breaking changes may occur within minor releases. See https://docs.hetzner.cloud/changelog#$SLUG for more details. """ ``` From 0ee1d64519a6ec95906448d3d0ad11d846ed8eaa Mon Sep 17 00:00:00 2001 From: jo Date: Wed, 24 Sep 2025 10:34:50 +0200 Subject: [PATCH 2/2] docs: add note about local and upstream stability --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e6d87119..07666cbd 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,8 @@ Experimental features are published as part of our regular releases (e.g. a prod public beta). During an experimental phase, breaking changes on those features may occur within minor releases. +The stability of experimental features is not related to the stability of its upstream API. + Experimental features have different levels of maturity (e.g. experimental, alpha, beta) based on the maturity of the upstream API.