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

chore(kgo): add version support matrix #7325

Merged
merged 6 commits into from
Jun 4, 2024
Merged

Conversation

pmalek
Copy link
Member

@pmalek pmalek commented Apr 30, 2024

Description

Add version support matrix for KGO based on

- edition: gateway-operator
version: 1.0.3
release: 1.0.x
releaseDate: "2023-09-26"
endOfLifeDate: "2023-09-26"
- edition: gateway-operator
version: 1.1.0
release: 1.1.x
releaseDate: "2023-11-20"
endOfLifeDate: "2023-11-20"
- edition: gateway-operator
version: 1.2.3
release: 1.2.x
latest: true
releaseDate: "2024-03-15"
endOfLifeDate: "2025-03-15"
branch: release/1.2.x
- edition: gateway-operator
version: 1.3.0
release: 1.3.x
label: unreleased

I've removed the k8s support table since that seems to be already in place at https://deploy-preview-7325--kongdocs.netlify.app/gateway-operator/latest/reference/version-compatibility/.

  1. @mheap Do we want to keep it this way or make it into an HTML table as it's done for KIC: https://github.com/Kong/docs.konghq.com/blob/3c8556479988985d4f836741ac6192c94a0555b9/app/_includes/md/kic/support.md ?

  2. Do we want to make the unreleased version hidden from

    versions.each do |entry|
    out += "| #{entry['release']} | #{entry['version']} | #{entry['releaseDate']} | #{entry['endOfLifeDate']} |\n"
    end
    ?

Testing instructions

Preview link: https://deploy-preview-7325--kongdocs.netlify.app/gateway-operator/latest/support/

Added section at https://deploy-preview-7325--kongdocs.netlify.app/gateway-operator/latest/support/#version-compatibility-with-kubernetes

Checklist

@pmalek pmalek added Kubernetes Team Kubernetes task tracking (including KIC) review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? labels Apr 30, 2024
@pmalek pmalek self-assigned this Apr 30, 2024
Copy link

netlify bot commented Apr 30, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit b869162
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/6659fdc8b28a480009c46744
😎 Deploy Preview https://deploy-preview-7325--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 93 (🟢 up 1 from production)
Accessibility: 93 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@pmalek pmalek requested a review from mheap April 30, 2024 14:40
@lahabana
Copy link
Contributor

lahabana commented May 6, 2024

Do we want to make the unreleased version hidden from

Yes I think we should.

@pmalek pmalek force-pushed the kgo-version-support-matrix branch from 1766f75 to f372b9b Compare May 6, 2024 10:32
@pmalek
Copy link
Member Author

pmalek commented May 6, 2024

Do we want to make the unreleased version hidden from

Yes I think we should.

@Kong/docs-maintainers That's a question to you if we can change it or do we have to roll our own version of

versions.each do |entry|
out += "| #{entry['release']} | #{entry['version']} | #{entry['releaseDate']} | #{entry['endOfLifeDate']} |\n"
end

@pmalek pmalek marked this pull request as ready for review May 6, 2024 10:33
@pmalek pmalek requested a review from a team as a code owner May 6, 2024 10:33
Copy link
Member

@mheap mheap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pmalek I think adding a condition to skip if entry['label'] == 'unreleased' makes sense. Please make that change.

app/_src/gateway-operator/support.md Show resolved Hide resolved
@pmalek pmalek force-pushed the kgo-version-support-matrix branch 2 times, most recently from 11ea320 to 9b98de2 Compare May 7, 2024 14:20
@pmalek pmalek force-pushed the kgo-version-support-matrix branch from 9b98de2 to 7434ce2 Compare May 7, 2024 14:37
@pmalek pmalek requested a review from mheap May 7, 2024 14:57
@@ -18,6 +18,8 @@ def render(context)
| Version | Latest Patch | Released Date | End of Full Support |
|:--------:|:-------------:|:-------------:|:-------------------:|\n"
versions.each do |entry|
next if entry['label'] == 'unreleased'
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mesh uses dev label for the unreleased version:

Do we want to include that in the skip condition or do we want to leave that as is to not change it for them?

Currently this https://deploy-preview-7325--kongdocs.netlify.app/mesh/latest/support-policy/#version-support-for-kong-mesh still renders the unreleased mesh version.

cc: @lahabana as you've contributed app/_plugins/tags/support_policy_tag.rb and might want to have that changed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be answered later on and tackled in a separate PR.

Leaving the thread in here for discussion but it shouldn't preclude merging this PR.

@pmalek pmalek requested a review from a team May 31, 2024 10:49
@pmalek
Copy link
Member Author

pmalek commented May 31, 2024

@mheap @Kong/docs-maintainers Can we get this reviewed and merged?

Copy link
Contributor

@cloudjumpercat cloudjumpercat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pmalek Just left a few wording suggestions, everything else looks good! Once you commit those suggestions, ping me and I'll approve this

@@ -26,8 +26,6 @@ items:
absolute_url: true
- text: Support
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- text: Support
- text: Version Support Policy

This might work, to keep in line with what we have for Kong Gateway. And "Support" could mean something like about the Kong Support team.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done that in 504d943 to also change it in other versions' TOCs.

app/_src/gateway-operator/support.md Outdated Show resolved Hide resolved
pmalek and others added 2 commits May 31, 2024 18:40
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
@mheap mheap merged commit 6b78a10 into main Jun 4, 2024
15 checks passed
@mheap mheap deleted the kgo-version-support-matrix branch June 4, 2024 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Kubernetes Team Kubernetes task tracking (including KIC) review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly?
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants