Skip to content

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

Merged
merged 2 commits into from
Mar 5, 2025

Conversation

craigbox
Copy link
Contributor

@craigbox craigbox commented Mar 3, 2025

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

Updates comparison of Gateway API and API Gateway to use the CNCF's definition of the latter.

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 3, 2025
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 3, 2025
@craigbox
Copy link
Contributor Author

craigbox commented Mar 3, 2025

/test pull-gateway-api-verify

Copy link
Member

@robscott robscott left a 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


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

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.

Copy link
Contributor Author

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

@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 4, 2025
@robscott
Copy link
Member

robscott commented Mar 5, 2025

Thanks @craigbox!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 5, 2025
@k8s-ci-robot k8s-ci-robot merged commit 4eecfaf into kubernetes-sigs:main Mar 5, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants