From 28397e7823f0603ccdc21d40eaa938ba5b1eb3ed Mon Sep 17 00:00:00 2001 From: Ben Starmer-Smith Date: Thu, 21 Nov 2024 11:09:52 +0000 Subject: [PATCH] Reworded some parts of the matrix based on feedback. --- charts/console/docs/COMPATIBILITY_MATRIX.md | 6 +++--- charts/gateway/docs/COMPATIBILITY_MATRIX.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/charts/console/docs/COMPATIBILITY_MATRIX.md b/charts/console/docs/COMPATIBILITY_MATRIX.md index bcfa92b..4bd407a 100644 --- a/charts/console/docs/COMPATIBILITY_MATRIX.md +++ b/charts/console/docs/COMPATIBILITY_MATRIX.md @@ -1,9 +1,9 @@ # Conduktor Console Compatibility Matrix This compatibility matrix is a resource to help you find which versions of Conduktor Console work on which version of our Conduktor Console Helm Chart. -> General recommendation is to use the version of Console that comes preconfigured with the helm chart. If needed you can adjust the version in your values property according to the supported console version. +> In general we recommend you use the version of Console that comes preconfigured with the Helm chart. If needed you can adjust the version in your values property according to the supported Console version. -> Breaking changes column will only list breaking change in the helmchart! We strongly recommend reading the full [changelog](https://docs.conduktor.io/changelog/) of Conduktor in case there are breaking within the components. +> Breaking changes column will only list breaking change in the helmchart! You must review the Conduktor [changelog](https://docs.conduktor.io/changelog/) to determine whether there are breaking changes within the artefacts. ## Helm Chart Compatibility @@ -11,7 +11,7 @@ Breaking Changes: 🟡 - Breaks additional services (e.g. Grafana dashboard changes) -🔴 - Breaks overall deployment of product (e.g. renaming variables in .values, major product releases) +🔴 - Breaks overall deployment of the product (e.g. renaming variables in .values, major product releases) | Chart version | Supported Console version | Breaking changes | |---------------|---------------------------|------------------| diff --git a/charts/gateway/docs/COMPATIBILITY_MATRIX.md b/charts/gateway/docs/COMPATIBILITY_MATRIX.md index 17f0e54..6ebd81a 100644 --- a/charts/gateway/docs/COMPATIBILITY_MATRIX.md +++ b/charts/gateway/docs/COMPATIBILITY_MATRIX.md @@ -1,9 +1,9 @@ # Conduktor Gateway Compatibility Matrix This compatibility matrix is a resource to help you find which versions of Conduktor Gateway work on which version of our Conduktor Gateway Helm Chart. -> General recommendation is to use the version of Gateway that comes preconfigured with the helm chart. If needed you can adjust the version in your values property according to the supported console version. +> In general we recommend you use the version of Gateway that comes preconfigured with the Helm chart. If needed you can adjust the version in your values property according to the supported Gateway version. -> Breaking changes column will only list breaking change in the helmchart! We strongly recommend reading the full [changelog](https://docs.conduktor.io/changelog/) of Conduktor in case there are breaking within the components. +> Breaking changes column will only list breaking change in the helmchart! You must review the Conduktor [changelog](https://docs.conduktor.io/changelog/) to determine whether there are breaking changes within the artefacts. ## Helm Chart Compatibility @@ -11,7 +11,7 @@ Breaking Changes: 🟡 - Breaks additional services (e.g. Grafana dashboard changes) -🔴 - Breaks overall deployment of product (e.g. renaming variables in .values, major product releases) +🔴 - Breaks overall deployment of the product (e.g. renaming variables in .values, major product releases) | Chart version | Supported Gateway version | Breaking changes | |---------------|---------------------------|------------------|