From 65a8856ab08296bf6da22f7dbf3b9a6da64aff6a Mon Sep 17 00:00:00 2001 From: May Lee Date: Fri, 14 Apr 2023 17:04:27 -0400 Subject: [PATCH] chore(docs): make doc style edits (#17155) --- lib/codecs/src/decoding/mod.rs | 4 ++-- src/sinks/webhdfs/config.rs | 6 +++--- src/sources/docker_logs/mod.rs | 4 ++-- website/cue/reference/components/sinks/base/webhdfs.cue | 6 +++--- website/cue/reference/components/sources/base/amqp.cue | 4 ++-- .../components/sources/base/aws_kinesis_firehose.cue | 4 ++-- website/cue/reference/components/sources/base/aws_sqs.cue | 4 ++-- .../cue/reference/components/sources/base/datadog_agent.cue | 4 ++-- website/cue/reference/components/sources/base/demo_logs.cue | 4 ++-- .../cue/reference/components/sources/base/docker_logs.cue | 4 ++-- website/cue/reference/components/sources/base/exec.cue | 4 ++-- .../reference/components/sources/base/file_descriptor.cue | 4 ++-- .../cue/reference/components/sources/base/gcp_pubsub.cue | 4 ++-- .../cue/reference/components/sources/base/heroku_logs.cue | 4 ++-- website/cue/reference/components/sources/base/http.cue | 4 ++-- .../cue/reference/components/sources/base/http_server.cue | 4 ++-- website/cue/reference/components/sources/base/kafka.cue | 4 ++-- website/cue/reference/components/sources/base/nats.cue | 4 ++-- website/cue/reference/components/sources/base/redis.cue | 4 ++-- website/cue/reference/components/sources/base/socket.cue | 4 ++-- website/cue/reference/components/sources/base/stdin.cue | 4 ++-- 21 files changed, 44 insertions(+), 44 deletions(-) diff --git a/lib/codecs/src/decoding/mod.rs b/lib/codecs/src/decoding/mod.rs index 235c031858754..6501c5e3ceb6d 100644 --- a/lib/codecs/src/decoding/mod.rs +++ b/lib/codecs/src/decoding/mod.rs @@ -69,8 +69,8 @@ impl StreamDecodingError for Error { /// Framing configuration. /// -/// Framing deals with how events are separated when encoded in a raw byte form, where each event is -/// a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and +/// Framing handles how events are separated when encoded in a raw byte form, where each event is +/// a frame that must be prefixed, or delimited, in a way that marks where an event begins and /// ends within the byte stream. // Unfortunately, copying options of the nested enum variants is necessary // since `serde` doesn't allow `flatten`ing these: diff --git a/src/sinks/webhdfs/config.rs b/src/sinks/webhdfs/config.rs index c961672dcd549..86518a8692f64 100644 --- a/src/sinks/webhdfs/config.rs +++ b/src/sinks/webhdfs/config.rs @@ -29,7 +29,7 @@ pub struct WebHdfsConfig { /// /// Must be a valid directory. /// - /// The final file path with be like `{root}/{prefix}{suffix}`. + /// The final file path is in the format of `{root}/{prefix}{suffix}`. #[serde(default)] pub root: String, @@ -39,7 +39,7 @@ pub struct WebHdfsConfig { /// stores blobs under a particular directory. If using a prefix for this purpose, it must end /// in `/` to act as a directory path. A trailing `/` is **not** automatically added. /// - /// The final file path with be like `{root}/{prefix}{suffix}`. + /// The final file path is in the format of `{root}/{prefix}{suffix}`. #[serde(default)] #[configurable(metadata(docs::templateable))] pub prefix: String, @@ -50,7 +50,7 @@ pub struct WebHdfsConfig { /// /// For more information, see the [HDFS Architecture][hdfs_arch] documentation. /// - /// [hdfs_arch]: https://hadoop.apache.org/docs/r3.3.4/hadoop-project-dist/hadoop-hdfs/WebHdfsDesign.html#NameNode_and_DataNodes + /// [hdfs_arch]: https://hadoop.apache.org/docs/r3.3.4/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html#NameNode_and_DataNodes #[serde(default)] #[configurable(metadata(docs::examples = "http://127.0.0.1:9870"))] pub endpoint: String, diff --git a/src/sources/docker_logs/mod.rs b/src/sources/docker_logs/mod.rs index 62abfc1ef52ff..2f7bca9ec7ed7 100644 --- a/src/sources/docker_logs/mod.rs +++ b/src/sources/docker_logs/mod.rs @@ -112,8 +112,8 @@ pub struct DockerLogsConfig { /// Matching is prefix first, so specifying a value of `foo` would match any container named `foo` as well as any /// container whose name started with `foo`. This applies equally whether matching container IDs or names. /// - /// By default, the source will collect logs for all containers. If `include_containers` is configured, only - /// containers that match a configured inclusion and are also not excluded will be matched. + /// By default, the source collects logs for all containers. If `include_containers` is configured, only + /// containers that match a configured inclusion and are also not excluded get matched. /// /// This can be used in conjunction with `exclude_containers`. #[configurable(metadata( diff --git a/website/cue/reference/components/sinks/base/webhdfs.cue b/website/cue/reference/components/sinks/base/webhdfs.cue index 00c70795605cd..006b33156564b 100644 --- a/website/cue/reference/components/sinks/base/webhdfs.cue +++ b/website/cue/reference/components/sinks/base/webhdfs.cue @@ -230,7 +230,7 @@ base: components: sinks: webhdfs: configuration: { For more information, see the [HDFS Architecture][hdfs_arch] documentation. - [hdfs_arch]: https://hadoop.apache.org/docs/r3.3.4/hadoop-project-dist/hadoop-hdfs/WebHdfsDesign.html#NameNode_and_DataNodes + [hdfs_arch]: https://hadoop.apache.org/docs/r3.3.4/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html#NameNode_and_DataNodes """ required: false type: string: { @@ -276,7 +276,7 @@ base: components: sinks: webhdfs: configuration: { stores blobs under a particular directory. If using a prefix for this purpose, it must end in `/` to act as a directory path. A trailing `/` is **not** automatically added. - The final file path with be like `{root}/{prefix}{suffix}`. + The final file path is in the format of `{root}/{prefix}{suffix}`. """ required: false type: string: { @@ -290,7 +290,7 @@ base: components: sinks: webhdfs: configuration: { Must be a valid directory. - The final file path with be like `{root}/{prefix}{suffix}`. + The final file path is in the format of `{root}/{prefix}{suffix}`. """ required: false type: string: default: "" diff --git a/website/cue/reference/components/sources/base/amqp.cue b/website/cue/reference/components/sources/base/amqp.cue index 97881e90402e4..bf487fc82b63c 100644 --- a/website/cue/reference/components/sources/base/amqp.cue +++ b/website/cue/reference/components/sources/base/amqp.cue @@ -104,8 +104,8 @@ base: components: sources: amqp: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/aws_kinesis_firehose.cue b/website/cue/reference/components/sources/base/aws_kinesis_firehose.cue index 1c5bf1bc39fcd..033c1c7675cc9 100644 --- a/website/cue/reference/components/sources/base/aws_kinesis_firehose.cue +++ b/website/cue/reference/components/sources/base/aws_kinesis_firehose.cue @@ -102,8 +102,8 @@ base: components: sources: aws_kinesis_firehose: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/aws_sqs.cue b/website/cue/reference/components/sources/base/aws_sqs.cue index 39b43fb8b3d84..52cd9c2e42729 100644 --- a/website/cue/reference/components/sources/base/aws_sqs.cue +++ b/website/cue/reference/components/sources/base/aws_sqs.cue @@ -197,8 +197,8 @@ base: components: sources: aws_sqs: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/datadog_agent.cue b/website/cue/reference/components/sources/base/datadog_agent.cue index ee9361e724ade..33d7ee2302186 100644 --- a/website/cue/reference/components/sources/base/datadog_agent.cue +++ b/website/cue/reference/components/sources/base/datadog_agent.cue @@ -99,8 +99,8 @@ base: components: sources: datadog_agent: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/demo_logs.cue b/website/cue/reference/components/sources/base/demo_logs.cue index a1c1387b43d08..534afb0a437de 100644 --- a/website/cue/reference/components/sources/base/demo_logs.cue +++ b/website/cue/reference/components/sources/base/demo_logs.cue @@ -95,8 +95,8 @@ base: components: sources: demo_logs: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/docker_logs.cue b/website/cue/reference/components/sources/base/docker_logs.cue index 266c94488c56b..03fa12b84a94b 100644 --- a/website/cue/reference/components/sources/base/docker_logs.cue +++ b/website/cue/reference/components/sources/base/docker_logs.cue @@ -54,8 +54,8 @@ base: components: sources: docker_logs: configuration: { Matching is prefix first, so specifying a value of `foo` would match any container named `foo` as well as any container whose name started with `foo`. This applies equally whether matching container IDs or names. - By default, the source will collect logs for all containers. If `include_containers` is configured, only - containers that match a configured inclusion and are also not excluded will be matched. + By default, the source collects logs for all containers. If `include_containers` is configured, only + containers that match a configured inclusion and are also not excluded get matched. This can be used in conjunction with `exclude_containers`. """ diff --git a/website/cue/reference/components/sources/base/exec.cue b/website/cue/reference/components/sources/base/exec.cue index 0377648513047..d9d1745d5c649 100644 --- a/website/cue/reference/components/sources/base/exec.cue +++ b/website/cue/reference/components/sources/base/exec.cue @@ -59,8 +59,8 @@ base: components: sources: exec: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/file_descriptor.cue b/website/cue/reference/components/sources/base/file_descriptor.cue index 7c036f0f77a1b..3d0be84a25207 100644 --- a/website/cue/reference/components/sources/base/file_descriptor.cue +++ b/website/cue/reference/components/sources/base/file_descriptor.cue @@ -61,8 +61,8 @@ base: components: sources: file_descriptor: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/gcp_pubsub.cue b/website/cue/reference/components/sources/base/gcp_pubsub.cue index 40f4b762df444..afd10831e91a7 100644 --- a/website/cue/reference/components/sources/base/gcp_pubsub.cue +++ b/website/cue/reference/components/sources/base/gcp_pubsub.cue @@ -138,8 +138,8 @@ base: components: sources: gcp_pubsub: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/heroku_logs.cue b/website/cue/reference/components/sources/base/heroku_logs.cue index 259f0c3a9dc47..3bb613492ab97 100644 --- a/website/cue/reference/components/sources/base/heroku_logs.cue +++ b/website/cue/reference/components/sources/base/heroku_logs.cue @@ -96,8 +96,8 @@ base: components: sources: heroku_logs: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/http.cue b/website/cue/reference/components/sources/base/http.cue index 014a7b4dd82dd..e562985c48955 100644 --- a/website/cue/reference/components/sources/base/http.cue +++ b/website/cue/reference/components/sources/base/http.cue @@ -111,8 +111,8 @@ base: components: sources: http: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/http_server.cue b/website/cue/reference/components/sources/base/http_server.cue index d7dff32b7310c..e7e66b4845c7c 100644 --- a/website/cue/reference/components/sources/base/http_server.cue +++ b/website/cue/reference/components/sources/base/http_server.cue @@ -111,8 +111,8 @@ base: components: sources: http_server: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/kafka.cue b/website/cue/reference/components/sources/base/kafka.cue index 50f8741d00e87..1c03c2e568393 100644 --- a/website/cue/reference/components/sources/base/kafka.cue +++ b/website/cue/reference/components/sources/base/kafka.cue @@ -117,8 +117,8 @@ base: components: sources: kafka: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/nats.cue b/website/cue/reference/components/sources/base/nats.cue index 67a29bf864669..ca42dfb333f28 100644 --- a/website/cue/reference/components/sources/base/nats.cue +++ b/website/cue/reference/components/sources/base/nats.cue @@ -151,8 +151,8 @@ base: components: sources: nats: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/redis.cue b/website/cue/reference/components/sources/base/redis.cue index 0ad3e417b7265..03cf03f45ef65 100644 --- a/website/cue/reference/components/sources/base/redis.cue +++ b/website/cue/reference/components/sources/base/redis.cue @@ -69,8 +69,8 @@ base: components: sources: redis: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/socket.cue b/website/cue/reference/components/sources/base/socket.cue index 3a634097e7f1b..ff4764d8d3837 100644 --- a/website/cue/reference/components/sources/base/socket.cue +++ b/website/cue/reference/components/sources/base/socket.cue @@ -71,8 +71,8 @@ base: components: sources: socket: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false diff --git a/website/cue/reference/components/sources/base/stdin.cue b/website/cue/reference/components/sources/base/stdin.cue index 3f30c023251f3..4e5d9aef77028 100644 --- a/website/cue/reference/components/sources/base/stdin.cue +++ b/website/cue/reference/components/sources/base/stdin.cue @@ -54,8 +54,8 @@ base: components: sources: stdin: configuration: { description: """ Framing configuration. - Framing deals with how events are separated when encoded in a raw byte form, where each event is - a "frame" that must be prefixed, or delimited, in a way that marks where an event begins and + Framing handles how events are separated when encoded in a raw byte form, where each event is + a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream. """ required: false