gateway icon indicating copy to clipboard operation
gateway copied to clipboard

docs: Show GatewayAPI APIs in EG docs

Open arkodg opened this issue 1 year ago • 15 comments

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 avatar Mar 01 '24 18:03 arkodg

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

arkodg avatar Mar 01 '24 18:03 arkodg

that make sense

zirain avatar Mar 02 '24 00:03 zirain

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

Xunzhuo avatar Mar 02 '24 02:03 Xunzhuo

@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

arkodg avatar Mar 02 '24 03:03 arkodg

Yep, let me add it.

Xunzhuo avatar Mar 02 '24 05:03 Xunzhuo

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

github-actions[bot] avatar Apr 27 '24 08:04 github-actions[bot]

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

shawnh2 avatar May 30 '24 04:05 shawnh2

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

github-actions[bot] avatar Jun 29 '24 08:06 github-actions[bot]

/unstaleify

StevenACoffman avatar Jun 29 '24 15:06 StevenACoffman

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

github-actions[bot] avatar Jul 29 '24 16:07 github-actions[bot]

hey @zirain can you hep with this one ?

arkodg avatar Jul 29 '24 16:07 arkodg

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

zirain avatar Jul 30 '24 01:07 zirain

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

github-actions[bot] avatar Aug 30 '24 20:08 github-actions[bot]