Skip to content

chore(docs): make doc style edits #17155

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
spencergilbert merged 2 commits into from
Apr 14, 2023
Merged

chore(docs): make doc style edits #17155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e50e1a1
small doc edits
maycmlee Apr 14, 2023
81a64b1
+gen docs
Apr 14, 2023
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
4 changes: 2 additions & 2 deletions lib/codecs/src/decoding/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions src/sinks/webhdfs/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,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,

Expand All @@ -71,7 +71,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,
Expand All @@ -82,7 +82,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,
Expand Down
4 changes: 2 additions & 2 deletions src/sources/docker_logs/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
6 changes: 3 additions & 3 deletions website/cue/reference/components/sinks/base/webhdfs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down Expand Up @@ -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: {
Expand All @@ -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: ""
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/amqp.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/aws_kinesis_firehose.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/aws_sqs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/datadog_agent.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/demo_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/docker_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
"""
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/exec.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/file_descriptor.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/gcp_pubsub.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/heroku_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/http.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/http_server.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/kafka.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/nats.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/redis.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/socket.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/cue/reference/components/sources/base/stdin.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down