Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCU-2454][DOCU-1800] Konnect platform cleanup and cleanout #4258

Merged
merged 12 commits into from
Aug 17, 2022
Merged
3 changes: 0 additions & 3 deletions algolia/config-full-docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@
"url": "https://docs.konghq.com/mesh/changelog/",
"selectors_key": "changelog"
},
{
"url": "https://docs.konghq.com/konnect-platform/"
},
{
"url": "https://docs.konghq.com/hub/",
"selectors_key": "hub"
Expand Down
30 changes: 15 additions & 15 deletions app/_assets/javascripts/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -145,21 +145,21 @@ jQuery(function () {
});
});

// COMPAT DROPDOWN: dropdown menu functionality (handles /konnect-platform/compatibility dropdown)
$("#compat-dropdown").on("click", function(e) {
e.preventDefault();
e.stopPropagation();

$("#compat-list").toggleClass("open");

$(document).one('click', function closeMenu (e){
if($('#compat-list').has(e.target).length === 0){
$('#compat-list').removeClass('open');
} else {
$(document).one('click', closeMenu);
}
});
});
// COMPAT DROPDOWN: dropdown menu functionality (handles /archive/konnect-platform/compatibility dropdown. Currently not in use.)
// $("#compat-dropdown").on("click", function(e) {
// e.preventDefault();
// e.stopPropagation();
//
// $("#compat-list").toggleClass("open");
//
// $(document).one('click', function closeMenu (e){
// if($('#compat-list').has(e.target).length === 0){
// $('#compat-list').removeClass('open');
// } else {
// $(document).one('click', closeMenu);
// }
// });
// });

// Cookie functions

Expand Down
2 changes: 1 addition & 1 deletion app/_assets/stylesheets/compat-form.less
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Styling for the compatibility form and table located under
// /app/konnect-platform/compatibility
// /archive/konnect-platform/compatibility. Not currently in use.

