gateway
gateway copied to clipboard
docs: Show GatewayAPI APIs in EG docs
Description:
Describe the issue.
Currently the API reference only shows Envoy Gateway extensions https://gateway.envoyproxy.io/latest/api/
We should also show Gateway API reference within Envoy Gateway to provide a better experience https://gateway-api.sigs.k8s.io/reference/spec/
[optional Relevant Links:]
Any extra documentation required to understand the issue.
@zirain @Xunzhuo thoughts on the best way to do this ? lets copy these over from upstream https://github.com/kubernetes-sigs/gateway-api/tree/main/site-src/api-types into https://github.com/envoyproxy/gateway/tree/main/site/content/en/latest/api ?
that make sense
When should we update the copied files? Each time we bump the gwapi version ?
@Xunzhuo we could add the new make target that does the fetch + copy and add it into existing docs pipeline and we can use the go mod version when fetching, so it will ideally only change when we bump gwapi version
Yep, let me add it.
This issue has been automatically marked as stale because it has not had activity in the last 30 days.
Seems we can do something as in https://github.com/envoyproxy/gateway/pull/3416, to link the GW-API type to relevant field.
This issue has been automatically marked as stale because it has not had activity in the last 30 days.
/unstaleify
This issue has been automatically marked as stale because it has not had activity in the last 30 days.
hey @zirain can you hep with this one ?
wait for upstream: https://github.com/kubernetes-sigs/gateway-api/pull/3204
This issue has been automatically marked as stale because it has not had activity in the last 30 days.