Skip to content

Commit

Permalink
Fix a bunch of documentation typos
Browse files Browse the repository at this point in the history
  • Loading branch information
mihaitodor committed Mar 10, 2022
1 parent 95a9ebd commit bfd5aac
Show file tree
Hide file tree
Showing 29 changed files with 114 additions and 85 deletions.
8 changes: 5 additions & 3 deletions internal/batch/policy/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,20 +50,22 @@ Allows you to configure a [batching policy](/docs/configuration/batching).`,
[]map[string]interface{}{
{
"archive": map[string]interface{}{
"format": "lines",
"format": "concatenate",
},
},
},
[]map[string]interface{}{
{
"archive": map[string]interface{}{
"format": "json_array",
"format": "lines",
},
},
},
[]map[string]interface{}{
{
"merge_json": struct{}{},
"archive": map[string]interface{}{
"format": "json_array",
},
},
},
).Array().HasType(docs.FieldTypeProcessor).Optional(),
Expand Down
2 changes: 1 addition & 1 deletion internal/old/output/pulsar.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ package output

import "github.com/benthosdev/benthos/v4/internal/impl/pulsar/auth"

// PulsarConfig contains configuration for the Pulsar input type.
// PulsarConfig contains configuration for the Pulsar output type.
type PulsarConfig struct {
URL string `json:"url" yaml:"url"`
Topic string `json:"topic" yaml:"topic"`
Expand Down
7 changes: 4 additions & 3 deletions website/docs/components/buffers/memory.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,15 @@ Type: `array`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```


7 changes: 4 additions & 3 deletions website/docs/components/inputs/aws_kinesis.md
Original file line number Diff line number Diff line change
Expand Up @@ -354,14 +354,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```


7 changes: 4 additions & 3 deletions website/docs/components/inputs/broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,14 +213,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```


7 changes: 4 additions & 3 deletions website/docs/components/inputs/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -572,14 +572,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```


7 changes: 4 additions & 3 deletions website/docs/components/outputs/aws_dynamodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,14 +295,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```

### `region`
Expand Down
7 changes: 4 additions & 3 deletions website/docs/components/outputs/aws_kinesis.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,14 +224,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```

### `region`
Expand Down
7 changes: 4 additions & 3 deletions website/docs/components/outputs/aws_kinesis_firehose.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,14 +198,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```

### `region`
Expand Down
7 changes: 4 additions & 3 deletions website/docs/components/outputs/aws_s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -422,14 +422,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```

### `region`
Expand Down
7 changes: 4 additions & 3 deletions website/docs/components/outputs/aws_sqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,14 +249,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```

### `region`
Expand Down
7 changes: 4 additions & 3 deletions website/docs/components/outputs/azure_queue_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,14 +236,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```


7 changes: 4 additions & 3 deletions website/docs/components/outputs/azure_table_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,14 +320,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```


7 changes: 4 additions & 3 deletions website/docs/components/outputs/broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,14 +204,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```

## Patterns
Expand Down
7 changes: 4 additions & 3 deletions website/docs/components/outputs/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -484,14 +484,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```


7 changes: 4 additions & 3 deletions website/docs/components/outputs/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -486,14 +486,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```

### `aws`
Expand Down
7 changes: 4 additions & 3 deletions website/docs/components/outputs/gcp_bigquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -355,14 +355,15 @@ Type: `array`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```


7 changes: 4 additions & 3 deletions website/docs/components/outputs/gcp_cloud_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,14 +305,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```


7 changes: 4 additions & 3 deletions website/docs/components/outputs/hdfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,14 +218,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```


7 changes: 4 additions & 3 deletions website/docs/components/outputs/http_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -755,14 +755,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```

### `multipart`
Expand Down
7 changes: 4 additions & 3 deletions website/docs/components/outputs/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -594,14 +594,15 @@ Default: `[]`
processors:
- archive:
format: lines
format: concatenate
processors:
- archive:
format: json_array
format: lines
processors:
- merge_json: {}
- archive:
format: json_array
```

### `max_retries`
Expand Down
Loading

0 comments on commit bfd5aac

Please sign in to comment.