Skip to content

Commit

Permalink
Tidy up punctuation and fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
clayton-cornell committed Dec 12, 2023
1 parent 5628c25 commit e45d9cf
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/sources/flow/concepts/clustering.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Target auto-distribution is the most basic use case of clustering.
It allows scraping components running on all peers to distribute the scrape load between themselves.
Target auto-distribution requires that all {{< param "PRODUCT_ROOT_NAME" >}} in the same cluster can reach the same service discovery APIs and scrape the same targets.

You must explicitly enable target auto-distribution on components by defining a `clustering` block, such as:
You must explicitly enable target auto-distribution on components by defining a `clustering` block.

```river
prometheus.scrape "default" {
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/concepts/component_controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ A relationship between [components][Components] is created when an expression is
The set of all components and the relationships between them define a [Directed Acyclic Graph][DAG] (DAG),
which informs the component controller which references are valid and in what order components must be evaluated.

For a configuration file to be valid, components must not reference themselves or contain a cyclic reference:
For a configuration file to be valid, components must not reference themselves or contain a cyclic reference.

```river
// INVALID: local.file.some_file can not reference itself:
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/concepts/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Combining component names with a label means you can define multiple instances o

## Pipelines

Most arguments for a component in a configuration file are constant values, such as setting a `log_level` attribute to the quoted string `"debug"`:
Most arguments for a component in a configuration file are constant values, such as setting a `log_level` attribute to the quoted string `"debug"`.

```river
log_level = "debug"
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/concepts/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ module.string "my_module" {

## Example module

This example module manages a pipeline that filters out debug-level and info-level log lines:
This example module manages a pipeline that filters out debug-level and info-level log lines.

```river
// argument.write_to is a required argument that specifies where filtered
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/config-language/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ River configurations use blocks that can be easily copied and pasted from the do

A River configuration file tells {{< param "PRODUCT_NAME" >}} which components to launch and how to bind them together into a pipeline.

The syntax of River uses blocks, attributes, and expressions.
The River syntax uses blocks, attributes, and expressions.

```river
// Create a local.file component labeled my_file.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/config-language/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Components are the defining feature of {{< param "PRODUCT_NAME" >}}.
Components are small, reusable pieces of business logic that perform a single task like retrieving secrets or collecting Prometheus metrics,
and you can wire them together to form programmable pipelines of telemetry data.

The [_component controller_]controller[] is responsible for scheduling components, reporting their health and debug status, re-evaluating their arguments, and providing their exports.
The [_component controller_][controller] is responsible for scheduling components, reporting their health and debug status, re-evaluating their arguments, and providing their exports.

## Configuring components

Expand Down
19 changes: 9 additions & 10 deletions docs/sources/flow/config-language/expressions/types_and_values.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,14 @@ River handles integers, unsigned integers, and floating-point values as a single

## Strings

Strings are represented by sequences of Unicode characters surrounded by double quotes `""`:
Strings are represented by sequences of Unicode characters surrounded by double quotes `""`.

```river
"Hello, world!"
```

A `\` in a string starts an escape sequence to represent a special character.
The supported escape sequences are as follows:
The following table shows the supported escape sequences.

| Sequence | Replacement |
|--------------|-----------------------------------------------------------------------------------------|
Expand All @@ -88,7 +88,7 @@ The supported escape sequences are as follows:
## Raw strings

Raw strings are represented by sequences of Unicode characters surrounded by backticks ``` `` ```.
Raw strings don't support any escape sequences:
Raw strings don't support any escape sequences.

```river
`Hello, "world"!`
Expand All @@ -104,7 +104,7 @@ A multiline raw string is interpreted exactly as written.
"world"!`
```

The preceding multiline raw string is interpreted as a string with the following value:
The preceding multiline raw string is interpreted as a string with the following value.

```string
Hello,
Expand All @@ -117,7 +117,7 @@ Bools are represented by the symbols `true` and `false`.

## Arrays

You construct arrays with a sequence of comma-separated values surrounded by square brackets `[]`:
You construct arrays with a sequence of comma-separated values surrounded by square brackets `[]`.

```river
[0, 1, 2, 3]
Expand Down Expand Up @@ -161,12 +161,11 @@ If the key isn't a valid identifier, you must wrap it in double quotes like a st
}
```

{{% admonition type="note" %}}
{{% admonition type="Note" %}}
Don't confuse objects with blocks.

An _object_ is a value assigned to an [Attribute][]. You **must** use commas between key-value pairs on separate lines.

A [Block][] is a named structural element composed of multiple attributes. You **must not** use commas between attributes.
* An _object_ is a value assigned to an [Attribute][]. You **must** use commas between key-value pairs on separate lines.
* A [Block][] is a named structural element composed of multiple attributes. You **must not** use commas between attributes.

[Attribute]: {{< relref "../syntax.md#Attributes" >}}
[Block]: {{< relref "../syntax.md#Blocks" >}}
Expand Down Expand Up @@ -198,7 +197,7 @@ If an attribute expects a `capsule("prometheus.Receiver")`, you can only assign
The specific type of capsule expected is explicitly documented for any component that uses or exports them.

In the following example, the `prometheus.remote_write` component exports a `receiver`, which is a `capsule("prometheus.Receiver")` type.
You can use this capsule in the `forward_to` attribute of `prometheus.scrape`, which expects an array of `capsule("prometheus.Receiver")`s:
You can use this capsule in the `forward_to` attribute of `prometheus.scrape`, which expects an array of `capsule("prometheus.Receiver")`.

```river
prometheus.remote_write "default" {
Expand Down
6 changes: 4 additions & 2 deletions docs/sources/flow/config-language/syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@ Blocks have a _name_, an optional _label_ and a body that contains any number of

Some blocks support can be defined more than once.

#### Pattern for creating an unlabeled block
#### Examples

You can use the following pattern to create an unlabeled block.

```river
BLOCK_NAME {
Expand All @@ -68,7 +70,7 @@ BLOCK_NAME {
}
```

#### Pattern for creating a labeled block
You can use the following pattern to create a labeled block

```river
// Pattern for creating a labeled block:
Expand Down

0 comments on commit e45d9cf

Please sign in to comment.