docs: Improve ordering and titles in API TOCs (#23536)

Signed-off-by: Ryan Northey <ryan@synca.io> Mirrored from https://github.com/envoyproxy/envoy @ 355f9ea21ac245904518c2b6c158d308132e23bd
2 years ago · 84b6f359c1
parent 227f6dbe97
commit 84b6f359c1
32 changed files with 32 additions and 32 deletions
--- a/contrib/envoy/extensions/vcl/v3alpha/vcl_socket_interface.proto
+++ b/contrib/envoy/extensions/vcl/v3alpha/vcl_socket_interface.proto
@ -11,7 +11,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/vcl
 option (udpa.annotations.file_status).work_in_progress = true;
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Vcl Socket Interface configuration]
+// [#protodoc-title: VCL socket interface configuration]
 // VCL :ref:`configuration overview <config_sock_interface_vcl>`.
 // [#extension: envoy.bootstrap.vcl]

--- a/envoy/admin/v3/server_info.proto
+++ b/envoy/admin/v3/server_info.proto
@ -15,7 +15,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/admin/v3;adminv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Server State]
+// [#protodoc-title: Server state]

 // Proto representation of the value returned by /server_info, containing
 // server version/server status information.
--- a/envoy/config/common/key_value/v3/config.proto
+++ b/envoy/config/common/key_value/v3/config.proto
@ -15,7 +15,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/common/key_value/v3;key_valuev3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Key Value Store storage plugin]
+// [#protodoc-title: Key/value store storage plugin]

 // This shared configuration for Envoy key value stores.
 message KeyValueStoreConfig {
--- a/envoy/config/common/mutation_rules/v3/mutation_rules.proto
+++ b/envoy/config/common/mutation_rules/v3/mutation_rules.proto
@ -14,7 +14,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/common/mutation_rules/v3;mutation_rulesv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Header Mutation Rules]
+// [#protodoc-title: Header mutation rules]

 // The HeaderMutationRules structure specifies what headers may be
 // manipulated by a processing filter. This set of rules makes it
--- a/envoy/config/core/v3/backoff.proto
+++ b/envoy/config/core/v3/backoff.proto
@ -14,7 +14,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/core/v3;corev3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Backoff Strategy]
+// [#protodoc-title: Backoff strategy]

 // Configuration defining a jittered exponential back off strategy.
 message BackoffStrategy {
--- a/envoy/config/core/v3/http_uri.proto
+++ b/envoy/config/core/v3/http_uri.proto
@ -14,7 +14,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/core/v3;corev3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: HTTP Service URI ]
+// [#protodoc-title: HTTP service URI ]

 // Envoy external URI descriptor
 message HttpUri {
--- a/envoy/config/core/v3/proxy_protocol.proto
+++ b/envoy/config/core/v3/proxy_protocol.proto
@ -10,7 +10,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/core/v3;corev3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Proxy Protocol]
+// [#protodoc-title: Proxy protocol]

 message ProxyProtocolConfig {
  enum Version {
--- a/envoy/config/core/v3/socket_option.proto
+++ b/envoy/config/core/v3/socket_option.proto
@ -12,7 +12,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/core/v3;corev3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Socket Option ]
+// [#protodoc-title: Socket option]

 // Generic socket option message. This would be used to set socket options that
 // might not exist in upstream kernels or precompiled Envoy binaries.
--- a/envoy/config/tap/v3/common.proto
+++ b/envoy/config/tap/v3/common.proto
@ -21,7 +21,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/tap/v3;tapv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Common tap configuration]
+// [#protodoc-title: Tap common configuration]

 // Tap configuration.
 message TapConfig {
--- a/envoy/extensions/common/matching/v3/extension_matcher.proto
+++ b/envoy/extensions/common/matching/v3/extension_matcher.proto
@ -18,7 +18,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/common/matching/v3;matchingv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Extension Matcher]
+// [#protodoc-title: Extension matcher]

 // Wrapper around an existing extension that provides an associated matcher. This allows
 // decorating an existing extension with a matcher, which can be used to match against
--- a/envoy/extensions/filters/common/matcher/action/v3/skip_action.proto
+++ b/envoy/extensions/filters/common/matcher/action/v3/skip_action.proto
@ -10,7 +10,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/common/matcher/action/v3;actionv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Common Match Actions]
+// [#protodoc-title: Common match actions]

 // Configuration for the SkipFilter match action. When matching results in this action, the
 // associated filter will be ignored for all filter callbacks (e.g. ``encodeHeaders``, ``encodeData``,
