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

KIC 2.9 version compat #5259

Merged
merged 7 commits into from
Mar 7, 2023
Merged

KIC 2.9 version compat #5259

merged 7 commits into from
Mar 7, 2023

Conversation

pmalek
Copy link
Member

@pmalek pmalek commented Mar 6, 2023

Description

Update version compatibility matrices for KIC 2.9.x

Testing instructions

Netlify link:

Checklist

  • Review label added
  • PR pointed to correct branch (main for immediate publishing, or a release branch: e.g. release/gateway-3.2, release/deck-1.17)

cloudjumpercat and others added 5 commits March 6, 2023 16:08
docs: GRPCRoute guide added

Signed-off-by: Mattia Lavacca <[email protected]>
* chore: wrap source and fix minor errors

* chore: fix KIC webhook article title

* doc(kic) revise event troubleshooting

Update the KIC troubleshooting guide with additional information about
troubleshooting using Events, including the configuration push Event
type to be introduced in 2.9.

Rewrite the example as a more complete guide, with example problem
resources, example queries, and issue remediation.

* doc(kic) add HTTPRoute port limitation warning

* Apply suggestions from code review

Co-authored-by: Diana <[email protected]>

* Fix Vale errors

Signed-off-by: Diana <[email protected]>

* pr: VAW title change

* pr: clarify and gate version note

---------

Signed-off-by: Diana <[email protected]>
Co-authored-by: Diana <[email protected]>
* feat(kic): add docs about Gateway Discovery

---------

Co-authored-by: Grzegorz Burzyński <[email protected]>
@pmalek pmalek added team-k8s Kubernetes task tracking (including KIC,KGO) review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? labels Mar 6, 2023
@pmalek pmalek self-assigned this Mar 6, 2023
@pmalek pmalek requested a review from a team as a code owner March 6, 2023 16:16
@pmalek pmalek requested a review from a team March 6, 2023 20:25
@rainest
Copy link
Contributor

rainest commented Mar 6, 2023

Wait, what made this not get the normal Netlify preview bot comment?

Aside that, @mheap do you know how hard it would be to make a docs widget that takes a YAML compat table input and renders a markdown table with the N most recent versions? Since we now use the single-source docs system it's (more) annoying to have to chop off old table columns and add new ones.

@mheap
Copy link
Member

mheap commented Mar 6, 2023

@rainest I did a spike on the config driven approach with a sliding window. It’s not trivial with the current setup (liquid). One for @fabianrbz to investigate writing a plugin for

@rainest
Copy link
Contributor

rainest commented Mar 6, 2023

Aight, maybe we want to look into handling it out of band then. Maybe Liquid can't do it well, but I bet a slightly scuffed Python script can.

@pmalek
Copy link
Member Author

pmalek commented Mar 7, 2023

Wait, what made this not get the normal Netlify preview bot comment?

@rainest its targeting non main branch, that's probably why

@pmalek
Copy link
Member Author

pmalek commented Mar 7, 2023

Apart from the possible improvements around the process that we can make does that PR look good enough?

@rainest rainest changed the base branch from release/kic-2.9 to main March 7, 2023 21:03
@rainest rainest changed the base branch from main to release/kic-2.9 March 7, 2023 21:04
Copy link
Contributor

@rainest rainest left a comment

Choose a reason for hiding this comment

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

The table stuff is one of the things where you really need the preview because reading the actual content of the diff is painful, and it's also easy to accidentally break the formatting, so you really want to see the rendered output.

Flipping to main didn't trigger the bot, so I think we just have to review this properly on the final merge to main. AFAIK content-wise we're just copying values from 2.8, so despite not easily being able to confirm they do match from the diff, I wouldn't expect that to be wrong.

@rainest rainest merged commit 2d506b5 into release/kic-2.9 Mar 7, 2023
@rainest rainest deleted the kic-2.9-version-compat branch March 7, 2023 21:10
lena-larionova pushed a commit that referenced this pull request Mar 28, 2023
* Add 2.9 nav file and 2.9 version to version file

Signed-off-by: Diana <[email protected]>

