Skip to content

Commit

Permalink
api: some fixups post repo merge. (envoyproxy#3103)
Browse files Browse the repository at this point in the history
Signed-off-by: Harvey Tuch <[email protected]>
  • Loading branch information
htuch authored Apr 17, 2018
1 parent 8f62fe2 commit ca111bc
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ maximize the chances of your PR being merged.
build. If your PR cannot have 100% coverage for some reason please clearly explain why when you
open it.
* Any PR that changes user-facing behavior **must** have associated documentation in [docs](docs) as
well as [release notes](docs/root/intro/version_history.rst).
well as [release notes](docs/root/intro/version_history.rst). API changes should be documented
inline with protos as per the [API contribution guidelines](api/CONTRIBUTING.md).
* All code comments and documentation are expected to have proper English grammar and punctuation.
If you are not a fluent English speaker (or a bad writer ;-)) please let us know and we will try
to find some help but there are no guarantees.
Expand Down
13 changes: 9 additions & 4 deletions api/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# Data plane API

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

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

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

# Further API reading

* [API overview for developers](API_OVERVIEW.md)
* [API overview for users](https://www.envoyproxy.io/docs/envoy/latest/configuration/overview/v2_overview#)
Expand Down
3 changes: 0 additions & 3 deletions ci/api_mirror.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@

set -e

# TODO(htuch): Remove this once we've verified this script works.
set -x

CHECKOUT_DIR=../data-plane-api

if [ -z "$CIRCLE_PULL_REQUEST" ] && [ "$CIRCLE_BRANCH" == "master" ]
Expand Down

0 comments on commit ca111bc

Please sign in to comment.