gateway-api
gateway-api copied to clipboard
Improvement to the website description of what a Gateway API is and is not
What is the difference between a Gateway API and an API Gateway?
This is one question that is begging to be answered but is not cleared up by the website content.
I'll add some clarification around that as well as spruce up the existing content.
/assign
I definitely think that our existing docs could use some updates, along the lines of what I said in those notes.
The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.
This bot triages issues and PRs according to the following rules:
- After 90d of inactivity,
lifecycle/stale
is applied - After 30d of inactivity since
lifecycle/stale
was applied,lifecycle/rotten
is applied - After 30d of inactivity since
lifecycle/rotten
was applied, the issue is closed
You can:
- Mark this issue or PR as fresh with
/remove-lifecycle stale
- Mark this issue or PR as rotten with
/lifecycle rotten
- Close this issue or PR with
/close
- Offer to help out with Issue Triage
Please send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale
/remove-lifecycle stale
@carlisia, are you still able to take this one on? If not, maybe we can write it up for someone else?
@youngnick I'd like to take this if @carlisia are not working on this.
The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.
This bot triages issues and PRs according to the following rules:
- After 90d of inactivity,
lifecycle/stale
is applied - After 30d of inactivity since
lifecycle/stale
was applied,lifecycle/rotten
is applied - After 30d of inactivity since
lifecycle/rotten
was applied, the issue is closed
You can:
- Mark this issue or PR as fresh with
/remove-lifecycle stale
- Mark this issue or PR as rotten with
/lifecycle rotten
- Close this issue or PR with
/close
- Offer to help out with Issue Triage
Please send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.
This bot triages issues and PRs according to the following rules:
- After 90d of inactivity,
lifecycle/stale
is applied - After 30d of inactivity since
lifecycle/stale
was applied,lifecycle/rotten
is applied - After 30d of inactivity since
lifecycle/rotten
was applied, the issue is closed
You can:
- Mark this issue or PR as fresh with
/remove-lifecycle rotten
- Close this issue or PR with
/close
- Offer to help out with Issue Triage
Please send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten
/remove-lifecycle rotten
This one does still need to be done, contributors are welcome here.
/help-wanted
We would like to see this one make it for GA if possible, help from a contributor would be very much appreciated!
/help
@shaneutt: This request has been marked as needing help from a contributor.
Guidelines
Please ensure that the issue body includes answers to the following questions:
- Why are we solving this issue?
- To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
- Does this issue have zero to low barrier of entry?
- How can the assignee reach out to you for help?
For more details on the requirements of such an issue, please see here and ensure that they are met.
If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help
command.
In response to this:
We would like to see this one make it for GA if possible, help from a contributor would be very much appreciated!
/help
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
/priority important-soon
@gyohuangxin @carlisia Checking if either of you have progressed anything on Gateway API vs API Gateway description?
I'd really love to have some clarifying words around this, perhaps even how Gateway API differs to API Management (though I don't see that as essential, more of a nice to have).
In terms of where to add this clarification, I'm thinking the Introduction section on the landing page of https://gateway-api.sigs.k8s.io/, near the top in "What is the Gateway API?" would make sense?
Either that, or a separate section on that page to explicitly ask the question "How does Gateway API differ from an API Gateway?"
The original notes linked above give a 404 :( https://carlisia.github.io/carlisia/scrapbook/2022/gw-api-desc
@david-martin I have no progress around this description. So please go ahead to add your words, and I'd love to give my comments :)
/assign
@gyohuangxin when you have time, words in #2191