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

BackendTLSPolicy does not show up in generated API Spec #3016

Open
robscott opened this issue Apr 23, 2024 · 4 comments
Open

BackendTLSPolicy does not show up in generated API Spec #3016

robscott opened this issue Apr 23, 2024 · 4 comments
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation.

Comments

@robscott
Copy link
Member

What happened:
BackendTLSPolicy is currently absent from https://gateway-api.sigs.k8s.io/reference/spec.

What you expected to happen:
BackendTLSPolicy to be included with all our other APIs.

How to reproduce it (as minimally and precisely as possible):
Visit https://gateway-api.sigs.k8s.io/reference/spec.

Anything else we need to know?:
It's worth noting that references to BackendTLSPolicy types are still linked, they just don't go anywhere:
Screenshot 2024-04-23 at 4 52 09 PM

My best guess is that the docs generator we're using is just confused by the transition to v1alpha3 while all other API types are in different versions. Maybe something used in the logic to combine API packages is messed up?

I've been meaning to move to https://github.com/elastic/crd-ref-docs, this may be another reason to try that out if we can't find an easy fix with our existing docs generation.

@robscott robscott added kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation. labels Apr 23, 2024
@candita
Copy link
Contributor

candita commented Apr 24, 2024

@robscott do you want to include all the version packages on that page? In the template we only include two: https://github.com/kubernetes-sigs/gateway-api/blob/main/hack/api-docs/pkg.tpl#L40-L49

@robscott
Copy link
Member Author

@candita good point! Maybe that's the only change we'd need? So far we've included all versions on a single page which I think is probably simplest, but happy to take a different approach if that's better.

@candita
Copy link
Contributor

candita commented Apr 24, 2024

We could revert to https://github.com/kubernetes-sigs/gateway-api/blob/b1f655e6e88690b47447643066c550884e2f81ab/hack/api-docs/pkg.tpl, which iterates over the packages, and that would fix one problem.

@robscott
Copy link
Member Author

We could revert to https://github.com/kubernetes-sigs/gateway-api/blob/b1f655e6e88690b47447643066c550884e2f81ab/hack/api-docs/pkg.tpl, which iterates over the packages, and that would fix one problem.

I'm not sure why we made that change to begin with, but reverting to the earlier version SGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants