From f7287eb021d3e0788ae54c308fc89d3afe51c9d1 Mon Sep 17 00:00:00 2001 From: Maurice Meyer Date: Mon, 16 Sep 2024 11:12:18 +0200 Subject: [PATCH 1/4] docs: explicitly mention deviations from semver --- docs/sources/introduction/backward-compatibility.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/sources/introduction/backward-compatibility.md b/docs/sources/introduction/backward-compatibility.md index ac3f7db505..fecb5f0cbd 100644 --- a/docs/sources/introduction/backward-compatibility.md +++ b/docs/sources/introduction/backward-compatibility.md @@ -8,7 +8,7 @@ weight: 999 # {{% param "FULL_PRODUCT_NAME" %}} backward compatibility -{{< param "FULL_PRODUCT_NAME" >}} follows [semantic versioning][]. +{{< param "FULL_PRODUCT_NAME" >}} mosty follows [semantic versioning][], with the differences documented in the [Exceptions](#exceptions) section. {{< param "PRODUCT_NAME" >}} is stable, and we strive to maintain backward compatibility between minor and patch versions. Documented functionality that's released as _Generally available_ is covered by backward compatibility, including: @@ -21,7 +21,7 @@ Documented functionality that's released as _Generally available_ is covered by ## Exceptions -We strive to maintain backward compatibility, but there are situations that may arise that require a breaking change without a new major version: +We strive to maintain backward compatibility, but there are situations that may arise that require a breaking change without a new major version, deviating from [item 8 of the semver specification]: * **Security**: A security issue may arise that requires breaking compatibility. @@ -38,4 +38,5 @@ We strive to maintain backward compatibility, but there are situations that may We try, whenever possible, to resolve these issues without breaking compatibility. [semantic versioning]: https://semver.org/ +[item 8 of the semver specification]: https://semver.org/spec/v2.0.0.html#spec-item-8 [alloy-mixin]: https://github.com/grafana/alloy/tree/main/operations/alloy-mixin From 8deef0b14abee17b1c57f91be3681c571c88cb93 Mon Sep 17 00:00:00 2001 From: morre Date: Tue, 17 Sep 2024 17:16:18 +0200 Subject: [PATCH 2/4] Update docs/sources/introduction/backward-compatibility.md Co-authored-by: William Dumont --- docs/sources/introduction/backward-compatibility.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/introduction/backward-compatibility.md b/docs/sources/introduction/backward-compatibility.md index fecb5f0cbd..951f463283 100644 --- a/docs/sources/introduction/backward-compatibility.md +++ b/docs/sources/introduction/backward-compatibility.md @@ -8,7 +8,7 @@ weight: 999 # {{% param "FULL_PRODUCT_NAME" %}} backward compatibility -{{< param "FULL_PRODUCT_NAME" >}} mosty follows [semantic versioning][], with the differences documented in the [Exceptions](#exceptions) section. +{{< param "FULL_PRODUCT_NAME" >}} mostly follows [semantic versioning][], with the differences documented in the [Exceptions](#exceptions) section. {{< param "PRODUCT_NAME" >}} is stable, and we strive to maintain backward compatibility between minor and patch versions. Documented functionality that's released as _Generally available_ is covered by backward compatibility, including: From 66431a5fde475af97e100028f181aa9aa75a0c9f Mon Sep 17 00:00:00 2001 From: morre Date: Tue, 17 Sep 2024 19:00:11 +0200 Subject: [PATCH 3/4] Update docs/sources/introduction/backward-compatibility.md Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> --- docs/sources/introduction/backward-compatibility.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/introduction/backward-compatibility.md b/docs/sources/introduction/backward-compatibility.md index 951f463283..2c45b4c217 100644 --- a/docs/sources/introduction/backward-compatibility.md +++ b/docs/sources/introduction/backward-compatibility.md @@ -21,7 +21,7 @@ Documented functionality that's released as _Generally available_ is covered by ## Exceptions -We strive to maintain backward compatibility, but there are situations that may arise that require a breaking change without a new major version, deviating from [item 8 of the semver specification]: +We strive to maintain backward compatibility, but there are situations that may arise that require a breaking change without a new major version, deviating from [item 8 of the semver specification][]: * **Security**: A security issue may arise that requires breaking compatibility. From f2a9e7b7c4fa5578f0d5651f4143e69d8f099ceb Mon Sep 17 00:00:00 2001 From: morre Date: Tue, 17 Sep 2024 19:00:19 +0200 Subject: [PATCH 4/4] Update docs/sources/introduction/backward-compatibility.md Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> --- docs/sources/introduction/backward-compatibility.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/introduction/backward-compatibility.md b/docs/sources/introduction/backward-compatibility.md index 2c45b4c217..c3b4efc666 100644 --- a/docs/sources/introduction/backward-compatibility.md +++ b/docs/sources/introduction/backward-compatibility.md @@ -8,7 +8,7 @@ weight: 999 # {{% param "FULL_PRODUCT_NAME" %}} backward compatibility -{{< param "FULL_PRODUCT_NAME" >}} mostly follows [semantic versioning][], with the differences documented in the [Exceptions](#exceptions) section. +{{< param "FULL_PRODUCT_NAME" >}} follows [semantic versioning][]. [Exceptions](#exceptions) may arise that require a breaking change without a new major version. {{< param "PRODUCT_NAME" >}} is stable, and we strive to maintain backward compatibility between minor and patch versions. Documented functionality that's released as _Generally available_ is covered by backward compatibility, including: