Skip to content

Commit ac1fd8b

Browse files
author
data-plane-api(CircleCI)
committed
api: some fixups post repo merge. (#3103)
Signed-off-by: Harvey Tuch <[email protected]> Mirrored from https://github.com/envoyproxy/envoy @ ca111bc0cfd01c290656d5cfb02b09ba83d417f8
1 parent 7e2c55e commit ac1fd8b

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
# Data plane API
22

3-
This repository hosts the configuration and APIs that drive [Envoy](https://www.envoyproxy.io/). The
3+
This tree hosts the configuration and APIs that drive [Envoy](https://www.envoyproxy.io/). The
44
APIs are also in some cases used by other proxy solutions that aim to interoperate with management
55
systems and configuration generators that are built against this standard. Thus, we consider these a
66
set of *universal data plane* APIs. See [this](https://medium.com/@mattklein123/the-universal-data-plane-api-d15cec7a)
77
blog post for more information on the universal data plane concept.
88

9-
Additionally, all of the documentation for the Envoy project is built directly from this repository.
10-
This allows us to keep all of our documentation next to the configuration and APIs that derive it.
9+
# Repository structure
1110

12-
# Further reading
11+
The API tree can be found at two locations:
12+
* https://github.com/envoyproxy/envoy/tree/master/api - canonical read/write home for the APIs.
13+
* https://github.com/envoyproxy/data-plane-api - read-only mirror of
14+
https://github.com/envoyproxy/envoy/tree/master/api, providing the ability to consume the data
15+
plane APIs without the Envoy implementation.
16+
17+
# Further API reading
1318

1419
* [API overview for developers](API_OVERVIEW.md)
1520
* [API overview for users](https://www.envoyproxy.io/docs/envoy/latest/configuration/overview/v2_overview#)

0 commit comments

Comments
 (0)