From df0c95a0ab6e38c5d0fb10288b192a3117be062e Mon Sep 17 00:00:00 2001 From: "update-envoy[bot]" <135279899+update-envoy[bot]@users.noreply.github.com> Date: Wed, 25 Oct 2023 08:25:46 +0000 Subject: [PATCH] docs: minor fixes to API docs (#30480) Signed-off-by: Ali Beyad Mirrored from https://github.com/envoyproxy/envoy @ 0e22afd8555b11b35cd4e0568c4b1507e2391907 --- API_VERSIONING.md | 2 +- STYLE.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/API_VERSIONING.md b/API_VERSIONING.md index 8add2227..726d1d03 100644 --- a/API_VERSIONING.md +++ b/API_VERSIONING.md @@ -87,7 +87,7 @@ no field will ever be removed nor will Envoy ever remove the implementation for field. **NOTE**: Client implementations are free to output additional warnings about field usage beyond -deprecation, if for example, the use of the continued use of the field is deemed a substantial +deprecation, if for example, the continued use of the field is deemed a substantial security risk. Individual client versions are also free to stop supporting fields if they want to, though Envoy Proxy (as an xDS client) commits to never doing so. diff --git a/STYLE.md b/STYLE.md index b0821c92..e8a0580b 100644 --- a/STYLE.md +++ b/STYLE.md @@ -162,7 +162,7 @@ To add an extension config to the API, the steps below should be followed: [source/extensions/extensions_build_config.bzl](../source/extensions/extensions_build_config.bzl) or [contrib/contrib_build_config.bzl](../contrib/contrib_build_config.bzl) to include the new extension. 1. If the extension is not hidden, find or create a docs file with a toctree - and to reference your proto to make sure users can navigate to it from the API docs + and reference your proto to make sure users can navigate to it from the API docs (and to not break the docs build), like [docs/root/api-v3/admin/admin.rst](../docs/root/api-v3/admin/admin.rst). 1. Run `./tools/proto_format/proto_format.sh fix`. **Before running the script**, you will need to **commit your local changes**. By adding the commit, the tool will recognize the change, and will regenerate the `BUILD` file and reformat `foobar.proto` as needed. If you have not followed any of the above steps correctly `proto_format.sh` may remove some of the files that you added. If that is the case you can revert to the committed state, and try again once any issues are resolved. 1. See the [key-value-store PR](https://github.com/envoyproxy/envoy/pull/17745/files) for an example of adding a new extension point to common.