From ca111bc0cfd01c290656d5cfb02b09ba83d417f8 Mon Sep 17 00:00:00 2001 From: htuch Date: Tue, 17 Apr 2018 13:43:11 -0400 Subject: [PATCH] api: some fixups post repo merge. (#3103) Signed-off-by: Harvey Tuch --- CONTRIBUTING.md | 3 ++- api/README.md | 13 +++++++++---- ci/api_mirror.sh | 3 --- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c259add4a734..28e4072c563c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/api/README.md b/api/README.md index 194ff76c6d4d..8efe45495c7f 100644 --- a/api/README.md +++ b/api/README.md @@ -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#) diff --git a/ci/api_mirror.sh b/ci/api_mirror.sh index 3612a4042f6c..878f94d87778 100755 --- a/ci/api_mirror.sh +++ b/ci/api_mirror.sh @@ -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" ]