.compat-form {
border: 1px solid @grey-200;
Expand Down
2 changes: 2 additions & 0 deletions app/_data/docs_nav_deck_1.12.x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ items:
url: /design-architecture
- text: Compatibility Promise
url: /compatibility-promise
- text: Stages of Software Availability
url: /availability-stages

- title: Changelog
icon: /assets/images/icons/documentation/icn-references-color.svg
Expand Down
2 changes: 1 addition & 1 deletion app/_data/docs_nav_gateway_2.6.x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
absolute_url: true
items:
- text: Version Support Policy
url: /konnect-platform/support-policy
url: /gateway/latest/support-policy
absolute_url: true
- text: Changelog
url: /gateway/changelog
Expand Down
2 changes: 1 addition & 1 deletion app/_data/docs_nav_gateway_2.7.x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
absolute_url: true
items:
- text: Version Support Policy
url: /konnect-platform/support-policy
url: /gateway/latest/support-policy
absolute_url: true
- text: Changelog
url: /gateway/changelog
Expand Down
4 changes: 3 additions & 1 deletion app/_data/docs_nav_gateway_2.8.x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
url: /gateway/
absolute_url: true
- text: Version Support Policy
url: /konnect-platform/support-policy
url: /gateway/latest/support-policy
absolute_url: true
- text: Stages of Software Availability
url: /availability-stages
- text: Changelog
url: /gateway/changelog
absolute_url: true
Expand Down
4 changes: 4 additions & 0 deletions app/_data/docs_nav_kic_2.5.x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ items:
items:
- text: FAQ
url: /faq
- text: Version Support Policy
url: /support-policy
- text: Stages of Software Availability
url: /availability-stages
- text: Changelog
url: https://github.com/Kong/kubernetes-ingress-controller/blob/main/CHANGELOG.md
absolute_url: true
Expand Down
2 changes: 2 additions & 0 deletions app/_data/docs_nav_konnect.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
url: /network
- text: Compatibility
url: /compatibility
- text: Stages of Software Availability
url: /availability-stages
- text: Release Notes
url: /updates

Expand Down
22 changes: 0 additions & 22 deletions app/_data/docs_nav_konnect_platform.yml

This file was deleted.

2 changes: 1 addition & 1 deletion app/_data/docs_nav_mesh_1.5.x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

- title: Version Support Policy
icon: /assets/images/icons/documentation/icn-support.svg
url: /konnect-platform/support-policy
url: /mesh/latest/support-policy
absolute_url: true

- title: Getting Started
Expand Down
2 changes: 1 addition & 1 deletion app/_data/docs_nav_mesh_1.6.x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

- title: Version Support Policy
icon: /assets/images/icons/documentation/icn-support.svg
url: /konnect-platform/support-policy
url: /mesh/latest/support-policy
absolute_url: true

- title: Getting Started
Expand Down
15 changes: 9 additions & 6 deletions app/_data/docs_nav_mesh_1.8.x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,15 @@ items:
icon: /assets/images/icons/documentation/icn-flag.svg
url: /mesh/1.8.x/
absolute_url: true

- title: Release notes
icon: /assets/images/icons/documentation/icn-references-color.svg
url: /mesh/changelog
generate: false
absolute_url: true
items:
- text: Version Support Policy
url: /support-policy
- text: Stages of Software Availability
url: /availability-stages
- text: Release notes
url: /mesh/changelog
generate: false
absolute_url: true

- title: Getting Started
icon: /assets/images/icons/documentation/icn-quickstart-color.svg
Expand Down
2 changes: 0 additions & 2 deletions app/_data/kong_versions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -254,8 +254,6 @@
edition: "mesh"
-
edition: "konnect"
-
edition: "konnect-platform"
-
edition: "contributing"
-
Expand Down
2 changes: 1 addition & 1 deletion app/_hub/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h3>Introduction</h3>
</a>
</li>
<li class="nav-item" role="menuitem">
<a class="nav-link" href="/konnect-platform/compatibility/plugins">
<a class="nav-link" href="/hub/plugins/compatibility/">
Compatibility
</a>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,13 @@ title: Plugin Compatibility
no_version: true
---

## Introduction

Each [subscription tier](https://konghq.com/pricing) gives you
access to a subset of plugins:
* **Free tier:** Open-source Kong plugins
* **Plus tier:** Open-source and Plus-specific plugins
* **Enterprise tier:** All Kong plugins

### Network configuration options
## Network configuration options

{{site.konnect_short_name}} can be configured in the following ways:

Expand Down Expand Up @@ -65,23 +63,23 @@ see [{{site.ee_product_name}} for Kubernetes Deployment Options](/gateway/latest
</td>
<td style="text-align: center">
{% if plugin.free == true %}
✅&nbsp;
<i class="fa fa-check"></i>
{% elsif plugin.free == false %}
❌&nbsp;
<i class="fa fa-times"></i>
{% endif %}
</td>
<td style="text-align: center">
{% if plugin.plus == true %}
✅&nbsp;
<i class="fa fa-check"></i>
{% elsif plugin.plus == false %}
❌&nbsp;
<i class="fa fa-times"></i>
{% endif %}
</td>
<td style="text-align: center">
{% if plugin.enterprise == true %}
✅&nbsp;
<i class="fa fa-check"></i>
{% elsif plugin.enterprise == false %}
❌&nbsp;
<i class="fa fa-times"></i>
{% endif %}
</td>
<td>
Expand Down
1 change: 0 additions & 1 deletion app/_includes/breadcrumbs.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
</li>
<li class="breadcrumb-item">
{% if include.edition == 'enterprise' %}<a href="/enterprise/{% unless include.no_version == true %}{{include.kong_version}}/{% endunless %}">{{site.ee_product_name}}</a>
{% elsif include.edition == 'konnect-platform' %}<a href="/konnect-platform/">Overview</a>
{% elsif include.edition == 'konnect' %}<a href="/konnect/">{{site.konnect_saas}}</a>
{% elsif include.edition == 'mesh' %}<a href="/mesh/{% unless include.no_version == true %}{{include.kong_version}}/{% endunless %}">{{site.mesh_product_name}}</a>
{% elsif include.edition == 'deck' %}<a href="/deck/">decK</a>
Expand Down
5 changes: 0 additions & 5 deletions app/_includes/docs-sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
<span>
{% if include.edition == 'enterprise' %}{{site.ee_product_name}}
{% elsif include.edition == 'konnect' %}{{site.konnect_saas}}
{% elsif include.edition == 'konnect-platform' %}{{site.konnect_product_name}} Platform
{% elsif include.edition == 'mesh' %}{{site.mesh_product_name}}
{% elsif include.edition == 'deck' %}decK
{% elsif include.edition == 'kubernetes-ingress-controller' %}{{site.kic_product_name}}
Expand Down Expand Up @@ -54,10 +53,6 @@
<a href="https://kuma.io/docs/" target="_blank">Kuma</a>
</li>
<hr>
<li role="menuitem" tabindex="-1" {% if include.edition == 'konnect_platform' %} class="active"{% endif %}>
<a href="/konnect-platform/" {% if include.edition == 'konnect_platform' %}class="active"{% endif %}>Kong Konnect Platform</a>
</li>
<hr>
<li role="menuitem" tabindex="-1" {% if include.edition == 'contributing' %} class="active"{% endif %}>
<a href="/contributing/" {% if include.edition == 'contributing' %}class="active"{% endif %}>Docs contribution guidelines</a>
</li>
Expand Down
31 changes: 31 additions & 0 deletions app/_includes/md/availability-stages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

## Tech preview
A feature that is in tech preview might have limited to no documentation, is not guaranteed to be made available as GA in the future. Some products or projects may also call this stage *alpha*.

**A tech preview feature or version should not be deployed in a production environment**.
Interfaces for features in tech preview could change in backwards-incompatible ways.

Tech previews features are experimental.
Do not count on the feature becoming a formal product, and expect it to change heavily if it does.

## Beta
A beta designation in Kong software means the functionality of a feature or release version is of high quality and can be deployed in a non-production environment.

**A beta feature or version should not be deployed in a production environment**.

Note the following when using a beta feature or version:
* Beta customers are encouraged to engage Kong Support to report issues encountered in beta testing. Support requests should be filed with normal priority, but contractual SLA’s will not be applicable for beta features.
* Support is not available for data recovery, rollback, or other tasks when using a beta feature or version.
* User documentation might not be available, complete, or reflect entire functionality.

A beta feature or version is made available to the general public for usability testing and to gain feedback about the feature or version before releasing it as a production-ready, stable feature or version.

## General availability
General availability, or GA, means that the software is released publicly and
is supported according to Kong's [support and maintenance policy](https://konghq.com/wp-content/uploads/2021/04/Kong-Support-and-Maintenance-Policy-16-April-2021.pdf). Generally available features usually have official documentation (as needed) and interfaces are stable.

If feature documentation doesn't have a tech preview, alpha, or beta label, then the feature is generally available.

You can deploy GA features to production environments.

Interfaces are guaranteed to follow a [semantic versioning](https://semver.org/) model for any changes.
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
---
title: Version Support Policy
no_version: true
badge: enterprise
content-type: reference
---

The support for {{site.ee_product_name}} and {{site.mesh_product_name}} software versions is explained in this topic.

## Types of releases
Kong primarily follows [semantic versioning](https://semver.org/) (SemVer) with its products. That is, products typically follow a pattern of `{MAJOR_VERSION}.{MINOR_VERSION}.{PATCH_VERSION}`. {{site.ee_product_name}} additionally has one more decimal point on the right which identifies a sub-patch based on the Kong Community Gateway. For the purposes of this support document:
Expand Down Expand Up @@ -44,60 +36,3 @@ Unfortunately, all software is susceptible to bugs. Kong seeks to remedy bugs th
* Other bugs as well as feature requests will be assessed for severity and fixes or enhancements applied to versions of {{site.ee_product_name}} at Kong’s discretion depending on the impact of the bug. Typically, these types of fixes and enhancements will only be applied to the most recent Minor Version in the most recent Major Version.

Customers with platinum or higher subscriptions may request fixes outside of the above and Kong will assess them at its sole discretion.

## Version support for {{site.base_gateway}} (Enterprise)

| Version | Released Date | End of Full Support | End of Sunset Support |
|:--------:|:-------------:|:-------------------:|:---------------------:|
| 2.8.x.x | 2022-03-02 | 2023-08-24 | 2024-08-24 |
| 2.7.x.x | 2021-12-16 | 2022-08-24 | 2023-08-24 |
| 2.6.x.x | 2021-10-14 | 2022-08-24 | 2023-08-24 |
| 2.5.x.x | 2021-08-03 | 2022-08-24 | 2023-08-24 |
| 2.4.x.x | 2021-05-18 | 2022-08-24 | 2023-08-24 |
| 2.3.x.x | 2021-02-11 | 2022-08-24 | 2023-08-24 |
| 2.2.x.x | 2020-11-17 | 2022-08-24 | 2023-08-24 |
| 2.1.x.x | 2020-08-25 | 2022-08-24 | 2023-08-24 |
| 1.5.x.x | 2020-04-10 | 2021-04-09 | 2022-04-09 |
| 1.3.x.x | 2019-11-05 | 2020-11-04 | 2021-11-04 |
| 0.36 | 2019-08-05 | 2020-08-04 | 2021-08-04 |
| 0.35 | 2019-05-16 | 2020-05-15 | 2020-11-15 |
| 0.34 | 2018-11-19 | 2019-11-18 | 2020-11-18 |
| 0.33 | 2018-07-11 | 2019-06-10 | 2020-06-10 |
| 0.32 | 2018-05-22 | 2019-05-21 | 2020-05-21 |
| 0.31 | 2018-03-13 | 2019-03-12 | 2020-03-12 |
| 0.30 | 2018-01-22 | 2019-01-21 | 2020-01-21 |

> *Table 1: Version Support for {{site.ee_product_name}}*

## Version support for Kong Mesh

| Version | Released Date | End of Full Support |
|:--------:|:-------------:|:-------------------:|
| 1.8.x | 2022-06-15 | 2023-06-14 |
| 1.7.x | 2022-04-11 | 2023-04-10 |
| 1.6.x | 2022-02-24 | 2023-02-23 |
| 1.5.x | 2021-11-23 | 2022-11-22 |

> *Table 2: Version Support for Kong Mesh*

## Version support for Kong Ingress Controller (Enterprise)

| Version | Released Date | End of Full Support | End of Sunset Support |
|:--------:|:-------------:|:-------------------:|:---------------------:|
| 2.5.x | 2022-07-11 | 2023-07-11 | 2024-07-11 |
| 2.4.x | 2022-06-15 | 2023-06-15 | 2024-06-15 |
| 2.3.x | 2022-04-05 | 2023-04-05 | 2024-04-05 |
| 2.2.x | 2022-02-04 | 2023-02-04 | 2024-02-04 |
| 2.1.x | 2022-01-05 | 2023-01-05 | 2024-01-05 |
| 2.0.x | 2021-10-07 | 2022-10-07 | 2023-10-07 |
| 1.3.x | 2021-05-27 | 2022-05-27 | 2024-05-27 |
| 1.2.x | 2021-03-24 | 2022-03-24 | 2024-03-24 |
| 1.1.x | 2020-12-09 | 2021-12-09 | 2023-12-09 |
| 1.0.x | 2020-10-05 | 2021-10-05 | 2023-10-05 |
| 0.x.x | 2018-06-02 | 2019-06-02 | 2020-06-02 |

> *Table 3: Version Support for Kong Ingress Controller*

## Additional terms
- The above is a summary only and is qualified by Kong’s [Support and Maintenance Policy](https://konghq.com/supportandmaintenancepolicy).
- The above applies to Kong standard software builds only.
4 changes: 0 additions & 4 deletions app/_includes/nav-v2.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,6 @@
<a href="https://kuma.io/docs/" target="_blank" class="navbar-item navbar-item-docs">Kuma</a>
</li>
<hr>
<li role="menuitem" class="docs-dropdown-li" tabindex="-1">
<a href="/konnect-platform/" class="navbar-item navbar-item-docs">Kong Konnect Platform</a>
</li>
<hr>
<li role="menuitem" class="docs-dropdown-li" tabindex="-1">
<a href="/contributing/" class="navbar-item navbar-item-docs">Docs contribution guidelines</a>
</li>
Expand Down
4 changes: 2 additions & 2 deletions app/_layouts/docs-v2.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,12 @@ <h2 class="page-content-subtitle">{{page.subtitle | flatify }}</h2>

{% if page.alpha %}
<blockquote class="warning no-icon">
This feature is released as a <a href="/konnect-platform/key-concepts/#tech-preview">tech preview</a> (alpha-quality) and should not be deployed in a production environment.
This feature is released as a <a href="/gateway/latest/availability-stages/#tech-preview">tech preview</a> (alpha-quality) and should not be deployed in a production environment.
</blockquote>
{% endif %}
{% if page.beta %}
<blockquote class="warning no-icon">
This feature is released as <a href="/konnect-platform/key-concepts/#beta">beta</a> and should not be deployed in a production environment.
This feature is released as <a href="/gateway/latest/availability-stages/#beta">beta</a> and should not be deployed in a production environment.
</blockquote>
{% endif %}

Expand Down
Loading