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

Refactor Kubernetes compatibility tables for single source #4028

Open
2 tasks done
rainest opened this issue Jun 16, 2022 · 1 comment
Open
2 tasks done

Refactor Kubernetes compatibility tables for single source #4028

rainest opened this issue Jun 16, 2022 · 1 comment

Comments

@rainest
Copy link
Contributor

rainest commented Jun 16, 2022

Where is the problem?

https://docs.konghq.com/kubernetes-ingress-controller/latest/references/version-compatibility/

What happened?

To simplify edit workflows and avoid consuming screen real estate with long-outdated versions, the current versioned Kubernetes compatibility tables only include the 5 most recent KIC versions in columns and one Kong/Kubernetes/Istio version past the end of those KIC versions' compatibility through the latest version.

For example, if the latest KIC version is 2.6, the table columns will show KIC versions 2.2 through 2.6. If the oldest Kong version compatible with KIC 2.2 is Kong 2.0 and the latest Kong version is 2.8, the table rows will show Kong 1.5 (compatible with none of the listed KIC versions) through 2.8.

Limiting the rows is a new change I'd intended to make for the KIC 2.4 release: previously we showed a number of versions past what any listed KIC version was compatible with, which seemed unnecessary. Showing only one version incompatible with any displayed version should be sufficient to demonstrate that neither it nor older versions are compatible with the listed KIC versions.

This approach is easy to manage in plaintext, but does not translate well to the single-source model using {% if_version gte: A.B.x %} directives inline with the table.

What did you expect to happen?

Converting tables into a set of YAML version objects similar to https://github.com/Kong/docs.konghq.com/blob/main/app/_data/tables/plugin_index.yml and generating tables from those objects will allow editors to add new versions easily.

Code of Conduct and Community Expectations

  • I agree to follow this project's Code of Conduct
  • I agree to abide by the Community Expectations
@rainest
Copy link
Contributor Author

rainest commented Aug 9, 2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant