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(docs): deprecate KongIngress' proxy and route in favor of annotations #3246

Merged
merged 4 commits into from
Dec 9, 2022

Conversation

czeslavo
Copy link
Contributor

@czeslavo czeslavo commented Dec 9, 2022

What this PR does / why we need it:

Adds deprecation comments to all KongIngress fields that have their replacement in form of an annotation.

Which issue this PR fixes:

Part of #2941.

Special notes for your reviewer:

PR Readiness Checklist:

Complete these before marking the PR as ready to review:

  • the CHANGELOG.md release notes have been updated to reflect any significant (and particularly user-facing) changes introduced by this PR

@czeslavo czeslavo temporarily deployed to Configure ci December 9, 2022 14:19 — with GitHub Actions Inactive
@czeslavo czeslavo temporarily deployed to Configure ci December 9, 2022 14:21 — with GitHub Actions Inactive
@czeslavo czeslavo force-pushed the chore/deprecate-proxy-route-kong-ingress branch from 553ce70 to 7e40b2a Compare December 9, 2022 14:22
@czeslavo czeslavo temporarily deployed to Configure ci December 9, 2022 14:22 — with GitHub Actions Inactive
@czeslavo czeslavo force-pushed the chore/deprecate-proxy-route-kong-ingress branch from 7e40b2a to 0a04468 Compare December 9, 2022 14:27
@czeslavo czeslavo temporarily deployed to Configure ci December 9, 2022 14:27 — with GitHub Actions Inactive
@czeslavo czeslavo temporarily deployed to Configure ci December 9, 2022 14:28 — with GitHub Actions Inactive
@czeslavo czeslavo marked this pull request as ready for review December 9, 2022 14:32
@czeslavo czeslavo requested a review from a team as a code owner December 9, 2022 14:32
@czeslavo czeslavo self-assigned this Dec 9, 2022
@czeslavo czeslavo added this to the KIC v2.8.0 milestone Dec 9, 2022
@czeslavo czeslavo temporarily deployed to Configure ci December 9, 2022 14:52 — with GitHub Actions Inactive
@czeslavo czeslavo temporarily deployed to Configure ci December 9, 2022 15:22 — with GitHub Actions Inactive
@czeslavo czeslavo temporarily deployed to Configure ci December 9, 2022 15:22 — with GitHub Actions Inactive
Copy link
Member

@pmalek pmalek left a comment

Choose a reason for hiding this comment

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

Do you mind linking here the relevant docs change as well?

@czeslavo
Copy link
Contributor Author

czeslavo commented Dec 9, 2022

Do you mind linking here the relevant docs change as well?

Do you mean a preview from docs.konghq.com? Once we merge it, I will update the PR on the docs repo side that's using the generated docs (Kong/docs.konghq.com#4813). For now you may look at the rich view of the md file: https:/Kong/kubernetes-ingress-controller/blob/8a9a7b854678f2671435f34d2ea3f6e7f68ce692/docs/api-reference.md

@pmalek
Copy link
Member

pmalek commented Dec 9, 2022

Do you mind linking here the relevant docs change as well?

Do you mean a preview from docs.konghq.com? Once we merge it, I will update the PR on the docs repo side that's using the generated docs (Kong/docs.konghq.com#4813). For now you may look at the rich view of the md file: https:/Kong/kubernetes-ingress-controller/blob/8a9a7b854678f2671435f34d2ea3f6e7f68ce692/docs/api-reference.md

Ok that's fine 👍 Let's merge this one then.

@rainest rainest merged commit 85133ff into main Dec 9, 2022
@rainest rainest deleted the chore/deprecate-proxy-route-kong-ingress branch December 9, 2022 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants