From d8e2272e3b61104f433adb604d6931f6dde39e3f Mon Sep 17 00:00:00 2001
From: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Date: Mon, 20 Nov 2023 14:53:59 -0600
Subject: [PATCH] Move compatiblity doc to intro section, some formatting and
copyedits
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
---
app/_data/docs_nav_kgo_1.0.x.yml | 4 ++--
.../{reference => }/version-compatibility.md | 15 ++++++---------
2 files changed, 8 insertions(+), 11 deletions(-)
rename app/_src/gateway-operator/{reference => }/version-compatibility.md (69%)
diff --git a/app/_data/docs_nav_kgo_1.0.x.yml b/app/_data/docs_nav_kgo_1.0.x.yml
index aa0102e1e7f7..d12819f9b7d9 100644
--- a/app/_data/docs_nav_kgo_1.0.x.yml
+++ b/app/_data/docs_nav_kgo_1.0.x.yml
@@ -26,6 +26,8 @@ items:
absolute_url: true
- text: Support
url: /support
+ - text: Version Compatibility
+ url: /version-compatibility
- text: FAQ
url: /faq
- title: Get Started
@@ -92,5 +94,3 @@ items:
generate: false
- text: License
url: /reference/license
- - text: Version Compatibility
- url: /reference/version-compatibility
diff --git a/app/_src/gateway-operator/reference/version-compatibility.md b/app/_src/gateway-operator/version-compatibility.md
similarity index 69%
rename from app/_src/gateway-operator/reference/version-compatibility.md
rename to app/_src/gateway-operator/version-compatibility.md
index c66f2f548b9b..4fffa3516890 100644
--- a/app/_src/gateway-operator/reference/version-compatibility.md
+++ b/app/_src/gateway-operator/version-compatibility.md
@@ -4,9 +4,7 @@ title: Version Compatibility
## {{ site.kic_product_name }}
-The following table presents the general compatibility of {{site.kgo_product_name}} with {{ site.kic_product_name }} minor versions.
-
-## Kubernetes
+The following table describes the general compatibility of {{site.kgo_product_name}} with {{ site.kic_product_name }} minor versions.
| {{site.kgo_product_name}} | 1.0.x |
|:---------------------------------|:---------------------------:|
@@ -14,10 +12,9 @@ The following table presents the general compatibility of {{site.kgo_product_nam
| {{ site.kic_product_name }} 2.12 | |
| {{ site.kic_product_name }} 3.0 | |
-### General
+## Kubernetes
-The following table presents the general compatibility of {{site.kgo_product_name}} with specific Kubernetes versions.
-Users should expect all the combinations marked with to work and to be supported.
+The following table describes the general compatibility of {{site.kgo_product_name}} with specific Kubernetes versions.
| {{site.kgo_product_name}} | 1.0.x |
|:--------------------------|:---------------------------:|
@@ -26,10 +23,10 @@ Users should expect all the combinations marked with
| Kubernetes 1.27 | |
| Kubernetes 1.28 | |
-### Gateway API
+## Gateway API
-The following table presents the compatibility of {{site.kgo_product_name}} with specific [Gateway API][gateway-api] versions.
-As {{site.kgo_product_name}} implements Gateway API features using the upstream
+The following table describes the compatibility of {{site.kgo_product_name}} with specific [Gateway API][gateway-api] versions.
+Because {{site.kgo_product_name}} implements Gateway API features using the upstream
project, which defines [its own compatibility declarations][gateway-api-supported-versions], the expected compatibility
of Gateway API features might be limited to those.