--- a/envoy/extensions/key_value/file_based/v3/config.proto
+++ b/envoy/extensions/key_value/file_based/v3/config.proto
@ -16,7 +16,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/key_value/file_based/v3;file_basedv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: File Based Key Value Store storage plugin]
+// [#protodoc-title: Key/value file-based store storage plugin]

 // [#extension: envoy.key_value.file_based]
 // This is configuration to flush a key value store out to disk.
--- a/envoy/extensions/matching/common_inputs/environment_variable/v3/input.proto
+++ b/envoy/extensions/matching/common_inputs/environment_variable/v3/input.proto
@ -11,7 +11,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/matching/common_inputs/environment_variable/v3;environment_variablev3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Environment Variable Input]
+// [#protodoc-title: Environment variable input]
 // [#extension: envoy.matching.common_inputs.environment_variable]

 // Reads an environment variable to provide an input for matching.
--- a/envoy/extensions/matching/common_inputs/network/v3/network_inputs.proto
+++ b/envoy/extensions/matching/common_inputs/network/v3/network_inputs.proto
@ -10,7 +10,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/matching/common_inputs/network/v3;networkv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Common Network Matching Inputs]
+// [#protodoc-title: Common network matching inputs]

 // Specifies that matching should be performed by the destination IP address.
 // [#extension: envoy.matching.inputs.destination_ip]
--- a/envoy/extensions/matching/common_inputs/ssl/v3/ssl_inputs.proto
+++ b/envoy/extensions/matching/common_inputs/ssl/v3/ssl_inputs.proto
@ -10,7 +10,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/matching/common_inputs/ssl/v3;sslv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Common SSL Matching Inputs]
+// [#protodoc-title: Common SSL matching inputs]

 // List of comma-delimited URIs in the SAN field of the peer certificate for a downstream.
 // [#extension: envoy.matching.inputs.uri_san]
--- a/envoy/extensions/matching/input_matchers/consistent_hashing/v3/consistent_hashing.proto
+++ b/envoy/extensions/matching/input_matchers/consistent_hashing/v3/consistent_hashing.proto
@ -11,7 +11,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/matching/input_matchers/consistent_hashing/v3;consistent_hashingv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Consistent Hashing Matcher]
+// [#protodoc-title: Consistent hashing matcher]
 // [#extension: envoy.matching.matchers.consistent_hashing]

 // The consistent hashing matchers computes a consistent hash from the input and matches if the resulting hash
--- a/envoy/extensions/network/socket_interface/v3/default_socket_interface.proto
+++ b/envoy/extensions/network/socket_interface/v3/default_socket_interface.proto
@ -10,7 +10,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/network/socket_interface/v3;socket_interfacev3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Default Socket Interface configuration]
+// [#protodoc-title: Default socket interface configuration]

 // Configuration for default socket interface that relies on OS dependent syscall to create
 // sockets.
--- a/envoy/extensions/udp_packet_writer/v3/udp_gso_batch_writer_factory.proto
+++ b/envoy/extensions/udp_packet_writer/v3/udp_gso_batch_writer_factory.proto
@ -10,7 +10,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/udp_packet_writer/v3;udp_packet_writerv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: UDP packet writer config]
+// [#protodoc-title: UDP GSO batch packet writer config]
 // [#extension: envoy.udp_packet_writer.gso]

 // Configuration for the UDP GSO batch packet writer factory.
--- a/envoy/service/accesslog/v3/als.proto
+++ b/envoy/service/accesslog/v3/als.proto
@ -16,7 +16,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/access
 option java_generic_services = true;
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: gRPC Access Log Service (ALS)]
+// [#protodoc-title: gRPC access log service (ALS)]

 // Service for streaming access logs from Envoy to an access log server.
 service AccessLogService {
--- a/envoy/service/auth/v3/attribute_context.proto
+++ b/envoy/service/auth/v3/attribute_context.proto
@ -16,7 +16,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/auth/v3;authv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Attribute Context ]
+// [#protodoc-title: Attribute context]

 // See :ref:`network filter configuration overview <config_network_filters_ext_authz>`
 // and :ref:`HTTP filter configuration overview <config_http_filters_ext_authz>`.
--- a/envoy/service/auth/v3/external_auth.proto
+++ b/envoy/service/auth/v3/external_auth.proto
@ -20,7 +20,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/auth/v
 option java_generic_services = true;
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Authorization Service ]
+// [#protodoc-title: Authorization service]

 // The authorization service request messages used by external authorization :ref:`network filter
 // <config_network_filters_ext_authz>` and :ref:`HTTP filter <config_http_filters_ext_authz>`.
