Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Clayton Cornell <[email protected]>
  • Loading branch information
rfratto and clayton-cornell authored Apr 8, 2024
1 parent f639acd commit f2bb42b
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/sources/backwards-compatability.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
---
canonical: https://grafana.com/docs/alloy/latest/backwards-compatability/
description: Grafana Alloy backwards compatibility
menuTitle: Backwards compatibility
title: Grafana Alloy backwards compatibility
description: Grafana Alloy backward compatibility
menuTitle: Backward compatibility
title: Grafana Alloy backward compatibility
weight: 950
---

# {{% param "FULL_PRODUCT_NAME" %}} backwards compatibility
# {{% param "FULL_PRODUCT_NAME" %}} backward compatibility

{{< param "FULL_PRODUCT_NAME" >}} follows [semantic versioning][].
This means that {{< param "PRODUCT_NAME" >}} is stable, and that we strive to maintain backwards compatibility between minor and patch versions.
{{< param "PRODUCT_NAME" >}} is stable, and we strive to maintain backward compatibility between minor and patch versions.

Functionality which is documented and released as _Generally available_ is covered by backwards compatibility, including:
Documented functionality that's released as _Generally available_ is covered by backward compatibility, including:

* **User configuration**, including the {{< param "PRODUCT_NAME" >}} configuration syntax, semantics of the configuration file, and the command-line interface.
* **User configuration**, including the {{< param "PRODUCT_NAME" >}} configuration syntax, the semantics of the configuration file, and the command-line interface.

* **APIs**, for any network or code API released as v1.0.0 or later.

* **Observability data used in official dashboards**, where the official set of dashboards are found in [the `alloy-mixin/` directory][alloy-mixin].

## Exceptions

We strive to maintain backwards compatibility, but there are situations which 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:

* **Security**: A security issue may arise that requires breaking compatibility.

Expand All @@ -33,7 +33,7 @@ We strive to maintain backwards compatibility, but there are situations which ma

* **Upstream changes**: Much of the functionality of {{< param "PRODUCT_NAME" >}} is built on top of other software, such as OpenTelemetry Collector and Prometheus. If upstream software breaks compatibility, we may need to reflect this in {{< param "PRODUCT_NAME" >}}.

We try whenever possible to resolve these issues without breaking compatibility.
We try, whenever possible, to resolve these issues without breaking compatibility.

[semantic versioning]: https://semver.org/
[alloy-mixin]: https://github.com/grafana/alloy/tree/main/operations/alloy-mixin

0 comments on commit f2bb42b

Please sign in to comment.