chore(docs): make doc style edits (vectordotdev#17155)

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:

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,

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(

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: ""

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

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

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

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

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

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`.
 			"""

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

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

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

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

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

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

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

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

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

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

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