-
Notifications
You must be signed in to change notification settings - Fork 576
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
Conversation
✅ Deploy Preview for kongdocs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Yes I think we should. |
1766f75
to
f372b9b
Compare
@Kong/docs-maintainers That's a question to you if we can change it or do we have to roll our own version of docs.konghq.com/app/_plugins/tags/support_policy_tag.rb Lines 20 to 22 in 85bc01b
|
There was a problem hiding this 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.
11ea320
to
9b98de2
Compare
9b98de2
to
7434ce2
Compare
@@ -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' |
There was a problem hiding this comment.
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:
docs.konghq.com/app/_data/kong_versions.yml
Line 413 in c2ffad6
label: dev |
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.
There was a problem hiding this comment.
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.
@mheap @Kong/docs-maintainers Can we get this reviewed and merged? |
There was a problem hiding this 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
app/_data/docs_nav_kgo_1.0.x.yml
Outdated
@@ -26,8 +26,6 @@ items: | |||
absolute_url: true | |||
- text: Support |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- 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.
There was a problem hiding this comment.
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.
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Description
Add version support matrix for KGO based on
docs.konghq.com/app/_data/kong_versions.yml
Lines 289 to 309 in 1766f75
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/.
@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 ?
Do we want to make the unreleased version hidden from
docs.konghq.com/app/_plugins/tags/support_policy_tag.rb
Lines 20 to 22 in 85bc01b
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