Skip to content

docs: fixes to create valid RST #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattklein123 merged 2 commits into from
Mar 14, 2022
Merged

docs: fixes to create valid RST #32

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
578bdf3
docs: fixes to create valid RST
kyessenov Mar 9, 2022
2d7d779
code block
kyessenov Mar 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions xds/core/v3/collection_entry.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,17 @@ option (xds.annotations.v3.file_status).work_in_progress = true;
// appearing inside a list collection resource. List collection resources are
// regular Resource messages of type:
//
// ```
// message <T>Collection {
// repeated CollectionEntry resources = 1;
// }
// ```
//
message CollectionEntry {
// Inlined resource entry.
message InlineEntry {
// Optional name to describe the inlined resource. Resource names must
// [a-zA-Z0-9_-\./]+ (TODO(htuch): turn this into a PGV constraint once
// Optional name to describe the inlined resource. Resource names must match
// `[a-zA-Z0-9_-\./]+` (TODO(htuch): turn this into a PGV constraint once

@phlax phlax Mar 9, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use double backticks `` for literals in RST - the default with a single backtick is to italicize

// finalized, probably should be a RFC3986 pchar). This name allows
// reference via the #entry directive in ResourceLocator.
string name = 1 [(validate.rules).string.pattern = "^[0-9a-zA-Z_\\-\\.~:]+$"];
Expand Down
1 change: 1 addition & 0 deletions xds/core/v3/context_params.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ option (xds.annotations.v3.file_status).work_in_progress = true;
// global context parameters, per-resource type client feature capabilities and per-resource
// type functional attributes. All per-resource type attributes will be `xds.resource.`
// prefixed and some of these are documented below:
//
// `xds.resource.listening_address`: The value is "IP:port" (e.g. "10.1.1.3:8080") which is
// the listening address of a Listener. Used in a Listener resource query.
message ContextParams {
Expand Down
2 changes: 2 additions & 0 deletions xds/type/v3/typed_struct.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import "google/protobuf/struct.proto";
// When packing an opaque extension config, packing the expected type into Any is preferred
// wherever possible for its efficiency. TypedStruct should be used only if a proto descriptor
// is not available, for example if:
//
// - A control plane sends opaque message that is originally from external source in human readable
// format such as JSON or YAML.
// - The control plane doesn't have the knowledge of the protocol buffer schema hence it cannot
Expand All @@ -29,6 +30,7 @@ import "google/protobuf/struct.proto";
// When a DPLB receives a TypedStruct in Any, it should:
// - Check if the type_url of the TypedStruct matches the type the extension expects.
// - Convert value to the type described in type_url and perform validation.
//
// TODO(lizan): Figure out how TypeStruct should be used with DPLB extensions that doesn't link
// protobuf descriptor with DPLB itself, (e.g. gRPC LB Plugin, Envoy WASM extensions).
message TypedStruct {
Expand Down