search

envoyproxy / gateway

Manages Envoy Proxy as a Standalone or Kubernetes-based Application Gateway
https://gateway.envoyproxy.io
Apache License 2.0
1.64k stars 357 forks source link

docs: Show GatewayAPI APIs in EG docs #2749

Open arkodg opened 9 months ago

arkodg commented 9 months ago

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.

arkodg commented 9 months ago

@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 ?

zirain commented 9 months ago

that make sense

Xunzhuo commented 9 months ago

When should we update the copied files? Each time we bump the gwapi version ?

arkodg commented 9 months ago

@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

Xunzhuo commented 9 months ago

Yep, let me add it.

github-actions[bot] commented 7 months ago

This issue has been automatically marked as stale because it has not had activity in the last 30 days.

shawnh2 commented 6 months ago

Seems we can do something as in https://github.com/envoyproxy/gateway/pull/3416, to link the GW-API type to relevant field.

github-actions[bot] commented 5 months ago

This issue has been automatically marked as stale because it has not had activity in the last 30 days.

StevenACoffman commented 5 months ago

/unstaleify

github-actions[bot] commented 4 months ago

This issue has been automatically marked as stale because it has not had activity in the last 30 days.

arkodg commented 4 months ago

hey @zirain can you hep with this one ?

zirain commented 4 months ago

wait for upstream: https://github.com/kubernetes-sigs/gateway-api/pull/3204

github-actions[bot] commented 3 months ago

This issue has been automatically marked as stale because it has not had activity in the last 30 days.

arkodg commented 2 months ago

@zirain looks like 3204 is probably not going to land anytime soon can we generate https://github.com/kubernetes-sigs/gateway-api/blob/main/site-src/reference/spec.md as part of docs CI and save the content with make generate . It will only change when gateway-api versions change

github-actions[bot] commented 1 month ago

This issue has been automatically marked as stale because it has not had activity in the last 30 days.