-
Notifications
You must be signed in to change notification settings - Fork 564
align API Gateway definition with CNCF Glossary #3653
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
Conversation
/test pull-gateway-api-verify |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @craigbox! Great cleanup for our docs
site-src/index.md
Outdated
|
||
Most Gateway API implementations are API Gateways to some extent, but not all | ||
API Gateways are Gateway API implementations. | ||
#### What's the difference between Gateway API and an API Gateway? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: This doesn't really feel like a subheading of "Use Cases" (###
) or "Why does a role-oriented API matter?" (##
). I know it feels like overkill for this to be H2 (##
), but I'm not really sure that it fits very neatly in any of our existing sections.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am 99% sure that's a typo
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: craigbox, robscott The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Thanks @craigbox! /lgtm |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This site offers a comparison of an API Gateway with the Gateway API, with a very broad definition, which defines almost any ingress system or edge router as an API gateway, regardless of whether the traffic passing through it is user- or machine-facing.
The industry tends towards a more narrow definition, which is well-captured by the CNCF Glossary. I've copied that language into the index and FAQ pages and added a link to the glossary.
Does this PR introduce a user-facing change?: