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

Fix: remove upgrade paths table #8188

Merged
merged 2 commits into from
Dec 3, 2024
Merged

Fix: remove upgrade paths table #8188

merged 2 commits into from
Dec 3, 2024

Conversation

lena-larionova
Copy link
Contributor

@lena-larionova lena-larionova commented Nov 27, 2024

Description

The upgrade paths table in our documentation is massive and often incorrect. There are no new tests or findings for these paths in each release, so all the table says is to upgrade step by step to each minor version (3.4.x to 3.5.x to 3.6.x, etc). Additionally, this table is split by topology, but there is absolutely no difference in paths for each topology.

This table was added around 3.1 to cover the cover the websocket protocol changes between patches. However, this special case is already covered in https://docs.konghq.com/gateway/latest/upgrade/#upgrades-from-3100-or-3111.

I believe that simply adding examples to the list of supported guaranteed paths will serve the same purpose that the table once did, but in a much clearer way.

https://konghq.atlassian.net/browse/DOCU-3998
https://konghq.atlassian.net/browse/DOCU-4157

Testing instructions

Preview link: https://deploy-preview-8188--kongdocs.netlify.app/gateway/latest/upgrade/#preparation-choose-an-upgrade-path

Checklist

@lena-larionova lena-larionova added the review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? label Nov 27, 2024
@lena-larionova lena-larionova requested a review from a team as a code owner November 27, 2024 20:28
Copy link

netlify bot commented Nov 27, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit ba5505d
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/674780fb4860940008f24a7d
😎 Deploy Preview https://deploy-preview-8188--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: 94 (🟢 up 4 from production)
Accessibility: 92 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 99 (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.

@lena-larionova lena-larionova merged commit 435e300 into main Dec 3, 2024
27 of 28 checks passed
@lena-larionova lena-larionova deleted the fix/docu-3998 branch December 3, 2024 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:manual-approve:link-validation 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.

2 participants