Reworded some parts of the matrix based on feedback.

conduktor · Nov 21, 2024 · 28397e7 · 28397e7
1 parent 39489bb
commit 28397e7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/charts/console/docs/COMPATIBILITY_MATRIX.md b/charts/console/docs/COMPATIBILITY_MATRIX.md
@@ -1,17 +1,17 @@
 # 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
 
 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
@@ -1,17 +1,17 @@
 # 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
 
 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 |
 |---------------|---------------------------|------------------|