--- a/envoy/service/ext_proc/v3/external_processor.proto
+++ b/envoy/service/ext_proc/v3/external_processor.proto
@ -21,7 +21,7 @@ option java_generic_services = true;
 option (udpa.annotations.file_status).package_version_status = ACTIVE;
 option (xds.annotations.v3.file_status).work_in_progress = true;

-// [#protodoc-title: External Processing Service]
+// [#protodoc-title: External processing service]

 // A service that can access and modify HTTP requests and responses
 // as part of a filter chain.
--- a/envoy/service/extension/v3/config_discovery.proto
+++ b/envoy/service/extension/v3/config_discovery.proto
@ -16,7 +16,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/extens
 option java_generic_services = true;
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Extension Config Discovery Service (ECDS)]
+// [#protodoc-title: Extension config discovery service (ECDS)]

 // Return extension configurations.
 service ExtensionConfigDiscoveryService {
--- a/envoy/service/health/v3/hds.proto
+++ b/envoy/service/health/v3/hds.proto
@ -21,7 +21,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/health
 option java_generic_services = true;
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Health Discovery Service (HDS)]
+// [#protodoc-title: Health discovery service (HDS)]

 // HDS is Health Discovery Service. It compliments Envoy’s health checking
 // service by designating this Envoy to be a healthchecker for a subset of hosts
--- a/envoy/service/load_stats/v3/lrs.proto
+++ b/envoy/service/load_stats/v3/lrs.proto
@ -17,7 +17,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/load_s
 option java_generic_services = true;
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Load Reporting service (LRS)]
+// [#protodoc-title: Load reporting service (LRS)]

 // Load Reporting Service is an Envoy API to emit load reports. Envoy will initiate a bi-directional
 // stream with a management server. Upon connecting, the management server can send a
--- a/envoy/service/ratelimit/v3/rls.proto
+++ b/envoy/service/ratelimit/v3/rls.proto
@ -20,7 +20,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/rateli
 option java_generic_services = true;
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Rate Limit Service (RLS)]
+// [#protodoc-title: Rate limit service (RLS)]

 service RateLimitService {
  // Determine whether rate limiting should take place.
--- a/envoy/service/runtime/v3/rtds.proto
+++ b/envoy/service/runtime/v3/rtds.proto
@ -19,7 +19,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/runtim
 option java_generic_services = true;
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Runtime Discovery Service (RTDS)]
+// [#protodoc-title: Runtime discovery service (RTDS)]
 // RTDS :ref:`configuration overview <config_runtime_rtds>`

 // Discovery service for Runtime resources.
--- a/envoy/service/status/v3/csds.proto
+++ b/envoy/service/status/v3/csds.proto
@ -21,7 +21,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/status
 option java_generic_services = true;
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Client Status Discovery Service (CSDS)]
+// [#protodoc-title: Client status discovery service (CSDS)]

 // CSDS is Client Status Discovery Service. It can be used to get the status of
 // an xDS-compliant client from the management server's point of view. It can
--- a/envoy/service/tap/v3/tap.proto
+++ b/envoy/service/tap/v3/tap.proto
@ -16,7 +16,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/tap/v3
 option java_generic_services = true;
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Tap Sink Service]
+// [#protodoc-title: Tap sink service]

 // [#not-implemented-hide:] A tap service to receive incoming taps. Envoy will call
 // StreamTaps to deliver captured taps to the server
--- a/envoy/type/http/v3/cookie.proto
+++ b/envoy/type/http/v3/cookie.proto
@ -13,7 +13,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/type/http/v3;httpv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Http cookie API]
+// [#protodoc-title: HTTP cookie API]

 // Cookie defines an API for obtaining or generating HTTP cookie.
 message Cookie {
--- a/envoy/type/matcher/v3/http_inputs.proto
+++ b/envoy/type/matcher/v3/http_inputs.proto
@ -11,7 +11,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/type/matcher/v3;matcherv3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Common HTTP Inputs]
+// [#protodoc-title: Common HTTP inputs]

 // Match input indicates that matching should be done on a specific request header.
 // The resulting input string will be all headers for the given key joined by a comma,
--- a/envoy/type/v3/semantic_version.proto
+++ b/envoy/type/v3/semantic_version.proto
@ -11,7 +11,7 @@ option java_multiple_files = true;
 option go_package = "github.com/envoyproxy/go-control-plane/envoy/type/v3;typev3";
 option (udpa.annotations.file_status).package_version_status = ACTIVE;

-// [#protodoc-title: Semantic Version]
+// [#protodoc-title: Semantic version]

 // Envoy uses SemVer (https://semver.org/). Major/minor versions indicate
 // expected behaviors and APIs, the patch version field is used only