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

Breaking changes reference #617

Merged
merged 4 commits into from
Mar 6, 2025
Merged

Breaking changes reference #617

merged 4 commits into from
Mar 6, 2025

Conversation

cloudjumpercat
Copy link
Contributor

@cloudjumpercat cloudjumpercat commented Mar 5, 2025

Description

Fixes #549

Preview Links

https://deploy-preview-617--kongdeveloper.netlify.app/gateway/breaking-changes/

Questions for reviewers

  • We have a sentence: "We recommend transitioning to OpenTelemetry Instrumentation instead." It originally linked to https://docs.konghq.com/gateway/latest/production/tracing/#main. Should I make a Tracing Reference stub page and link to that instead? It feels like the content on that page should be on the plugins?
  • Is there a way (and should we) remove all the headers except the ## [version number] breaking changes headers so it's easier to navigate to the version you need?

Stub pages created:

Post GA issue to fix headers:
#631

Checklist

  • Every page is page one.
  • Tested how-to docs. If not, note why here. N/A: reference
  • All pages contain metadata.
  • Updated sources.yaml. For more info, review track docs changes
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.

@cloudjumpercat cloudjumpercat requested a review from a team as a code owner March 5, 2025 21:38
Copy link

netlify bot commented Mar 5, 2025

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit 58f2408
🔍 Latest deploy log https://app.netlify.com/sites/kongdeveloper/deploys/67c9c04cc52aec000889c1a4
😎 Deploy Preview https://deploy-preview-617--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Contributor

@Guaris Guaris left a comment

Choose a reason for hiding this comment

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

There isn't much to review here IMO, we just need this page to exist.

It feels like the content on that page should be on the plugins?

I agree, I would add a todo to that page to remind whoever takes that page on to add that info.

Is there a way (and should we) remove all the headers except the ## [version number] breaking changes headers so it's easier to navigate to the version you need?

I think we should. Especially since all of the sections aren't uniform. Personally, I would bold those headers and create a post migration ticket to make these entry uniform if it all possible. There may be a @fabianrbz solution here. I would tag him in it and if there is nothing let's just merge this tomorrow morning.

@fabianrbz
Copy link
Collaborator

Is there a way (and should we) remove all the headers except the ## [version number] breaking changes headers so it's easier to navigate to the version you need?

I think we should. Especially since all of the sections aren't uniform. Personally, I would bold those headers and create a post migration ticket to make these entry uniform if it all possible. There may be a @fabianrbz solution here. I would tag him in it and if there is nothing let's just merge this tomorrow morning.

I can't think of anything other than I would bold those headers, manually replace the headers with bold.

@Guaris Guaris self-requested a review March 6, 2025 15:55
@cloudjumpercat cloudjumpercat merged commit 5e4a6de into main Mar 6, 2025
10 checks passed
@cloudjumpercat cloudjumpercat deleted the breaking-changes branch March 6, 2025 15:57
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.

Breaking changes pages
4 participants