From 93a67a4906d5b9db1b3f67dcd786d05248e8f048 Mon Sep 17 00:00:00 2001 From: Jack Tracey <41163455+jtracey93@users.noreply.github.com> Date: Tue, 23 Jan 2024 21:37:13 +0000 Subject: [PATCH] Update preview notice wording (#556) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Máté Barabás Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> --- docs/content/contributing/process.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/content/contributing/process.md b/docs/content/contributing/process.md index 0fd0ab582..5d6874a5d 100644 --- a/docs/content/contributing/process.md +++ b/docs/content/contributing/process.md @@ -53,9 +53,11 @@ flowchart TD {{< hint type=important >}} -As the overall AVM framework is not GA (generally available) yet - the CI framework and test automation is not (fully) functional, breaking changes are expected, and additional customer feedback is yet to be gathered and incorporated - modules **MUST NOT** be published at version 1.0.0 or higher at this time. +As the overall AVM framework is not GA (generally available) yet - the CI framework and test automation is not fully functional and implemented across all supported languages yet - breaking changes are expected, and additional customer feedback is yet to be gathered and incorporated. Hence, modules **MUST NOT** be published at version `1.0.0` or higher at this time. -All module **MUST** be published as a pre-release version (e.g., 0.1.0, 0.1.1, 0.2.0, etc.) until the AVM framework becomes GA. +All module **MUST** be published as a pre-release version (e.g., `0.1.0`, `0.1.1`, `0.2.0`, etc.) until the AVM framework becomes GA. + +However, it is important to note that this **DOES NOT** mean that the modules cannot be consumed and utilized. They **CAN** be leveraged in all types of environments (dev, test, prod etc.). Consumers can treat them just like any other IaC module and raise issues or feature requests against them as they learn from the usage of the module. Consumers should also read the release notes for each version, if considering updating to a more recent version of a module to see if there are any considerations or breaking changes etc. {{< /hint >}}