* docs: GRPCRoute guide (#5216)

docs: GRPCRoute guide added

Signed-off-by: Mattia Lavacca <[email protected]>

* Update KIC troubleshooting for 2.9 and add GWAPI port note (#5196)

* chore: wrap source and fix minor errors

* chore: fix KIC webhook article title

* doc(kic) revise event troubleshooting

Update the KIC troubleshooting guide with additional information about
troubleshooting using Events, including the configuration push Event
type to be introduced in 2.9.

Rewrite the example as a more complete guide, with example problem
resources, example queries, and issue remediation.

* doc(kic) add HTTPRoute port limitation warning

* Apply suggestions from code review

Co-authored-by: Diana <[email protected]>

* Fix Vale errors

Signed-off-by: Diana <[email protected]>

* pr: VAW title change

* pr: clarify and gate version note

---------

Signed-off-by: Diana <[email protected]>
Co-authored-by: Diana <[email protected]>

* KIC 2.9.x update deployment guides - Gateway Discovery (#5231)

* feat(kic): add docs about Gateway Discovery

---------

Co-authored-by: Grzegorz Burzyński <[email protected]>

* chore(kic) extract common docs to includes (#5256)

Co-authored-by: Michael Heap <[email protected]>

* docs(kic): update kic 2.9 nav (#5253)

Signed-off-by: Mattia Lavacca <[email protected]>

* doc(kic): update compatibility tables for 2.9 (#5259)

* kic: show Gateway Discovery guide entry for versions 2.9+

* chore(kic): fix code block languages

* chore(kic): fix incorrect helm.sh link

* GatewayAlpha feature-gate added to grpc guide (#5323)

kic: update grpcRoute GatewayAlpha FG

Signed-off-by: Mattia Lavacca <[email protected]>

* Update docs for KIC 2.9.0 (#5360)

Synchronize auto-generated KIC API reference

Signed-off-by: Kong's Team k8s bot <[email protected]>
Co-authored-by: Travis Raines <[email protected]>

* chore(kic) update CRD links in nav

* chore(kic) generate 2.8 KIC CRD reference (#5361)

Synchronize auto-generated KIC API reference

Signed-off-by: Kong's Team k8s bot <[email protected]>

---------

Signed-off-by: Diana <[email protected]>
Signed-off-by: Mattia Lavacca <[email protected]>
Signed-off-by: Kong's Team k8s bot <[email protected]>
Co-authored-by: Diana <[email protected]>
Co-authored-by: Mattia Lavacca <[email protected]>
Co-authored-by: Travis Raines <[email protected]>
Co-authored-by: Grzegorz Burzyński <[email protected]>
Co-authored-by: Michael Heap <[email protected]>
Co-authored-by: Kong's Team k8s bot <[email protected]>
nbialostosky pushed a commit to nbialostosky/docs.konghq.com that referenced this pull request Apr 12, 2023
* Add 2.9 nav file and 2.9 version to version file

Signed-off-by: Diana <[email protected]>

* docs: GRPCRoute guide (Kong#5216)

docs: GRPCRoute guide added

Signed-off-by: Mattia Lavacca <[email protected]>

* Update KIC troubleshooting for 2.9 and add GWAPI port note (Kong#5196)

* chore: wrap source and fix minor errors

* chore: fix KIC webhook article title

* doc(kic) revise event troubleshooting

Update the KIC troubleshooting guide with additional information about
troubleshooting using Events, including the configuration push Event
type to be introduced in 2.9.

Rewrite the example as a more complete guide, with example problem
resources, example queries, and issue remediation.

* doc(kic) add HTTPRoute port limitation warning

* Apply suggestions from code review

Co-authored-by: Diana <[email protected]>

* Fix Vale errors

Signed-off-by: Diana <[email protected]>

* pr: VAW title change

* pr: clarify and gate version note

---------

Signed-off-by: Diana <[email protected]>
Co-authored-by: Diana <[email protected]>

* KIC 2.9.x update deployment guides - Gateway Discovery (Kong#5231)

* feat(kic): add docs about Gateway Discovery

---------

Co-authored-by: Grzegorz Burzyński <[email protected]>

* chore(kic) extract common docs to includes (Kong#5256)

Co-authored-by: Michael Heap <[email protected]>

* docs(kic): update kic 2.9 nav (Kong#5253)

Signed-off-by: Mattia Lavacca <[email protected]>

* doc(kic): update compatibility tables for 2.9 (Kong#5259)

* kic: show Gateway Discovery guide entry for versions 2.9+

* chore(kic): fix code block languages

* chore(kic): fix incorrect helm.sh link

* GatewayAlpha feature-gate added to grpc guide (Kong#5323)

kic: update grpcRoute GatewayAlpha FG

Signed-off-by: Mattia Lavacca <[email protected]>

* Update docs for KIC 2.9.0 (Kong#5360)

Synchronize auto-generated KIC API reference

Signed-off-by: Kong's Team k8s bot <[email protected]>
Co-authored-by: Travis Raines <[email protected]>

* chore(kic) update CRD links in nav

* chore(kic) generate 2.8 KIC CRD reference (Kong#5361)

Synchronize auto-generated KIC API reference

Signed-off-by: Kong's Team k8s bot <[email protected]>

---------

Signed-off-by: Diana <[email protected]>
Signed-off-by: Mattia Lavacca <[email protected]>
Signed-off-by: Kong's Team k8s bot <[email protected]>
Co-authored-by: Diana <[email protected]>
Co-authored-by: Mattia Lavacca <[email protected]>
Co-authored-by: Travis Raines <[email protected]>
Co-authored-by: Grzegorz Burzyński <[email protected]>
Co-authored-by: Michael Heap <[email protected]>
Co-authored-by: Kong's Team k8s bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? team-k8s Kubernetes task tracking (including KIC,KGO)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants