search

envoyproxy / gateway

Manages Envoy Proxy as a Standalone or Kubernetes-based Application Gateway
https://gateway.envoyproxy.io
Apache License 2.0
1.45k stars 297 forks source link

Add docs describing how to use BackendTrafficPolicy #2070

Open arkodg opened 8 months ago

arkodg commented 8 months ago

Description:

Describe the issue.

[optional Relevant Links:]

Any extra documentation required to understand the issue.

github-actions[bot] commented 7 months ago

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

github-actions[bot] commented 6 months ago

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

shawnh2 commented 1 month ago

For now, the usage of BTP (like CircuitBreakers, FaultInjection, etc) are separated docs:

These docs have described various usgae of BTP, should we keep that way? or is there anything else we need to describe about BTP.

arkodg commented 1 month ago

Similar to Tasks, we need a new section called Concepts (tracked with https://github.com/envoyproxy/gateway/issues/2854) to explain various concepts like BTP and then link em out to specific tasks like the ones shared above

shawnh2 commented 1 month ago

Great! So in this way, the design doc is to answer WHY, concept doc is to answer WHAT, and task doc is to answer HOW.