Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ defmodule MyBroadway do
end
```

Once your Broadway module is defined, you just need to add it as a child of your application supervision tree as `{MyBroadway, []}`.
Once your Broadway module is defined, add it as a child of your application supervision tree as `{MyBroadway, []}`.

## Comparison to Flow

Expand Down
16 changes: 8 additions & 8 deletions guides/examples/amazon-sqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ In order to use Broadway with SQS, we need to:

Amazon provides a comprehensive [Step-by-step Guide](https://aws.amazon.com/getting-started/tutorials/send-messages-distributed-applications/)
on creating SQS queues. In case you don't have an AWS account and want to
test Broadway locally, use can easily install [ElasticMQ](https://github.com/softwaremill/elasticmq),
test Broadway locally, install [ElasticMQ](https://github.com/softwaremill/elasticmq),
which is a message queue system that offers a SQS-compatible query interface.

## Configure the project
Expand Down Expand Up @@ -71,7 +71,7 @@ pipeline, we need to define three functions: `start_link/1`,
`handle_message/3` and `handle_batch/4`. We will cover `start_link/1`
in this section and the `handle_` callbacks in the next one.

Similar to other process-based behaviour, `start_link/1` simply
Similar to other process-based behaviour, `start_link/1`
delegates to `Broadway.start_link/2`, which should define the
producers, processors, and batchers in the Broadway pipeline.
Assuming we want to consume messages from a queue called
Expand Down Expand Up @@ -161,17 +161,17 @@ all messages received from the queue are just numbers:
end

We are not doing anything fancy here, but it should be enough for our
purpose. First we update the message's data individually inside
`handle_message/3` and then we print each batch inside `handle_batch/4`.
purpose. First, we update the message's data individually inside
`handle_message/3` and then print each batch inside `handle_batch/4`.

For more information, see `c:Broadway.handle_message/3` and
`c:Broadway.handle_batch/4`.

## Run the Broadway pipeline

To run your `Broadway` pipeline, you just need to add as a child in
To run your `Broadway` pipeline, add it as a child in
a supervision tree. Most applications have a supervision tree defined
at `lib/my_app/application.ex`. You can add Broadway as a child to a
at `lib/my_app/application.ex`. Add Broadway as a child to a
supervisor as follows:

children = [
Expand All @@ -187,8 +187,8 @@ in the supervision tree.

## Tuning the configuration

Some of the configuration options available for Broadway come already with a
"reasonable" default value. However those values might not suit your
Some of the configuration options available for Broadway come with a
"reasonable" default value. However, those values might not suit your
requirements. Depending on the number of messages you get, how much processing
they need and how much IO work is going to take place, you might need completely
different values to optimize the flow of your pipeline. The `concurrency` option
Expand Down
12 changes: 6 additions & 6 deletions guides/examples/apache-kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ we need to define three functions: `start_link/1`, `handle_message/3`
and optionally `handle_batch/4`. We will cover `start_link/1` in this
section and the `handle_` callbacks in the next one.

Similar to other process-based behaviours, `start_link/1` simply
Similar to other process-based behaviours, `start_link/1`
delegates to `Broadway.start_link/2`, which should define the
producers, processors, and batchers in the Broadway pipeline.
Assuming we want to consume messages from a topic called
Expand Down Expand Up @@ -152,7 +152,7 @@ all messages received from the topic are just numbers:

We are not doing anything fancy here, but it should be enough for our
purpose. First, we update the message's data individually inside
`handle_message/3` and then we print each batch inside `handle_batch/4`.
`handle_message/3` and then print each batch inside `handle_batch/4`.

For more information, see `c:Broadway.handle_message/3` and
`c:Broadway.handle_batch/4`.
Expand All @@ -163,9 +163,9 @@ For more information, see `c:Broadway.handle_message/3` and

## Run the Broadway pipeline

To run your `Broadway` pipeline, you just need to add as a child in
To run your `Broadway` pipeline, add it as a child in
a supervision tree. Most applications have a supervision tree defined
at `lib/my_app/application.ex`. You can add Broadway as a child to a
at `lib/my_app/application.ex`. Add Broadway as a child to a
supervisor as follows:

children = [
Expand Down Expand Up @@ -193,7 +193,7 @@ under the hood to communicate with Kafka.

### Sending messages to Kafka

Finally, we can send some sample messages to Kafka using using `:brod` with the following snippet:
Finally, we can send some sample messages to Kafka using `:brod` with the following snippet:

topic = "test"
client_id = :my_client
Expand Down Expand Up @@ -228,7 +228,7 @@ You should see the output showing the generated batches:

## Tuning the configuration

Some of the configuration options available for Broadway come already with a
Some of the configuration options available for Broadway come with a
"reasonable" default value. However, those values might not suit your
requirements. Depending on the number of records you get, how much processing
they need and how much IO work is going to take place, you might need completely
Expand Down
14 changes: 7 additions & 7 deletions guides/examples/google-cloud-pubsub.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Broadway is a process-based behaviour and to define a Broadway pipeline, we need
functions: `start_link/1`, `handle_message/3` and `handle_batch/4`. We will cover `start_link/1`
in this section and the `handle_` callbacks in the next one.

Similar to other process-based behaviour, `start_link/1` simply delegates to
Similar to other process-based behaviour, `start_link/1` delegates to
`Broadway.start_link/2`, which should define the producers, processors, and batchers in the
Broadway pipeline. Assuming we want to consume messages from the `test-subscription`, the minimal
configuration would be:
Expand Down Expand Up @@ -187,16 +187,16 @@ processor calls `String.upcase/1` on them:
end
end

We are not doing anything fancy here, but it should be enough for our purpose. First we update the
message's data individually inside `handle_message/3` and then we print each batch inside
We are not doing anything fancy here, but it should be enough for our purpose. First, we update the
message's data individually inside `handle_message/3` and then print each batch inside
`handle_batch/4`.

For more information, see `c:Broadway.handle_message/3` and `c:Broadway.handle_batch/4`.

## Run the Broadway pipeline

To run your `Broadway` pipeline, you need to add it as a child in a supervision tree. Most
applications have a supervision tree defined at `lib/my_app/application.ex`. You can add Broadway
To run your `Broadway` pipeline, add it as a child in a supervision tree. Most
applications have a supervision tree defined at `lib/my_app/application.ex`. Add Broadway
as a child to a supervisor as follows:

children = [
Expand Down Expand Up @@ -239,8 +239,8 @@ Got batch of finished jobs from processors, sending ACKs to Pub/Sub as a batch.:

## Tuning the configuration

Some of the configuration options available for Broadway come already with a
"reasonable" default value. However those values might not suit your
Some of the configuration options available for Broadway come with a
"reasonable" default value. However, those values might not suit your
requirements. Depending on the number of messages you get, how much processing
they need and how much IO work is going to take place, you might need completely
different values to optimize the flow of your pipeline. The `concurrency` option
Expand Down
10 changes: 5 additions & 5 deletions guides/examples/rabbitmq.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ we need to define three functions: `start_link/1`, `handle_message/3`
and optionally `handle_batch/4`. We will cover `start_link/1` in this
section and the `handle_` callbacks in the next one.

Similar to other process-based behaviours, `start_link/1` simply
Similar to other process-based behaviours, `start_link/1`
delegates to `Broadway.start_link/2`, which should define the
producers, processors, and batchers in the Broadway pipeline.
Assuming we want to consume messages from a queue called
Expand Down Expand Up @@ -168,7 +168,7 @@ all messages received from the queue are just numbers:

We are not doing anything fancy here, but it should be enough for our
purpose. First, we update the message's data individually inside
`handle_message/3` and then we print each batch inside `handle_batch/4`.
`handle_message/3` and then print each batch inside `handle_batch/4`.

For more information, see `c:Broadway.handle_message/3` and
`c:Broadway.handle_batch/4`.
Expand All @@ -181,9 +181,9 @@ For more information, see `c:Broadway.handle_message/3` and

## Run the Broadway pipeline

To run your `Broadway` pipeline, you just need to add as a child in
To run your `Broadway` pipeline, add it as a child in
a supervision tree. Most applications have a supervision tree defined
at `lib/my_app/application.ex`. You can add Broadway as a child to a
at `lib/my_app/application.ex`. Add Broadway as a child to a
supervisor as follows:

children = [
Expand Down Expand Up @@ -241,7 +241,7 @@ You should see the output showing the generated batches:

## Tuning the configuration

Some of the configuration options available for Broadway come already with a
Some of the configuration options available for Broadway come with a
"reasonable" default value. However, those values might not suit your
requirements. Depending on the number of messages you get, how much processing
they need and how much IO work is going to take place, you might need completely
Expand Down