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

docs: Show GatewayAPI APIs in EG docs #2749

Open
arkodg opened this issue Mar 1, 2024 · 15 comments
Open

docs: Show GatewayAPI APIs in EG docs #2749

arkodg opened this issue Mar 1, 2024 · 15 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@arkodg
Copy link
Contributor

arkodg commented Mar 1, 2024

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 arkodg added triage road-to-ga documentation Improvements or additions to documentation and removed triage labels Mar 1, 2024
@arkodg arkodg added this to the v1.0.0 milestone Mar 1, 2024
@arkodg arkodg added the help wanted Extra attention is needed label Mar 1, 2024
@arkodg
Copy link
Contributor Author

arkodg commented Mar 1, 2024

@zirain
Copy link
Contributor

zirain commented Mar 2, 2024

that make sense

@Xunzhuo
Copy link
Member

Xunzhuo commented Mar 2, 2024

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

@arkodg
Copy link
Contributor Author

arkodg commented Mar 2, 2024

@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
Copy link
Member

Xunzhuo commented Mar 2, 2024

Yep, let me add it.

@Xunzhuo Xunzhuo self-assigned this Mar 2, 2024
@shawnh2 shawnh2 removed the help wanted Extra attention is needed label Mar 14, 2024
@arkodg arkodg modified the milestones: v1.0.0, v1.1.0-rc1 Mar 28, 2024
Copy link

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

@github-actions github-actions bot added the stale label Apr 27, 2024
@arkodg arkodg modified the milestones: v1.1.0-rc1, v1.1.0 May 23, 2024
@github-actions github-actions bot removed the stale label May 23, 2024
@shawnh2
Copy link
Contributor

shawnh2 commented May 30, 2024

Seems we can do something as in #3416, to link the GW-API type to relevant field.

Copy link

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

@github-actions github-actions bot added the stale label Jun 29, 2024
@StevenACoffman
Copy link

/unstaleify

Copy link

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

@github-actions github-actions bot added the stale label Jul 29, 2024
@arkodg
Copy link
Contributor Author

arkodg commented Jul 29, 2024

hey @zirain can you hep with this one ?

@zirain
Copy link
Contributor

zirain commented Jul 30, 2024

wait for upstream: kubernetes-sigs/gateway-api#3204

@arkodg arkodg modified the milestones: Backlog, v1.2.0 Jul 31, 2024
Copy link

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

@github-actions github-actions bot added the stale label Aug 30, 2024
@arkodg
Copy link
Contributor Author

arkodg commented Sep 19, 2024

@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 github-actions bot removed the stale label Sep 20, 2024
Copy link

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

@github-actions github-actions bot added the stale label Oct 20, 2024
@arkodg arkodg removed the stale label Oct 31, 2024
@arkodg arkodg modified the milestones: v1.2.0, Backlog Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

5 participants