Breaking changes reference (#617)

* Draft breaking changes page, add stub pages Signed-off-by: Diana <[email protected]> * Fix entity capitalization, fix broken links Signed-off-by: Diana <[email protected]> * Apply code review feedback Signed-off-by: Diana <[email protected]> * Fix broken link Signed-off-by: Diana <[email protected]> --------- Signed-off-by: Diana <[email protected]>
Kong · Mar 6, 2025 · 5e4a6de · 5e4a6de
1 parent 7055e85
commit 5e4a6de
Show file tree

Hide file tree

Showing 8 changed files with 1,040 additions and 3 deletions.
diff --git a/app/_how-tos/build-custom-images.md b/app/_how-tos/build-custom-images.md
@@ -0,0 +1,26 @@
+---
+title: Create a Super Admin with the Admin API
+content_type: how_to
+description: placeholder
+
+products:
+    - gateway
+
+works_on:
+    - on-prem
+
+tldr: 
+  q: placeholder
+  a: placeholder
+
+tags:
+    - placeholder
+
+min_version:
+    gateway: '3.4'
+---
+
+
+@todo
+
+pull content from https://docs.konghq.com/gateway/latest/install/docker/build-custom-images/
diff --git a/app/_how-tos/enable-oidc-for-kong-manager.md b/app/_how-tos/enable-oidc-for-kong-manager.md
@@ -39,4 +39,6 @@ min_version:
 
 @todo
 
-Source: https://docs.konghq.com/gateway/latest/kong-manager/auth/oidc/configure/
+Source: https://docs.konghq.com/gateway/latest/kong-manager/auth/oidc/configure/
+
+FAQ of https://docs.konghq.com/gateway/latest/kong-manager/auth/oidc/migrate/ (I think we just need the tables under the h2 headers, the rest of the info in h3 just references what the table's already said and is content that should be in the kong.conf ref)
diff --git a/app/gateway/breaking-changes.md b/app/gateway/breaking-changes.md
diff --git a/app/gateway/changelog.md b/app/gateway/changelog.md
@@ -11,6 +11,8 @@ products:
 related_resources:
   - text: "{{site.base_gateway}}"
     url: /gateway/
+  - text: "{{site.base_gateway}} breaking changes"
+    url: /gateway/breaking-changes/
 
 ---
 

diff --git a/app/gateway/tracing.md b/app/gateway/tracing.md
@@ -0,0 +1,29 @@
+---
+title: "{{site.base_gateway}} tracing"
+content_type: reference
+layout: reference
+
+products:
+    - gateway
+
+works_on:
+    - on-prem
+    - konnect
+
+tags:
+    - tracing
+
+no_version: true
+
+description: "placeholder"
+
+related_resources:
+  - text: placeholder
+    url: /
+---
+
+@todo
+
+pull content from https://docs.konghq.com/gateway/latest/production/tracing/#main
+
+Also, include relevant content in the tracing plugins (as includes?)
diff --git a/app/gateway/upgrade/index.md b/app/gateway/upgrade/index.md
@@ -0,0 +1,27 @@
+---
+title: "Upgrading {{site.base_gateway}}"
+content_type: reference
+layout: reference
+
+products:
+    - gateway
+
+works_on:
+    - on-prem
+
+tags:
+    - upgrades
+    - versioning
+
+no_version: true
+
+description: "placeholder"
+
+related_resources:
+  - text: "{{site.base_gateway}} breaking changes"
+    url: /gateway/breaking-changes/
+---
+
+@todo
+
+pull content from https://docs.konghq.com/gateway/latest/upgrade/
diff --git a/app/gateway/version-support-policy.md b/app/gateway/version-support-policy.md
@@ -17,13 +17,15 @@ related_resources:
     url: /gateway/security/
   - text: Kong vulnerability patching process
     url: /gateway/vulnerabilities/
+  - text: "{{site.base_gateway}} breaking changes"
+    url: /gateway/breaking-changes/
 ---
 
 Kong adopts a structured approach to versioning its products.
 Products follow a pattern of `{MAJOR}.{MINOR}.{PATCH}.{ENTERPRISE_PATCH}`.
 
 This policy **only** applies to {{site.base_gateway}}.
-For {{site.konnect_short_name}}, review the [{{site.konnect_short_name}} version support policy](/konnect/compatibility/).
+For {{site.konnect_short_name}}, review the [{{site.konnect_short_name}} version support policy](/compatibility/).
 
 {:.info}
 > **Long Term Support Policy Update**
@@ -159,4 +161,4 @@ These versions have reached the end of full support.
 |   0.30   |  2018-01-22   |     2019-01-21      |      2020-01-21       |
 
 {:.info}
-> **Note:** This policy **only** applies to {{site.base_gateway}}. For {{site.konnect_short_name}}, review the [{{site.konnect_short_name}} version support policy](/konnect/compatibility/#kong-gateway-version-compatibility).
+> **Note:** This policy **only** applies to {{site.base_gateway}}. For {{site.konnect_short_name}}, review the [{{site.konnect_short_name}} version support policy](/compatibility/#kong-gateway-version-compatibility).
diff --git a/tools/track-docs-changes/config/sources.yml b/tools/track-docs-changes/config/sources.yml
@@ -403,6 +403,18 @@ app/ai-gateway/monitor-ai-llm-metrics.md:
   - app/_src/gateway/production/monitoring/ai-metrics.md
 app/gateway/reserved-entity-names.md:
   - app/_src/gateway/reference/reserved-entity-names.md
+app/gateway/breaking-changes.md:
+  - app/_src/gateway/breaking-changes/39x.md
+  - app/_src/gateway/breaking-changes/28x.md
+  - app/_src/gateway/breaking-changes/30x.md
+  - app/_src/gateway/breaking-changes/31x.md
+  - app/_src/gateway/breaking-changes/32x.md
+  - app/_src/gateway/breaking-changes/33x.md
+  - app/_src/gateway/breaking-changes/34x.md
+  - app/_src/gateway/breaking-changes/35x.md
+  - app/_src/gateway/breaking-changes/36x.md
+  - app/_src/gateway/breaking-changes/37x.md
+  - app/_src/gateway/breaking-changes/38x.md
 
 # traffic control
 app/gateway/traffic-control/proxy.md: