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

feat(upgrade): embed upgrade.md in docs #1706

Merged
merged 5 commits into from
Apr 8, 2024
Merged

Conversation

lahabana
Copy link
Contributor

@lahabana lahabana commented Apr 4, 2024

Fix #1535

<Explain your change!>

Did you sign your commit? Instructions

Have you read Contributing guidelines?

@lahabana lahabana requested a review from a team as a code owner April 4, 2024 11:51
@lahabana lahabana requested review from slonka and lobkovilya and removed request for a team April 4, 2024 11:51
Copy link

netlify bot commented Apr 4, 2024

Deploy Preview for kuma ready!

Name Link
🔨 Latest commit bb005d2
🔍 Latest deploy log https://app.netlify.com/sites/kuma/deploys/6613f88bfd764700089e7cfd
😎 Deploy Preview https://deploy-preview-1706--kuma.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 93 (🔴 down 3 from production)
Accessibility: 90 (no change from production)
Best Practices: 100 (no change from production)
SEO: 85 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

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

Signed-off-by: Charly Molter <[email protected]>
Copy link
Contributor

@slonka slonka left a comment

Choose a reason for hiding this comment

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

LGTM, but do we now need to use template variables in https://github.com/kumahq/kuma/blob/master/UPGRADE.md so that it renders correctly on both websites?

@slonka
Copy link
Contributor

slonka commented Apr 5, 2024

Rendered: https://deploy-preview-1706--kuma.netlify.app/docs/2.6.x/production/upgrades-tuning/upgrade-notes/

also some links are broken, should we disable link checker on this page?

@lahabana
Copy link
Contributor Author

lahabana commented Apr 5, 2024

also some links are broken, should we disable link checker on this page?

I think we'd be better off fixing the links.

For the variable the UPGRADE pages are different between Kuma and KM and the one from KM will link to the Kuma docs (see: https://github.com/Kong/kong-mesh/blob/master/UPGRADE.md). It was an easy low effort change.
In the future we may want to make these pages better but at least now we have this info on the docs website (perfect is the enemy of good :) )

@lahabana
Copy link
Contributor Author

lahabana commented Apr 5, 2024

This should fix the links: kumahq/kuma#9835

@slonka
Copy link
Contributor

slonka commented Apr 8, 2024

CoreDNS website timed out on the last link check and there is a problem with GH anchor that was fixed in main. Let's see if merge fixes it.

@slonka
Copy link
Contributor

slonka commented Apr 8, 2024

For the links issue: https://github.com/kumahq/kuma-website/pull/1712/files

@lahabana lahabana merged commit 782b27e into kumahq:master Apr 8, 2024
16 checks passed
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

Successfully merging this pull request may close these issues.

add UPGRADE.md in docs
3 participants