docs: minor fixes to API docs (#30480)

Signed-off-by: Ali Beyad <abeyad@google.com>

Mirrored from https://github.com/envoyproxy/envoy @ 0e22afd8555b11b35cd4e0568c4b1507e2391907
main
update-envoy[bot] 1 year ago
parent e6c70470ad
commit df0c95a0ab
  1. 2
      API_VERSIONING.md
  2. 2
      STYLE.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.

@ -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.

Loading…
Cancel
Save