Skip to content

docs: Conceptual Docs for Api Gateways, The Gateway Api & Envoy Proxy#5739

Closed
melsal13 wants to merge 0 commit intoenvoyproxy:mainfrom
melsal13:docs-eg-conceptual
Closed

docs: Conceptual Docs for Api Gateways, The Gateway Api & Envoy Proxy#5739
melsal13 wants to merge 0 commit intoenvoyproxy:mainfrom
melsal13:docs-eg-conceptual

Conversation

@melsal13
Copy link
Copy Markdown
Contributor

@melsal13 melsal13 commented Apr 15, 2025

What type of PR is this?
Adds conceptual documentation for:

  • API Gateway
  • The Gateway API
  • Envoy Proxy

What this PR does / why we need it:
Introduces foundational conceptual docs to help onboard new users and improve documentation clarity.

Which issue(s) this PR fixes:
Fixes #5738
Fixes #5753
Fixes #5754

Release Notes: No

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 15, 2025

Codecov Report

Attention: Patch coverage is 51.38889% with 105 lines in your changes missing coverage. Please review.

Project coverage is 65.29%. Comparing base (83d86ef) to head (56badac).
Report is 10 commits behind head on main.

Files with missing lines Patch % Lines
internal/provider/kubernetes/controller.go 0.00% 41 Missing ⚠️
internal/provider/kubernetes/indexers.go 0.00% 36 Missing ⚠️
internal/gatewayapi/backendtlspolicy.go 85.93% 6 Missing and 3 partials ⚠️
internal/provider/kubernetes/topology_injector.go 50.00% 5 Missing and 1 partial ⚠️
internal/cmd/certgen.go 60.00% 3 Missing and 1 partial ⚠️
internal/gatewayapi/ext_service.go 40.00% 2 Missing and 1 partial ⚠️
internal/gatewayapi/listener.go 25.00% 2 Missing and 1 partial ⚠️
internal/ir/xds.go 0.00% 3 Missing ⚠️

❌ Your patch check has failed because the patch coverage (51.38%) is below the target coverage (60.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5739      +/-   ##
==========================================
- Coverage   65.40%   65.29%   -0.12%     
==========================================
  Files         216      216              
  Lines       35767    35912     +145     
==========================================
+ Hits        23392    23447      +55     
- Misses      10925    11012      +87     
- Partials     1450     1453       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@melsal13 melsal13 changed the title docs: draft of conceptual doc for api gateway docs: Conceptual Docs for Api Gateways, The Gateway Api & Envoy Proxy Apr 17, 2025
@melsal13 melsal13 marked this pull request as ready for review April 23, 2025 20:45
@melsal13 melsal13 requested a review from a team as a code owner April 23, 2025 20:45
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider changing this section to be about Gateway vs Ingress and how Gateway is the evolution of Ingress. Maybe explain how someone coming from a background of using Kubernetes ingress can use and understand Gateway API

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ingress here is the concept, not the resource

As you've pointed out, we also need to explain the Ingress in the Gateway API section, haha

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a section like this in API Gateways and the Gateway API doc!

@melsal13 melsal13 force-pushed the docs-eg-conceptual branch from 703d826 to 6300ac3 Compare May 1, 2025 20:38
@arkodg
Copy link
Copy Markdown
Contributor

arkodg commented May 2, 2025

@melsal13 lint is failing, since linkinator cannot find the links

Copy link
Copy Markdown
Contributor

@missBerg missBerg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some suggestions, let me know if you disagree with any of them :)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider putting this paragraph first in the section The Gateway API in Envoy Gateway

@melsal13 melsal13 closed this May 9, 2025
@melsal13 melsal13 force-pushed the docs-eg-conceptual branch from 56badac to 0752df1 Compare May 9, 2025 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Conceptual doc for Envoy Proxy docs: Conceptual doc for The Gateway API docs: Conceptual doc for API Gateways

3 participants