Chiebot-Mirror
/
data-plane-api
mirror of https://github.com/envoyproxy/data-plane-api.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: clarify new extension category doc (#20052)

Browse Source 
Signed-off-by: Adi Suissa-Peleg <adip@google.com>

Mirrored from https://github.com/envoyproxy/envoy @ de0554ddbade2b543a6e81c09752ac46dc382651
pull/626/head
data-plane-api(Azure Pipelines) 3 years ago
parent c0da0e3e8b
commit e3f7d0c3a3
1 changed files with 3 additions and 1 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      STYLE.md

4
STYLE.md
Unescape View File

@ -134,7 +134,7 @@ To add an extension config to the API, the steps below should be followed:
annotation of the form `// [#extension-category: your.extension.category]` annotation of the form `// [#extension-category: your.extension.category]`
in one of the proto files for the docs build to pass. in one of the proto files for the docs build to pass.
1. Update 1. Update
[source/extensions/extensions_build_config.bzl](source/extensions/extensions_build_config.bzl) [source/extensions/extensions_build_config.bzl](../source/extensions/extensions_build_config.bzl)
to include the new extension. to include the new extension.
1. If the extension is not hidden, find or create a docs file with a toctree 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 to reference your proto to make sure users can navigate to it from the API docs
@ -147,6 +147,8 @@ To add an extension config to the API, the steps below should be followed:
(`option (udpa.annotations.file_status).package_version_status = ACTIVE;`). (`option (udpa.annotations.file_status).package_version_status = ACTIVE;`).
This is required to automatically include the config proto in [api/versioning/BUILD](versioning/BUILD). This is required to automatically include the config proto in [api/versioning/BUILD](versioning/BUILD).
1. Add a reference to the v3 extension config in (1) in [api/versioning/BUILD](versioning/BUILD) under `active_protos`. 1. Add a reference to the v3 extension config in (1) in [api/versioning/BUILD](versioning/BUILD) under `active_protos`.
1. If you introduce a new extension category, you'll also need to add its name
under `EXTENSION_CATEGORIES` in: [tools/extensions/extensions_check.py](../tools/extensions/extensions_check.py).
1. Run `./tools/proto_format/proto_format.sh fix`. This should regenerate the `BUILD` file and 1. Run `./tools/proto_format/proto_format.sh fix`. This should regenerate the `BUILD` file and
reformat `foobar.proto` as needed. reformat `foobar.proto` as needed.

Write Preview
Loading…
Cancel
Save